Dokumentation → Weitere Endpunkte
Dokumentation

Weitere Endpunkte

Endpunkte, die keinem Kapitel zugeordnet sind.

GET /demo/api/aktie/{ticker}

Aktie

Eine Aktie mit ihren Themen, Begruendungen und Keywords.

NameTypBedeutung
tickerstring, im Pfad
Pflicht

Beispiel

curl "$API/demo/api/aktie/SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/audit/firma/{ticker}

Firma

Alles, was für eine Firma vorliegt — über alle Quellen hinweg.

Der bestehende /datenqualitaet/{ticker} zeigt nur sec_financials und verschweigt damit, dass anderswo Zahlen liegen.

NameTypBedeutung
tickerstring, im Pfad
Pflicht

Beispiel

curl "$API/demo/api/audit/firma/SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/audit/hebel

Hebel

Was jeder Hebel gebracht hat — als Zahl, nicht als Behauptung.

Kommt aus demselben vorberechneten Stand wie /rechenwerke. Fehlt der, gibt es hier nichts zu zeigen: die Werte von Hand nachzurechnen waere genau das, was diese Liste ersetzen soll.

Keine Parameter.

Beispiel

curl "$API/demo/api/audit/hebel" \
  -H "X-API-Key: $KEY"
GET /demo/api/audit/quellen

Quellen

Die Quellenuebersicht, vorgehalten.

Keine Parameter.

Beispiel

curl "$API/demo/api/audit/quellen" \
  -H "X-API-Key: $KEY"
GET /demo/api/audit/rechenwerke

Rechenwerke

Die Rechenwerk-Matrix, vorgehalten.

Keine Parameter.

Beispiel

curl "$API/demo/api/audit/rechenwerke" \
  -H "X-API-Key: $KEY"
GET /demo/api/audit/universum

Universum

Der Trichter, vorgehalten.

Keine Parameter.

Beispiel

curl "$API/demo/api/audit/universum" \
  -H "X-API-Key: $KEY"
GET /demo/api/datenqualitaet

Datenqualitaet

Wie weit reicht welcher Bestand — und wo sind die Loecher.

Keine Parameter.

Beispiel

curl "$API/demo/api/datenqualitaet" \
  -H "X-API-Key: $KEY"
GET /demo/api/datenqualitaet/{ticker}

Datenqualitaet Ticker

Was liegt fuer genau diese Aktie vor — Periode fuer Periode.

NameTypBedeutung
tickerstring, im Pfad
Pflicht

Beispiel

curl "$API/demo/api/datenqualitaet/SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/feldabdeckung

Feldabdeckung

Quote je Kennzahl ueber alle Firmen, plus Masken fuer Schnittmengen.

NameTypBedeutung
periodstring, in der Abfrage
optional · Vorgabe Q
Q | FY | YTD | ALL
maskeninteger, in der Abfrage
optional · Vorgabe 1
1 = Bitmasken mitliefern (fuer Schnittmengen)

Beispiel

curl "$API/demo/api/feldabdeckung" \
  -H "X-API-Key: $KEY"
GET /demo/api/kennzahlabdeckung

Kennzahlabdeckung

Wie viele Firmen tragen die Bestandteile einer Kennzahl — alle zugleich.

Gerechnet wird auf denselben Bitmasken wie /feldabdeckung, nur eine Ebene hoeher: eine Kennzahl gilt als moeglich, wenn die Firma jedes ihrer Eingangsfelder hat. Ein Feld kann dabei aus mehreren Rechenwerken kommen (netIncome steht in Erfolgsrechnung und Kapitalfluss), deshalb wird je Feld ueber die Rechenwerke oder-verknuepft und ueber die Felder und-verknuepft.

Das Ergebnis ist die ehrliche Zahl: Wer eine Kennzahl ueber den Bestand rechnen will, bekommt hier, fuer wie viele Firmen sie ueberhaupt entsteht.

NameTypBedeutung
periodstring, in der Abfrage
optional · Vorgabe Q

Beispiel

curl "$API/demo/api/kennzahlabdeckung" \
  -H "X-API-Key: $KEY"
GET /demo/api/kennzahlen/{ticker}

Kennzahlen

Verhaeltniszahlen und Key Metrics einer Firma, mit Grund je Luecke.

NameTypBedeutung
tickerstring, im Pfad
Pflicht
periodstring, in der Abfrage
optional · Vorgabe TTM
TTM | FY | Q | YTD
currencystring, in der Abfrage
optional · Vorgabe reported
reported | usd | eur | native — Waehrung der Marktkapitalisierung in den Kennzahlen

Beispiel

curl "$API/demo/api/kennzahlen/SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/keyword/{kid}

Keyword

Die Aktien, deren Profil dieses Keyword hergab — samt ihren Themen.

Das ist die eigentliche Probe: wer "Falcon-Plattform" sucht, sollte CrowdStrike finden und daneben sehen, dass dort cybersecurity steht.

