Dokumentation → Referenzdaten

Dokumentation

Referenzdaten

Identifier-Auflösung, Stammdaten, Börsen und Indizes. /tickers/resolve/{identifier} ist der Einstieg, wenn Sie nicht wissen, welche Art von Identifier vorliegt.

Wozu das gut ist, steht auf der Produktseite: Referenzdaten

GET/exchangesPOST/exchanges/constituents/syncPOST/exchanges/syncGET/exchanges/{entity_value}GET/exchanges/{exchange_ref}/constituentsPOST/exchanges/{exchange_ref}/constituents/syncGET/onvista/common/branchesGET/onvista/common/countriesGET/onvista/common/currenciesGET/onvista/common/instrument_typesGET/onvista/common/sectorsPOST/onvista/common/syncPOST/onvista/common/{category}/syncGET/tickersPOST/tickers/backfill-cikGET/tickers/by-keyword/{keyword_id}POST/tickers/enrich/isinGET/tickers/enrich/isin/preview/{ticker_symbol}POST/tickers/enrich/onvista-stockPOST/tickers/enrich/onvista-stock/staleGET/tickers/jobsGET/tickers/jobs/{job_id}GET/tickers/keywordsPOST/tickers/quality/scoreGET/tickers/quality/statsGET/tickers/resolve/{identifier}POST/tickers/syncPOST/tickers/sync/earnings-calendarGET/tickers/{ticker_symbol}GET/wiki/jobsGET/wiki/jobs/{job_id}POST/wiki/jobs/{job_id}/cancelPOST/wiki/sync/onvista-stock-csv

GET /exchanges

List Exchanges

Liefert die in MongoDB abgelegten Boersen- und Indexeintraege.

Name	Typ	Bedeutung
`search`	string, in der Abfrage optional	Filter by name (regex)
`display_type`	string, in der Abfrage optional	—
`limit`	integer, in der Abfrage optional · Vorgabe `100`	—
`offset`	integer, in der Abfrage optional · Vorgabe `0`	—

Beispiel

curl "$API/exchanges" \
  -H "X-API-Key: $KEY"

POST /exchanges/constituents/sync

Sync All Exchange Constituents

Holt die Bestandteile aller gespeicherten Boersen und fuehrt sie in ticker_reference zusammen.

Name	Typ	Bedeutung
`search`	string, in der Abfrage optional	Only sync matching exchanges
`limit`	integer, in der Abfrage optional · Vorgabe `250`	Max number of exchanges to process
`rate_limit`	integer, in der Abfrage optional · Vorgabe `120`	Max onvista requests per minute

Beispiel

curl -X POST "$API/exchanges/constituents/sync" \
  -H "X-API-Key: $KEY"

POST /exchanges/sync

Sync Exchanges

Holt saemtliche Weltindizes von onvista und legt sie in MongoDB ab beziehungsweise ueberschreibt sie.

Mehrfache Aufrufe sind unbedenklich — spaetere Laeufe aktualisieren die vorhandenen Dokumente.

Name	Typ	Bedeutung
`concurrency`	integer, in der Abfrage optional · Vorgabe `10`	Parallel OnVista requests
`rate_limit`	integer, in der Abfrage optional · Vorgabe `60`	Max requests per minute

Beispiel

curl -X POST "$API/exchanges/sync" \
  -H "X-API-Key: $KEY"

GET /exchanges/{entity_value}

Get Exchange

Liefert eine einzelne Boerse ueber entityValue, Name, url_name oder Suchbegriff.

Name	Typ	Bedeutung
`entity_value`	string, im Pfad Pflicht	—

Beispiel

curl "$API/exchanges/SAP" \
  -H "X-API-Key: $KEY"

GET /exchanges/{exchange_ref}/constituents

List Exchange Constituent Stocks

Liefert die Aktien einer Boerse beziehungsweise eines Index aus ticker_reference. Ist der Bestand leer, holt der Endpunkt diese eine Boerse einmalig selbst nach.

