Documentation → Other endpoints

Documentation

Other endpoints

Endpoints not assigned to a chapter.

GET /demo/api/aktie/{ticker}

Aktie

Eine Aktie mit ihren Themen, Begruendungen und Keywords.

Name	Type	Meaning
`ticker`	string, in path required	—

Example

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.

Name	Type	Meaning
`ticker`	string, in path required	—

Example

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.

No parameters.

Example

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

GET /demo/api/audit/quellen

Quellen

Die Quellenuebersicht, vorgehalten.

No parameters.

Example

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

GET /demo/api/audit/rechenwerke

Rechenwerke

Die Rechenwerk-Matrix, vorgehalten.

No parameters.

Example

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

GET /demo/api/audit/universum

Universum

Der Trichter, vorgehalten.

No parameters.

Example

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.

No parameters.

Example

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.

Name	Type	Meaning
`ticker`	string, in path required	—

Example

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.

Name	Type	Meaning
`period`	string, in query optional · default `Q`	Q \| FY \| YTD \| ALL
`masken`	integer, in query optional · default `1`	1 = Bitmasken mitliefern (fuer Schnittmengen)

Example

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.

Name	Type	Meaning
`period`	string, in query optional · default `Q`	—

Example

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.

Name	Type	Meaning
`ticker`	string, in path required	—
`period`	string, in query optional · default `TTM`	TTM \| FY \| Q \| YTD
`currency`	string, in query optional · default `reported`	reported \| usd \| eur \| native — Waehrung der Marktkapitalisierung in den Kennzahlen

Example

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.

Name	Type	Meaning
`kid`	string, in path required	—
`limit`	integer, in query optional · default `120`	—

Example

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

GET /demo/api/keywords

Keywords

Keywords nach Haeufigkeit, gefiltert nach Suchbegriff.

Name	Type	Meaning
`q`	string, in query optional	—
`limit`	integer, in query optional · default `30`	—
`mit_metadaten`	boolean, in query optional · default `False`	Auch Begriffe zeigen, die den Datensatz beschreiben statt das Geschaeft (Marktkapitalisierung)

Example

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.

Name	Type	Meaning
`ticker`	string, in path required	—
`stand`	string, in query optional · default `today`	today = gespeichert, now = Kurs live

Example

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.

Name	Type	Meaning
`ticker`	string, in path required	—
`days`	integer, in query optional · default `365`	—

Example

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.

Name	Type	Meaning
`limit`	integer, in query optional · default `1000`	—

Example

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.

Name	Type	Meaning
`ticker`	string, in path required	—
`period`	string, in query optional · default `Q`	Q \| FY \| YTD \| ALL
`limit`	integer, in query optional · default `8`	—

Example

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.

Name	Type	Meaning
`q`	string, in query required	—
`limit`	integer, in query optional · default `25`	—

Example

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.

Name	Type	Meaning
`theme_id`	string, in path required	—
`limit`	integer, in query optional · default `200`	—

Example

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.

No parameters.

Example

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.

Name	Type	Meaning
`limit`	integer, in query optional · default `150`	Firmen in der Stichprobe
`seed`	integer, in query optional · default `13`	feste Auswahl, damit Läufe vergleichbar sind

Example

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.

Name	Type	Meaning
`live`	boolean, in query optional · default `False`	—

Example

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.

Name	Type	Meaning
`limit`	integer, in query optional · default `50`	—

Example

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

POST /quality/snapshots

Create Snapshot

Den aktuellen Stand festhalten — vor und nach jedem Deployment.

No parameters.

Request body `SnapshotRequest`

Name	Type	Meaning
`label`	string required	Label
`note`	string optional	Note

Example

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.

Name	Type	Meaning
`snapshot_id`	string, in path required	—
`compare`	string, in query optional	snapshot_id des Vergleichsstands

Example

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

GET /themes

List Themes

Der Themenkatalog mit der Zahl zugeordneter Aktien.

Name	Type	Meaning
`q`	string, in query optional	Freitext auf Label und Definition
`sector`	string, in query optional	Nur Themen dieses Sektors (GICS)
`min_stocks`	integer, in query optional · default `0`	Nur Themen mit mindestens so vielen Aktien

Example

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.

Name	Type	Meaning
`ticker`	string, in path required	—
`limit`	integer, in query optional · default `50`	—
`min_confidence`	number, in query optional · default `0.5`	—
`include_dual_listings`	boolean, in query optional · default `False`	Zweitnotierungen derselben Firma mitliefern

Example

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

GET /themes/stats

Theme Stats

Kennzahlen: Abdeckung, Leerfaelle, Pruefliste, groesste Themen.

No parameters.

Example

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

GET /themes/stock/{ticker}

Stock Themes

Die Themen einer Aktie, mit Begruendung des Modells.

Name	Type	Meaning
`ticker`	string, in path required	—

Example

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.

Name	Type	Meaning
`theme_id`	string, in path required	—
`limit`	integer, in query optional · default `100`	—
`min_confidence`	number, in query optional · default `0.0`	—

Example

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.

Name	Type	Meaning
`limit`	integer, in query optional · default `50`	—

Example

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.

Name	Type	Meaning
`ticker`	string, in path required	—
`days`	integer, in query optional · default `365`	Fenster in Tagen
`metrics`	string, in query optional · default `pe,ps`	Kommaliste: pe, ps, pb, pcf, peg

Example

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

Other endpoints

Aktie

Example

Firma

Example

Hebel

Example

Quellen

Example

Rechenwerke

Example

Universum

Example

Datenqualitaet

Example

Datenqualitaet Ticker

Example

Feldabdeckung

Example

Kennzahlabdeckung

Example

Kennzahlen

Example

Keyword

Example

Keywords

Example

Marktkapitalisierung Endpunkt

Example

Multiplikatoren

Example

Potenzial

Example

Statements

Example

Suche

Example

Thema

Example

Themen

Example

Konsistenz Endpunkt

Example

Current Metrics

Example

List Snapshots

Example

Create Snapshot

Request body SnapshotRequest

Example

Get Snapshot

Example

List Themes

Example

Theme Peers

Example

Theme Stats

Example

Stock Themes

Example

Theme Detail

Example

Coverage

Example

Timeseries

Example

Request body `SnapshotRequest`