NameTypBedeutung
kidstring, im Pfad
Pflicht
limitinteger, in der Abfrage
optional · Vorgabe 120

Beispiel

curl "$API/demo/api/keyword/SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/keywords

Keywords

Keywords nach Haeufigkeit, gefiltert nach Suchbegriff.

NameTypBedeutung
qstring, in der Abfrage
optional
limitinteger, in der Abfrage
optional · Vorgabe 30
mit_metadatenboolean, in der Abfrage
optional · Vorgabe False
Auch Begriffe zeigen, die den Datensatz beschreiben statt das Geschaeft (Marktkapitalisierung)

Beispiel

curl "$API/demo/api/keywords" \
  -H "X-API-Key: $KEY"
GET /demo/api/marktkapitalisierung/{ticker}

Marktkapitalisierung Endpunkt

Wie gross ist diese Firma — gespeichert oder mit dem Kurs von jetzt.

today ruft nichts ab und ist fuer Listen gedacht. now holt den Snapshot bei onvista und haelt das Ergebnis fuer den laufenden Tag vor; ein zweiter Aufruf kostet nichts mehr. Fehlt die Aktienzahl oder die onvista-Kennung, faellt die Antwort auf den gespeicherten Stand zurueck und sagt das.

NameTypBedeutung
tickerstring, im Pfad
Pflicht
standstring, in der Abfrage
optional · Vorgabe today
today = gespeichert, now = Kurs live

Beispiel

curl "$API/demo/api/marktkapitalisierung/SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/multiplikatoren/{ticker}

Multiplikatoren

Bewertungskennzahlen im Tagesverlauf, fuer die Demo-Seite.

Dieselbe Rechnung wie /valuation/timeseries, nur ohne Zugangsdaten und auf das reduziert, was die Seite zeichnet. Fehlt etwas — keine Kurse, keine Quartalszahlen, unpassende Waehrung — kommt kein Fehler, sondern verfuegbar: false mit Grund: der Tab soll sich still ausblenden koennen, nicht die Seite mit einem 404 fuellen.

NameTypBedeutung
tickerstring, im Pfad
Pflicht
daysinteger, in der Abfrage
optional · Vorgabe 365

Beispiel

curl "$API/demo/api/multiplikatoren/SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/potenzial

Potenzial

Was am Datenbestand noch zu holen ist — und was prinzipiell nicht.

Die Kachel auf der Startseite nennt Zahlen; hier stehen die Firmen dahinter. Das ist der Unterschied zwischen einer Behauptung und einer pruefbaren Aussage: 836 Firmen ohne SEC-XBRL kann man nachzaehlen, wenn sie namentlich dastehen — und dabei auffaellt, dass es fast ausschliesslich unsponsorte ADRs sind, fuer die die SEC per Konstruktion nichts fuehrt.

NameTypBedeutung
limitinteger, in der Abfrage
optional · Vorgabe 1000

Beispiel

curl "$API/demo/api/potenzial" \
  -H "X-API-Key: $KEY"
GET /demo/api/statements/{ticker}

Statements

Die drei Rechenwerke als Zeilen je Kennzahl, Perioden als Spalten.

NameTypBedeutung
tickerstring, im Pfad
Pflicht
periodstring, in der Abfrage
optional · Vorgabe Q
Q | FY | YTD | ALL
limitinteger, in der Abfrage
optional · Vorgabe 8

Beispiel

curl "$API/demo/api/statements/SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/suche

Suche

Aktien nach Ticker, ISIN, WKN oder Name.

Exakte Kennungstreffer zuerst, dann Namensanfang, dann Namensteil — wer eine ISIN eingibt, will nicht erst durch Namenstreffer scrollen.

NameTypBedeutung
qstring, in der Abfrage
Pflicht
limitinteger, in der Abfrage
optional · Vorgabe 25

Beispiel

curl "$API/demo/api/suche?q=SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/thema/{theme_id}

Thema

Ein Thema: Definition aus dem Katalog und die Aktien darunter.

NameTypBedeutung
theme_idstring, im Pfad
Pflicht
limitinteger, in der Abfrage
optional · Vorgabe 200

Beispiel

curl "$API/demo/api/thema/SAP" \
  -H "X-API-Key: $KEY"
GET /demo/api/themen

Themen

Der ganze Katalog: Zahl der Aktien und ein paar bekannte Vertreter.

Keine Parameter.

Beispiel

curl "$API/demo/api/themen" \
  -H "X-API-Key: $KEY"
GET /quality/konsistenz

Konsistenz Endpunkt

Rechnen sich die Datensätze gegen sich selbst auf?

Ergänzt /quality/metrics: Dort steht, wie viel vorliegt, hier, ob es stimmt. Die Stichprobe ist über seed festgelegt — zwei Läufe vergleichen dieselben Firmen, sonst misst man die Auswahl statt die Daten.