Name	Typ	Bedeutung
`exchange_ref`	string, im Pfad Pflicht	—
`search`	string, in der Abfrage optional	Filter cached constituents by ticker/name
`limit`	integer, in der Abfrage optional · Vorgabe `100`	—
`offset`	integer, in der Abfrage optional · Vorgabe `0`	—
`refresh`	boolean, in der Abfrage optional · Vorgabe `False`	Refresh from onvista before reading from MongoDB

Beispiel

curl "$API/exchanges/SAP/constituents" \
  -H "X-API-Key: $KEY"

POST /exchanges/{exchange_ref}/constituents/sync

Sync Exchange Constituents

Holt die Bestandteile einer Boerse beziehungsweise eines Index und fuehrt sie in ticker_reference zusammen.

Name	Typ	Bedeutung
`exchange_ref`	string, im Pfad Pflicht	—

Beispiel

curl -X POST "$API/exchanges/SAP/constituents/sync" \
  -H "X-API-Key: $KEY"

GET /onvista/common/branches

Get Branches

Liefert die gespeicherte Branchenliste; beim ersten Aufruf wird sie automatisch geholt.

Keine Parameter.

Beispiel

curl "$API/onvista/common/branches" \
  -H "X-API-Key: $KEY"

GET /onvista/common/countries

Get Countries

Liefert die gespeicherte Laenderliste; beim ersten Aufruf wird sie automatisch geholt.

Keine Parameter.

Beispiel

curl "$API/onvista/common/countries" \
  -H "X-API-Key: $KEY"

GET /onvista/common/currencies

Get Currencies

Liefert die gespeicherte Waehrungsliste (official=true); beim ersten Aufruf wird sie automatisch geholt.

Keine Parameter.

Beispiel

curl "$API/onvista/common/currencies" \
  -H "X-API-Key: $KEY"

GET /onvista/common/instrument_types

Get Instrument Types

Liefert die gespeicherte Liste der Instrumententypen; beim ersten Aufruf wird sie automatisch geholt.

Keine Parameter.

Beispiel

curl "$API/onvista/common/instrument_types" \
  -H "X-API-Key: $KEY"

GET /onvista/common/sectors

Get Sectors

Liefert die gespeicherte Sektorenliste; beim ersten Aufruf wird sie automatisch geholt.

Keine Parameter.

Beispiel

curl "$API/onvista/common/sectors" \
  -H "X-API-Key: $KEY"

POST /onvista/common/sync

Sync All

Erneuert alle fuenf Referenzkategorien von onvista.

Keine Parameter.

Beispiel

curl -X POST "$API/onvista/common/sync" \
  -H "X-API-Key: $KEY"

POST /onvista/common/{category}/sync

Sync Category

Erneuert eine einzelne Referenzkategorie von onvista.

Name	Typ	Bedeutung
`category`	string, im Pfad Pflicht	—

Beispiel

curl -X POST "$API/onvista/common/SAP/sync" \
  -H "X-API-Key: $KEY"

GET /tickers

List Tickers

Return ticker reference entries stored in MongoDB.

Ergebnisse sind sortiert nach `ranking` aufsteigend (kleinerer Rang zuerst; Ticker ohne Ranking ans Ende), danach alphabetisch nach Name/Ticker. Die Suche greift auf Ticker, Name und ISIN zu.

Name	Typ	Bedeutung
`market`	string, in der Abfrage optional	—
`active`	boolean, in der Abfrage optional	—
`type`	string, in der Abfrage optional	—
`search`	string, in der Abfrage optional	—
`ranking_min`	integer, in der Abfrage optional	Nur Ticker mit ranking >= diesem Wert
`ranking_max`	integer, in der Abfrage optional	Nur Ticker mit ranking <= diesem Wert
`unranked`	boolean, in der Abfrage optional	true = nur Ticker ohne ranking-Wert
`limit`	integer, in der Abfrage optional · Vorgabe `100`	—
`offset`	integer, in der Abfrage optional · Vorgabe `0`	—

Beispiel

curl "$API/tickers" \
  -H "X-API-Key: $KEY"

POST /tickers/backfill-cik

Backfill Cik

Trägt CIKs aus der SEC-Ticker→CIK-Map (company_tickers.json) in ticker_reference nach — Voraussetzung, damit /financials/sync/all alle US-Titel abdeckt. Kollisionssicher (nur wo CIK leer & ISIN US/leer).

