sarora
Dokumentation → Filings und Publikationen
Dokumentation

Filings und Publikationen

Originaldokumente suchen, laden und in lesbaren Text wandeln.

Wozu das gut ist, steht auf der Produktseite: Filings und Publikationen

POST/download/batchPOST/download/filePOST/download/filesPOST/download/{ticker_or_cik}GET/parse/{ticker_or_cik}POST/publications/downloadPOST/publications/searchGET/publications/sourcesGET/search/{ticker_or_cik}
POST /download/batch

Download Batch

Laedt das juengste 8-K fuer eine Liste von Identifiern parallel.

Jeder Eintrag traegt genau eines von: ticker, cik, isin, wkn.

Beispielkoerper:

[{"ticker": "AAPL"}, {"ticker": "AMD"}, {"isin": "US02079K3059"}, {"cik": "320193"}]

Keine Parameter.

Beispiel

curl -X POST "$API/download/batch" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
POST /download/file

Download File

Laedt eine einzelne SEC-EDGAR-Datei ueber ihre URL und legt sie lokal ab.

Die URL muss auf ein SEC Complete Submission Text File zeigen, etwa:

https://www.sec.gov/Archives/edgar/data/1326801/
000162828026025108/0001628280-26-025108.txt

Das Dokument in sec_filings wird um file_path, file_size_kb und downloaded_at ergaenzt.

Keine Parameter.

Anfragekörper SecFileRequest

NameTypBedeutung
urlstring
Pflicht		Url

Beispiel

curl -X POST "$API/download/file" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
POST /download/files

Download Files

Laedt mehrere SEC-EDGAR-Dateien parallel. Gleiche Semantik wie POST /download/file, nimmt aber eine Liste von URL-Objekten entgegen.

Beispielkoerper:

[
  {"url": "https://www.sec.gov/Archives/edgar/data/1326801/.../0001628280-26-025108.txt"},
  {"url": "https://www.sec.gov/Archives/edgar/data/320193/.../...txt"}
]

Keine Parameter.

Beispiel

curl -X POST "$API/download/files" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
POST /download/{ticker_or_cik}

Download

Laedt das juengste 8-K fuer einen einzelnen Identifier und legt die Metadaten in MongoDB ab.

Zulaessige Formen:

AAPL              → blosser Ticker
320193            → blosse CIK
ticker:GOOGL      → ausdruecklicher Ticker
cik:320193        → ausdrueckliche CIK
isin:US0378331005 → ueber OpenFIGI zu SEC EDGAR aufgeloest
wkn:623100        → ueber OpenFIGI zu SEC EDGAR aufgeloest
NameTypBedeutung
ticker_or_cikstring, im Pfad
Pflicht		—

Beispiel

curl -X POST "$API/download/SAP" \
  -H "X-API-Key: $KEY"
GET /parse/{ticker_or_cik}

Parse Filing

Zerlegt das lokal heruntergeladene 8-K-Complete-Submission-Textfile und macht es lesbar.

  • Trennt den SGML-Behaelter der SEC in einzelne Dokumentabschnitte.
  • Entfernt HTML-, XML- und iXBRL-Auszeichnung aus den Textabschnitten.
  • Ueberspringt binaere Anhaenge (GRAPHIC, ZIP) und Taxonomiedateien.
  • Liefert je Abschnitt sauberen Text samt Metadaten, damit sichtbar wird,
was wirklich in der Datei steckt und was blosse Struktur ist.

Setzt voraus, dass die Datei zuvor ueber POST /download/{ticker_or_cik} geholt wurde.

NameTypBedeutung
ticker_or_cikstring, im Pfad
Pflicht		—

Beispiel

curl "$API/parse/SAP" \
  -H "X-API-Key: $KEY"
POST /publications/download

Publications Download

Fuehrt dieselbe Quellenauswahl aus wie /publications/search und laedt anschliessend den ersten Treffer der ersten Quelle, die ok gemeldet hat.

Ablage unter downloads/{source}/{identifier}/{filename}. Antwortet mit 404, wenn keine Quelle einen Treffer hatte.

Keine Parameter.

Anfragekörper PublicationQuery

NameTypBedeutung
identifierstring
Pflicht		Ticker, WKN, CIK, ISIN, stock code, LEI or company name
identifierTypestring
optional		auto | ticker | wkn | cik | isin | stock_code | lei | name
countrystring
optional		ISO-2 country hint: US | DE | GB | FR | CN | HK
sourcestring
optional		Pin a specific source key from SOURCE_REGISTRY
publicationTypestring
optional		earnings | annual_report | interim_report | ad_hoc | press_release | 8k | 10q | 10k | announcement | ...
limitinteger
optional · Vorgabe 10		Limit

Beispiel

curl -X POST "$API/publications/download" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
POST /publications/search

Publications Search

Quellenuebergreifende Suche nach Emittenten-Publikationen.

Reihenfolge der Quellenauswahl:

1. ausdrueckliche source
2. Hinweis ueber country
3. Heuristik anhand der Form des Identifiers (ISIN / WKN / CIK / Stock Code)

Jede befragte Quelle liefert ein eigenes SourceResult mit dem Status ok | not_implemented | error — der Endpunkt scheitert also nie nur deshalb, weil eine Quelle ausfaellt oder noch nicht umgesetzt ist.

Keine Parameter.

Anfragekörper PublicationQuery

NameTypBedeutung
identifierstring
Pflicht		Ticker, WKN, CIK, ISIN, stock code, LEI or company name
identifierTypestring
optional		auto | ticker | wkn | cik | isin | stock_code | lei | name
countrystring
optional		ISO-2 country hint: US | DE | GB | FR | CN | HK
sourcestring
optional		Pin a specific source key from SOURCE_REGISTRY
publicationTypestring
optional		earnings | annual_report | interim_report | ad_hoc | press_release | 8k | 10q | 10k | announcement | ...
limitinteger
optional · Vorgabe 10		Limit

Beispiel

curl -X POST "$API/publications/search" \
  -H "X-API-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'
GET /publications/sources

Publications Sources

Liefert die vollstaendige Quellen-Registry mit Faehigkeiten und Reifegrad.

Keine Parameter.

Beispiel

curl "$API/publications/sources" \
  -H "X-API-Key: $KEY"
GET /search/{ticker_or_cik}

Search

Sucht eine Firma ueber Ticker oder CIK und liefert die Metadaten ihrer juengsten Einreichungen. Die Ergebnisse werden in sec_filings abgelegt.

NameTypBedeutung
ticker_or_cikstring, im Pfad
Pflicht		—
limitinteger, in der Abfrage
optional · Vorgabe 1		Number of filings to return
formstring, in der Abfrage
optional		Comma-separated list of form types to filter by (e.g. `8-K`, `8-K,8-K/A`, `6-K,SC 13G,20-F`). Leave empty for all forms. Defaults to `8-K,8-K/A` if omitted.

Beispiel

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