NameTypBedeutung
limitinteger, in der Abfrage
optional · Vorgabe 150
Firmen in der Stichprobe
seedinteger, in der Abfrage
optional · Vorgabe 13
feste Auswahl, damit Läufe vergleichbar sind

Beispiel

curl "$API/quality/konsistenz" \
  -H "X-API-Key: $KEY"
GET /quality/metrics

Current Metrics

Der aktuelle Stand. live=true misst neu (~5 s), sonst der letzte Snapshot.

NameTypBedeutung
liveboolean, in der Abfrage
optional · Vorgabe False

Beispiel

curl "$API/quality/metrics" \
  -H "X-API-Key: $KEY"
GET /quality/snapshots

List Snapshots

Alle Stände, neueste zuerst — je Eintrag ein Tab im Frontend.

NameTypBedeutung
limitinteger, in der Abfrage
optional · Vorgabe 50

Beispiel

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

Create Snapshot

Den aktuellen Stand festhalten — vor und nach jedem Deployment.

Keine Parameter.

Anfragekörper SnapshotRequest

NameTypBedeutung
labelstring
Pflicht
Label
notestring
optional
Note

Beispiel

curl -X POST "$API/quality/snapshots" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
GET /quality/snapshots/{snapshot_id}

Get Snapshot

Ein Stand — mit compare zusätzlich die Veränderung gegenüber einem anderen.

NameTypBedeutung
snapshot_idstring, im Pfad
Pflicht
comparestring, in der Abfrage
optional
snapshot_id des Vergleichsstands

Beispiel

curl "$API/quality/snapshots/SAP" \
  -H "X-API-Key: $KEY"
GET /themes

List Themes

Der Themenkatalog mit der Zahl zugeordneter Aktien.

NameTypBedeutung
qstring, in der Abfrage
optional
Freitext auf Label und Definition
sectorstring, in der Abfrage
optional
Nur Themen dieses Sektors (GICS)
min_stocksinteger, in der Abfrage
optional · Vorgabe 0
Nur Themen mit mindestens so vielen Aktien

Beispiel

curl "$API/themes" \
  -H "X-API-Key: $KEY"
GET /themes/peers/{ticker}

Theme Peers

Aktien, die dieselben Themen tragen — der Vergleichbaren-Fall.

Sortiert nach Zahl gemeinsamer Themen, dann nach Konfidenz. Anders als ein Sektorvergleich stellt das CrowdStrike neben Palo Alto und Zscaler statt neben beliebige IT-Dienstleister.

NameTypBedeutung
tickerstring, im Pfad
Pflicht
limitinteger, in der Abfrage
optional · Vorgabe 50
min_confidencenumber, in der Abfrage
optional · Vorgabe 0.5
include_dual_listingsboolean, in der Abfrage
optional · Vorgabe False
Zweitnotierungen derselben Firma mitliefern

Beispiel

curl "$API/themes/peers/SAP" \
  -H "X-API-Key: $KEY"
GET /themes/stats

Theme Stats

Kennzahlen: Abdeckung, Leerfaelle, Pruefliste, groesste Themen.

Keine Parameter.

Beispiel

curl "$API/themes/stats" \
  -H "X-API-Key: $KEY"
GET /themes/stock/{ticker}

Stock Themes

Die Themen einer Aktie, mit Begruendung des Modells.

NameTypBedeutung
tickerstring, im Pfad
Pflicht

Beispiel

curl "$API/themes/stock/SAP" \
  -H "X-API-Key: $KEY"
GET /themes/{theme_id}

Theme Detail

Ein Thema: Definition aus dem Katalog plus die zugeordneten Aktien.

NameTypBedeutung
theme_idstring, im Pfad
Pflicht
limitinteger, in der Abfrage
optional · Vorgabe 100
min_confidencenumber, in der Abfrage
optional · Vorgabe 0.0

Beispiel

curl "$API/themes/SAP" \
  -H "X-API-Key: $KEY"
GET /valuation/coverage

Coverage

Fuer welche Ticker traegt die Zeitreihe ueberhaupt?

Sie braucht beides: Kurse und Quartalszahlen. Der Engpass sind die Kurse — price_history deckt bisher nur einen kleinen Teil ab.

NameTypBedeutung
limitinteger, in der Abfrage
optional · Vorgabe 50

Beispiel

curl "$API/valuation/coverage" \
  -H "X-API-Key: $KEY"
GET /valuation/timeseries/{ticker}

Timeseries

Kennzahlen je Handelstag, dazu die Meldetermine.

Zwischen zwei Meldungen laeuft die Kennzahl mit dem Kurs; am Meldetag wechselt der Nenner und die Kurve springt. Die Spruenge stehen in earnings.

NameTypBedeutung
tickerstring, im Pfad
Pflicht
daysinteger, in der Abfrage
optional · Vorgabe 365
Fenster in Tagen
metricsstring, in der Abfrage
optional · Vorgabe pe,ps
Kommaliste: pe, ps, pb, pcf, peg

Beispiel

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