Name	Typ	Bedeutung
`min_days_between`	integer, in der Abfrage optional	—

Beispiel

curl -X POST "$API/tickers/backfill-cik" \
  -H "X-API-Key: $KEY"

GET /tickers/by-keyword/{keyword_id}

Get Stocks By Keyword

Alle Aktien, deren keywords_multilingual das gegebene keyword_id enthalten — sprachunabhängig (das keyword_id ist über alle Sprachen gleich).

group=company (Default): verschiedene Notierungen desselben Unternehmens

(Stammaktie, ADR, CDR, …) werden über company_id zu EINEM Unternehmen
verbunden — kein alternatives Unternehmen. Jedes Ergebnis trägt
company_id, company_name, iso_country, die primary-Hauptnotierung,
listings[] (alle Notierungen inkl. ISINs/Ticker, auch solche ohne eigenes
Keyword) sowie tickers/isins — damit Newsroom die Artikel für ALLE
Notierungen bereitstellen kann. count = Anzahl Unternehmen.

group=listing: flache Liste je Einzelnotierung (count = Notierungen).

Sortierung über sort: confidence (Default) oder market_cap. Jede Zeile trägt market_cap/market_cap_currency (EUR), damit die Trefferliste im Frontend ohne Nachladen umsortiert werden kann. Beispiel: /tickers/by-keyword/enterprise_software?sort=market_cap.

Name	Typ	Bedeutung
`keyword_id`	string, im Pfad Pflicht	—
`group`	string, in der Abfrage optional · Vorgabe `company`	company = Notierungen je Unternehmen verbinden; listing = flache Einzelnotierungen
`active`	boolean, in der Abfrage optional	nur aktive/inaktive Titel
`min_confidence`	number, in der Abfrage optional	nur Keywords mit confidence >= Wert
`sort`	string, in der Abfrage optional · Vorgabe `confidence`	confidence = beste Keyword-Zuordnung zuerst; market_cap = groesste Marktkapitalisierung zuerst
`limit`	integer, in der Abfrage optional · Vorgabe `2000`	—
`offset`	integer, in der Abfrage optional · Vorgabe `0`	—

Beispiel

curl "$API/tickers/by-keyword/12345" \
  -H "X-API-Key: $KEY"

POST /tickers/enrich/isin

Enrich Isin

Hintergrundjob: reichert jeden Ticker in ticker_reference um ISIN, WKN und Logo von onvista.de an.

only_missing: bei true (Vorgabe) werden Ticker uebersprungen, die

schon eine ISIN haben

rate_limit: hoechstens so viele Anfragen je Minute an onvista

(Vorgabe 30)

concurrency: parallele Anfragen (Vorgabe 5)

Antwortet sofort; den Fortschritt zeigt GET /tickers/enrich/isin/status (der Job wird gehalten, solange der Dienst laeuft).

Keine Parameter.

Anfragekörper `EnrichRequest`

Name	Typ	Bedeutung
`concurrency`	integer optional · Vorgabe `5`	Concurrency
`rate_limit`	integer optional · Vorgabe `30`	Rate Limit
`market`	string optional · Vorgabe `stocks`	Market
`type_filter`	string optional	Type Filter
`active`	boolean optional · Vorgabe `True`	Active
`only_missing`	boolean optional · Vorgabe `True`	Only Missing

Beispiel

curl -X POST "$API/tickers/enrich/isin" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

GET /tickers/enrich/isin/preview/{ticker_symbol}

Preview Isin Enrich

Probelauf: zeigt, was die plausibilitaetsgestuetzte Suche fuer diesen Ticker findet, ohne nach MongoDB zu schreiben.

Es werden immer beide Wege gegangen — Suche ueber das Tickersymbol und ueber Namensbestandteile. Alle strukturell gueltigen Kandidaten kommen mit ihrem Plausibilitaetswert zurueck, damit nachvollziehbar bleibt, warum einer gewonnen hat.

Name	Typ	Bedeutung
`ticker_symbol`	string, im Pfad Pflicht	—

Beispiel

