# Boerse Stuttgart — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search Börse Stuttgart securities by name, WKN, or ISIN and retrieve live quotes, detailed instrument pages, index snapshots with constituents, and warrant (Optionsschein) listings for a chosen underlying.

**Category:** Finance & Markets | **Website:** [boerse-stuttgart.de/](https://boerse-stuttgart.de/) | **Docs:** [parse.bot/marketplace/ac160cfc-9a24-4b87-a971-a8b6d23a1ab7/boerse-stuttgart-de-api](https://parse.bot/marketplace/ac160cfc-9a24-4b87-a971-a8b6d23a1ab7/boerse-stuttgart-de-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-boerse-stuttgart-de-api-ac160cfc/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_index_data

Get comprehensive data for a stock index including current value, all constituent stocks with their intraday prices and performance, master data, and historical performance statistics. Defaults to DAX.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `index_slug` | string | No | Index slug in format 'wkn-name' (e.g., '846900-dax', '846741-mdax') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boerse-stuttgart-de-api-ac160cfc/get_index_data \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"index_slug":"<string>"}'
```

### get_optionsscheine

Search for Optionsscheine (warrants) by underlying asset name. Returns warrants with prices, strike prices, and option types. Optionally fetches detailed data (emittent, maturity, master data) for the first 5 results when include_details is true (slower).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `include_details` | string | No | Set to 'true' to fetch detailed data for each warrant (ISIN, emittent, maturity). Slower but more comprehensive. |
| `limit` | integer | No | Maximum number of warrants to return |
| `option_type` | string | No | Filter by option type: 'call', 'put', or empty string for all |
| `underlying` | string | No | Name of the underlying asset (e.g., 'SAP SE', 'Siemens AG', 'DAX') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boerse-stuttgart-de-api-ac160cfc/get_optionsscheine \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"include_details":"<string>","limit":"<integer>","option_type":"<string>","underlying":"<string>"}'
```

### get_security_details

Get detailed information for any security available on Börse Stuttgart. Supports lookup by ISIN, WKN, or direct product URL path. Returns the same comprehensive data blocks as get_stock_quote (quote, price data, master data, key figures, performance, company profile). At least one of product_path, isin, or wkn must be provided.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `isin` | string | No | ISIN identifier (e.g., 'DE0007164600') |
| `product_path` | string | No | Direct product URL path (e.g., '/de-de/produkte/aktien/stuttgart/716460-sap') |
| `wkn` | string | No | WKN identifier (e.g., '716460') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boerse-stuttgart-de-api-ac160cfc/get_security_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"isin":"<string>","product_path":"<string>","wkn":"<string>"}'
```

### get_stock_quote

Get real-time stock quote with comprehensive market statistics including current price, bid/ask, daily high/low, 52-week range, volume, key figures (P/E, dividend yield, EPS), performance history, and company profile. At least one of isin or wkn must be provided. Returns the full security detail page data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `isin` | string | No | ISIN identifier (e.g., 'DE0007164600' for SAP SE) |
| `wkn` | string | No | WKN identifier (e.g., '716460' for SAP SE) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boerse-stuttgart-de-api-ac160cfc/get_stock_quote \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"isin":"<string>","wkn":"<string>"}'
```

### search_products

Full-text search across all product categories on Börse Stuttgart (stocks, bonds, ETFs, warrants, knock-outs, index certificates, funds). Returns up to `limit` results per category with real-time prices. Name-based and WKN-based searches return results reliably; ISIN-based searches may return empty results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum results per category |
| `query` | string | Yes | Search term — company name or WKN (e.g., 'SAP', 'Siemens', '716460') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boerse-stuttgart-de-api-ac160cfc/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","query":"<string>"}'
```