API-Dokumentation

Hilfe

1. Übersicht

Die öffentliche StockDynasty-API bietet lesenden, programmatischen Zugriff auf Markt-, Firmen-, Index- und eigene Depotdaten – ideal für eigene Tools, Dashboards oder Trading-Bots zur Analyse.

Generiere deinen persönlichen API-Key unter Einstellungen.

Base URL: https://stockdynasty.io/api/v1/public

2. Authentifizierung

Jede Anfrage muss den API-Key im Header X-API-Key mitschicken.

curl -H "X-API-Key: sdk_DEIN_KEY" https://stockdynasty.io/api/v1/public/market

Ohne gültigen Key antworten alle Endpunkte mit 401 Unauthorized.

3. Rate-Limits

Die Anzahl der Anfragen pro API-Key ist pro Minute begrenzt und hängt vom Premium-Status deines Accounts ab:

  • Standard: 60 Anfragen/Minute
  • Premium: 240 Anfragen/Minute

Bei Überschreitung antwortet die API mit HTTP 429 und einem Retry-After-Header (Sekunden bis zum nächsten Zeitfenster).

4. Endpunkte

Alle Endpunkte liegen unter dem Pfad /api/v1/public und sind rein lesend (keine Order- oder Handelsaktionen möglich).

GET /market

Markt-Übersicht: aktueller Indexstand, 24h-Änderung, Anzahl Firmen, Orders und Handelsvolumen der letzten 24 Stunden.

Keine Parameter.

GET /companies

Liste aller Firmen mit aktuellem Kurs, Marktkapitalisierung, Dividende und Liquidationsstatus.

Keine Parameter.

GET /companies/{id}

Detaildaten einer einzelnen Firma: Kurs, bester Kauf-/Verkaufskurs, Marktkapitalisierung, Buchwert, Dividende, Aktionärszahl, 24h-Volumen und CEO-Name.

ParameterTypBeschreibung
idPfad-Parameter, intID der Firma

GET /companies/{id}/history

Kurs- und Volumenverlauf einer Firma über einen wählbaren Zeitraum.

ParameterTypBeschreibung
idPfad-Parameter, intID der Firma
rangeQuery-Parameter, string24h, 7d, 30d, 90d, 1y, all (Standard: 30d)

GET /index

Aktueller Marktindex-Stand mit Marktkapitalisierung und Anzahl der enthaltenen Firmen.

Keine Parameter.

GET /index/history

Verlauf des Marktindex über einen wählbaren Zeitraum.

ParameterTypBeschreibung
rangeQuery-Parameter, string24h, 7d, 30d, 90d (Standard: 7d)

GET /me

Profildaten des authentifizierten Accounts: Username, Guthaben, Premium-Status.

Keine Parameter.

GET /me/depot

Eigenes Depot des authentifizierten Accounts: alle Positionen mit aktuellem Wert und durchschnittlichem Einstandspreis.

Keine Parameter.

GET /me/company/depot

Depot der eigenen AG (der Account ist deren CEO): Firmen-Guthaben und alle Positionen mit aktuellem Wert und durchschnittlichem Einstandspreis. 404, wenn keine aktive AG.

Keine Parameter.

5. Beispiel

GET /api/v1/public/market

{
  "index_value": 13260.5,
  "index_change_pct_24h": 1.23,
  "num_companies": 191,
  "num_orders_24h": 334,
  "volume_24h": 316142.23,
  "generated_at": "2026-07-03T17:20:12+00:00"
}
6. Fehlerformat

Fehler werden immer in derselben JSON-Struktur zurückgegeben:

{"error": {"code": "not_found", "message": "Company not found"}}
HTTPcodeBeschreibung
401unauthorizedAPI-Key fehlt oder ist ungültig.
401api_key_expiredAPI-Key ist abgelaufen.
403account_bannedDer Account ist gesperrt.
404not_foundAngefragte Ressource (z. B. Firma) existiert nicht.
400invalid_rangeUngültiger Wert für den range-Parameter.
429rate_limitedRate-Limit überschritten – bitte warten (siehe Retry-After-Header).

Die öffentliche API ist aktuell rein lesend. Handelsaktionen (Orders, Anleihen etc.) sind nur über die reguläre Weboberfläche möglich.

API-Key generieren