curl "$API/tickers/enrich/isin/preview/SAP" \
  -H "X-API-Key: $KEY"

POST /tickers/enrich/onvista-stock

Enrich Onvista Stock

Hintergrundjob: reichert Zeilen in ticker_reference unmittelbar aus den onvista-Detaildaten an.

Vorgehen:

die onvista_id nutzen, wo sie vorliegt
sonst ueber die exakte ISIN aufloesen
bei Erfolg die Zeile ergaenzen und zur naechsten gehen

Keine Parameter.

Anfragekörper `EnrichOnvistaStockRequest`

Name	Typ	Bedeutung
`concurrency`	integer optional · Vorgabe `5`	Concurrency
`rate_limit`	integer optional · Vorgabe `30`	Rate Limit
`market`	string optional · Vorgabe `stocks`	Market
`type_filter`	string optional	Type Filter
`active`	boolean optional · Vorgabe `True`	Active
`only_missing`	boolean optional · Vorgabe `True`	Only Missing
`limit`	integer optional	Limit

Beispiel

curl -X POST "$API/tickers/enrich/onvista-stock" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

POST /tickers/enrich/onvista-stock/stale

Enrich Onvista Stock Stale

Fortlaufende onvista-Auffrischung. Holt die onvista-Detaildaten neu (was zugleich calendar_events neu aufbaut — Ergebnisberichte, Dividenden, Hauptversammlungen), und zwar nur fuer die Ticker, deren Kalender veraltet ist.

Ein Ticker gilt als veraltet, wenn er gar keine calendar_events hat oder das juengste calendar_events.synced_at aelter als max_age_days ist. Liefert eine job_id — Fortschritt ueber GET /tickers/jobs/{job_id}.

Keine Parameter.

Anfragekörper `EnrichOnvistaStockStaleRequest`

Name	Typ	Bedeutung
`max_age_days`	integer optional · Vorgabe `14`	Max Age Days
`concurrency`	integer optional · Vorgabe `5`	Concurrency
`rate_limit`	integer optional · Vorgabe `30`	Rate Limit
`market`	string optional · Vorgabe `stocks`	Market
`type_filter`	string optional	Type Filter
`active`	boolean optional · Vorgabe `True`	Active
`limit`	integer optional	Limit

Beispiel

curl -X POST "$API/tickers/enrich/onvista-stock/stale" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

GET /tickers/jobs

List Ticker Jobs

Name	Typ	Bedeutung
`limit`	integer, in der Abfrage optional · Vorgabe `20`	—

Beispiel

curl "$API/tickers/jobs" \
  -H "X-API-Key: $KEY"

GET /tickers/jobs/{job_id}

Get Ticker Job

Name	Typ	Bedeutung
`job_id`	string, im Pfad Pflicht	—

Beispiel

curl "$API/tickers/jobs/job_7f3c" \
  -H "X-API-Key: $KEY"

GET /tickers/keywords

List All Keywords

Listet alle vorkommenden keyword_id mit Anzahl der Notierungen und mehrsprachigen Labels (en/de/fr/es/it/pt) + durchschnittlicher Confidence. Sortiert nach Häufigkeit absteigend. Beispiel: /tickers/keywords?search=cloud.

Name	Typ	Bedeutung
`search`	string, in der Abfrage optional	Filtert nach keyword_id oder Label (case-insensitive)
`limit`	integer, in der Abfrage optional · Vorgabe `2000`	—

Beispiel

curl "$API/tickers/keywords" \
  -H "X-API-Key: $KEY"

POST /tickers/quality/score

Compute Quality Scores

Hintergrundjob: berechnet data_confidence fuer jeden angereicherten Ticker und legt den Wert ab. Antwortet sofort mit der Zahl der zu verarbeitenden Dokumente.

Keine Parameter.

Beispiel

curl -X POST "$API/tickers/quality/score" \
  -H "X-API-Key: $KEY"

GET /tickers/quality/stats

Quality Stats

Kennzahlen zu data_confidence ueber alle bewerteten Ticker. Liefert die Anzahl je Stufe und die schwaechsten Zuordnungen.

Keine Parameter.

Beispiel

