# Onvista — 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.

> Access live derivatives, indices, and market data from onvista.de to search financial instruments, retrieve knockout product details, and monitor market overviews. Build financial applications that pull real-time pricing and instrument information for trading and investment analysis.

**Category:** Finance & Markets | **Website:** [onvista.de/](https://onvista.de/) | **Docs:** [parse.bot/marketplace/6265a960-7a13-46df-bd8b-3d93c8f254b8/onvista-de-api](https://parse.bot/marketplace/6265a960-7a13-46df-bd8b-3d93c8f254b8/onvista-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-onvista-de-api-6265a960/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_knockout_detail

Get full snapshot details for a specific derivative instrument including quote, instrument metadata, derivatives details, figures, and underlying information. The entity_value parameter is the instrument ID obtained from get_knockout_list results or search_instruments results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `entity_value` | string | Yes | Instrument ID (entityValue from get_knockout_list results[*].id_instrument or search_instruments results[*].entity_value). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-onvista-de-api-6265a960/get_knockout_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entity_value":"<string>"}'
```

### get_knockout_list

Get paginated list of Knock-Out certificates with sorting and filtering options. Returns certificates matching the given criteria sorted by the specified field. Pagination is zero-based. When filtering by underlying, both underlying_type and underlying_value must be provided together.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `id_issuer` | string | No | Filter by issuer ID (e.g. 53881 for BNP Paribas). |
| `ko_schwelle_max` | number | No | Maximum K.O.-Schwelle value filter. |
| `ko_schwelle_min` | number | No | Minimum K.O.-Schwelle value filter. |
| `order` | string | No | Sort direction. |
| `page` | integer | No | Page number (zero-based). |
| `per_page` | integer | No | Results per page. |
| `sort` | string | No | Field to sort by. |
| `type` | string | No | Direction filter. |
| `underlying_type` | string | No | Underlying instrument entity type. Must be used together with underlying_value. |
| `underlying_value` | string | No | Underlying instrument ID (e.g. 20735 for DAX, 11288971 for Alphabet A). Must be used together with underlying_type. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-onvista-de-api-6265a960/get_knockout_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id_issuer":"<string>","ko_schwelle_max":"<number>","ko_schwelle_min":"<number>","order":"<string>","page":"<integer>","per_page":"<integer>","sort":"<string>","type":"<string>","underlying_type":"<string>","underlying_value":"<string>"}'
```

### get_market_overview

Get market overview of major indices and assets from the onvista.de homepage. Returns current prices and daily performance for key market instruments including DAX, Dow Jones, Nikkei, Gold, EUR/USD, Brent Oil, and Bitcoin.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-onvista-de-api-6265a960/get_market_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_instruments

Search for instruments by name, WKN, or ISIN. Returns matching instruments across all asset types (stocks, indices, ETFs, futures, derivatives). Results are not paginated; use the limit parameter to control the number of results returned.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of search results to return. |
| `query` | string | Yes | Search keyword (name, WKN, or ISIN). |

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