curl "$API/tickers/quality/stats" \
  -H "X-API-Key: $KEY"

GET /tickers/resolve/{identifier}

Resolve

Zentraler Identifier-Resolver: ISIN / Ticker / CIK / WKN / onvista entity_value / id_path / Symbol -> kanonischer Bundle inkl. entity_type.

Basis für Capabilities, die einen einheitlichen Identifier brauchen (Dealings, Earnings, Scoring, Taxonomie). Bekannte Titel kommen aus ticker_reference (kein Live-Call). 404, wenn nichts passt.

Name	Typ	Bedeutung
`identifier`	string, im Pfad Pflicht	—

Beispiel

curl "$API/tickers/resolve/DE0007164600" \
  -H "X-API-Key: $KEY"

{
  "name": "SAP SE",
  "isin": "DE0007164600", "wkn": "716460", "ticker": "SAP",
  "lei": "529900D6BF99LW9R2E68", "cik": 1000184,
  "country": "DE", "countrySource": "reference"
}

POST /tickers/sync

Sync Tickers Endpoint

Stoesst einen vollstaendigen Ticker-Sync aus der angegebenen Quelle an.

Name	Typ	Bedeutung
`origin`	string, in der Abfrage Pflicht	Data source origin (e.g. 'massive.com')
`market`	string, in der Abfrage optional · Vorgabe `stocks`	—
`active`	boolean, in der Abfrage optional · Vorgabe `True`	—
`limit`	integer, in der Abfrage optional · Vorgabe `1000`	—
`rate_limit`	integer, in der Abfrage optional · Vorgabe `5`	Max API calls per minute

Beispiel

curl -X POST "$API/tickers/sync?origin=SAP" \
  -H "X-API-Key: $KEY"

POST /tickers/sync/earnings-calendar

Sync Earnings Calendar

Fortsetzbarer Kalender-Sync ueber alle Aktienticker (Vorgabe: Gattungen STOCK / CS / ADRC). Je Ticker laeuft die onvista-Anreicherung, die calendar_events mit kommenden Ergebnisberichten, Dividenden und Hauptversammlungen neu aufbaut; die Antwortzeit wird im Ledger sync_earnings festgehalten.

Ticker, die in den letzten min_days_between Tagen (Vorgabe 7) synchronisiert wurden, werden uebersprungen — ein erneuter Lauf nach einem Abbruch oder nach ein paar Tagen verarbeitet also nur, was wirklich faellig ist, und nie wieder das ganze Universum.

Liefert eine job_id — Fortschritt ueber GET /tickers/jobs/{job_id}.

Keine Parameter.

Anfragekörper `EarningsCalendarSyncRequest`

Name	Typ	Bedeutung
`min_days_between`	integer optional · Vorgabe `7`	Min Days Between
`concurrency`	integer optional · Vorgabe `5`	Concurrency
`rate_limit`	integer optional · Vorgabe `30`	Rate Limit
`market`	string optional · Vorgabe `stocks`	Market
`type_filters`	array optional · Vorgabe `['STOCK', 'CS', 'ADRC']`	Type Filters
`active`	boolean optional · Vorgabe `True`	Active
`limit`	integer optional	Limit

Beispiel

curl -X POST "$API/tickers/sync/earnings-calendar" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

GET /tickers/{ticker_symbol}

Get Ticker By Symbol

Retrieve a single ticker from the reference collection.

Enthält im Gegensatz zur Listen-Antwort auch keywords/keywords_multilingual.

Name	Typ	Bedeutung
`ticker_symbol`	string, im Pfad Pflicht	—

Beispiel

curl "$API/tickers/SAP" \
  -H "X-API-Key: $KEY"

GET /wiki/jobs

List Wiki Jobs

Listet die juengsten Wiki-Sync-Jobs.

Name	Typ	Bedeutung
`limit`	integer, in der Abfrage optional · Vorgabe `20`	—

Beispiel

curl "$API/wiki/jobs" \
  -H "X-API-Key: $KEY"

GET /wiki/jobs/{job_id}

Get Wiki Job Status

Liefert den Stand eines einzelnen Wiki-Sync-Jobs.

Name	Typ	Bedeutung
`job_id`	string, im Pfad Pflicht	—

Beispiel

curl "$API/wiki/jobs/job_7f3c" \
  -H "X-API-Key: $KEY"

POST /wiki/jobs/{job_id}/cancel

Cancel Wiki Job

Fordert den Abbruch eines laufenden Wiki-Sync-Jobs an.

Name	Typ	Bedeutung
`job_id`	string, im Pfad Pflicht	—

Beispiel

curl -X POST "$API/wiki/jobs/job_7f3c/cancel" \
  -H "X-API-Key: $KEY"

POST /wiki/sync/onvista-stock-csv

Start a background wiki-sync job for Onvista CSV imports

Legt einen Hintergrundjob an, der ticker_reference nach Zeilen mit origin = "onvista.stock_csv" durchsucht, ueber name, isin, wkn und home_symbol die passenden Wikipedia-/Wikidata-Inhalte aufloest und das Ergebnis in der Sammlung wiki ablegt.

Der Endpunkt verarbeitet die CSV-Datei nicht selbst. Er arbeitet nur auf Zeilen, die der CSV-Import zuvor nach ticker_reference gebracht hat.

Die Anfrage kehrt sofort mit einem Job-Dokument zurueck. Den Fortschritt zeigt GET /wiki/jobs/{job_id}, abbrechen laesst sich der Lauf ueber POST /wiki/jobs/{job_id}/cancel.

Name	Typ	Bedeutung
`limit`	integer, in der Abfrage optional · Vorgabe `50`	Maximum number of `ticker_reference` rows to enqueue for this job after filtering. Use small values for trial runs and larger values for batch processing.
`offset`	integer, in der Abfrage optional · Vorgabe `0`	Number of eligible `ticker_reference` rows to skip before selecting the batch. Useful for chunked or resumable processing.
`only_missing`	boolean, in der Abfrage optional · Vorgabe `True`	When `true`, process only rows that do not yet have a corresponding document in `sec_filings.wiki`. When `false`, reprocess matching rows and overwrite the wiki payload.
`concurrency`	integer, in der Abfrage optional · Vorgabe `4`	Number of parallel workers used for Wikidata/Wikipedia lookups. Higher values are faster but create more outbound requests.

Beispiel

curl -X POST "$API/wiki/sync/onvista-stock-csv" \
  -H "X-API-Key: $KEY"

Referenzdaten

List Exchanges

Beispiel

Sync All Exchange Constituents

Beispiel

Sync Exchanges

Beispiel

Get Exchange

Beispiel

List Exchange Constituent Stocks

Beispiel

Sync Exchange Constituents

Beispiel

Get Branches

Beispiel

Get Countries

Beispiel

Get Currencies

Beispiel

Get Instrument Types

Beispiel

Get Sectors

Beispiel

Sync All

Beispiel

Sync Category

Beispiel

List Tickers

Beispiel

Backfill Cik

Beispiel

Get Stocks By Keyword

Beispiel

Enrich Isin

Anfragekörper EnrichRequest

Beispiel

Preview Isin Enrich

Beispiel

Enrich Onvista Stock

Anfragekörper EnrichOnvistaStockRequest

Beispiel

Enrich Onvista Stock Stale

Anfragekörper EnrichOnvistaStockStaleRequest

Beispiel

List Ticker Jobs

Beispiel

Get Ticker Job

Beispiel

List All Keywords

Beispiel

Compute Quality Scores

Beispiel

Quality Stats

Beispiel

Resolve

Beispiel

Sync Tickers Endpoint

Beispiel

Sync Earnings Calendar

Anfragekörper EarningsCalendarSyncRequest

Beispiel

Get Ticker By Symbol

Beispiel

List Wiki Jobs

Beispiel

Get Wiki Job Status

Beispiel

Cancel Wiki Job

Beispiel

Start a background wiki-sync job for Onvista CSV imports

Beispiel

Anfragekörper `EnrichRequest`

Anfragekörper `EnrichOnvistaStockRequest`

Anfragekörper `EnrichOnvistaStockStaleRequest`

Anfragekörper `EarningsCalendarSyncRequest`