Felo API PlatformFelo API Platform
Všechny endpointy Financial Data
v0.2.0-beta
OpenAPI 3.1.0

Získat položky podání SEC

Felo API Support
MIT
Server:https://openapi.felo.ai
Klientské knihovny
Shell Curl

Financial Data

​

Company fundamentals, financial statements, market prices and economic data.

Financial Data Operace

Získat položky podání SEC

​

Úplný text číslovaných položek v jednom podání SEC. ticker, filing_type (10-K, 10-Q nebo 8-K) a year jsou povinné; dále zužte pomocí quarter, item, accession_number nebo include_exhibits. Vrací items — každou s number, title a úplným text — a také filing_url a accession_number. Pozor na velikost: 10-K se vrací jako přibližně 19 položek plné prózy, proto žádejte konkrétní item, místo abyste stahovali vše, pokud celý dokument skutečně nepotřebujete. K nalezení toho, které podání otevřít, použijte get_financial_filings.

Cenová reference

  • Účtování: pevná nákladová základna za úspěšný požadavek.
  • Referenční odhad požadavku: USD 0.02.
  • Referenční multiplikátor zákazníka: 1.0. Znovu jej neaplikujte na již zúčtovanou částku zákazníka.

Pouze referenční metadata, nikoli nabídka pro účet, garantovaná cena či limit utrácení. Kredity prostředků nejsou kredity Felo. Konečné účtování se řídí fakturačními záznamy Felo.

Parametry dotazu
  • accession_number
    Typ: string

    Přístupové číslo podání v případě 8-K.

  • filing_type
    Typ: string enum
    povinné

    Typ podání.

    hodnoty
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    Typ: boolean

    Zda zahrnout surový text z propojených příloh. Platí pouze pro podání 8-K. Pokud je true, objekty příloh budou obsahovat pole 'text' s úplným obsahem přílohy.

  • item
    Typ: string enum

    Položka k načtení.

    hodnoty
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    Typ: integer

    Čtvrtletí podání v případě 10-Q.

  • ticker
    Typ: string
    povinné

    Symbol tickeru.

  • year
    Typ: integer
    povinné

    Rok podání.

Odpovědi
  • 200
    Typ: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    Odpověď s položkami podání SEC

    • accession_number
      Typ: string

      Přístupové číslo podání.

    • cik
      Typ: string

      Central Index Key (CIK) společnosti.

    • filing_type
      Typ: string

      Typ podání.

    • items
      Typ: array object[] · ResponseE40Feb4D3D6B_FilingItem[]
      • exhibits
        Typ: array object[] · ResponseE40Feb4D3D6B_Exhibit[]

        Pole příloh propojených s touto položkou. Přítomno pouze u podání 8-K, pokud přílohy existují.

        • description
          Typ: string

          Popis přílohy.

        • number
          Typ: string

          Číslo přílohy (např. '99.1').

        • text
          Typ: string

          Surový textový obsah přílohy. Zahrnuto pouze tehdy, když je parametr 'include_exhibits' nastaven na true.

        • url
          Typ: string Formát: uri

          URL dokumentu přílohy na webu SEC.

      • name
        Typ: string

        Název položky.

      • number
        Typ: string

        Číslo položky.

      • text
        Typ: string

        Text položky.

    • quarter
      Typ: integer

      Čtvrtletí podání.

    • resource
      Typ: string

      Identifikátor typu prostředku.

    • ticker
      Typ: string

      Symbol tickeru společnosti.

    • year
      Typ: integer

      Rok podání.

    application/json
  • 202
    Typ: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    Podání se stále připravuje. Dotazujte result_url z těla odpovědi, abyste výsledek získali. Tato odpověď se neúčtuje.

    • accession_number
      Typ: string

      Přístupové číslo připravovaného podání.

    • estimated_ready_at
      Typ: string Formát: date-time

      Kdy má být podání připraveno.

    • message
      Typ: string

      Čitelný popis toho, co dělat dál.

    • request_id
      Typ: string Formát: uuid

      Identifikátor tohoto požadavku; užitečný při kontaktování podpory.

    • result_url
      Typ: string

      URL pro dotazování na výsledek.

    • status
      enum
      const:  
      processing

      Vždy 'processing' u odpovědi 202.

      hodnoty
      • processing
    application/json
  • 400

    Požadavek se nepodařilo zpracovat. Zkontrolujte parametry požadavku.

  • 401

    Je vyžadován platný API klíč Felo.

  • 402

    V požadavku nelze pokračovat, protože není splněn požadavek na fakturaci.

  • 403

    Účet nemá oprávnění tuto operaci provést.

  • 429

    Byl dosažen limit požadavků nebo útraty.

  • 502

    Služba nemohla požadavek dokončit.

  • 503

    API nebo fakturační služba je dočasně nedostupná.

  • 504

    Při zpracování požadavku vypršel časový limit služby.

  • default

    Chybová odpověď; odpovědi předávané přímo od upstream poskytovatele mohou používat formáty poskytovatele

    application/json
Request Example for get/v1/beta/financial/filings/items
curl 'https://openapi.felo.ai/v1/beta/financial/filings/items?filing_type=10-K&ticker=&year=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "resource": "string",
  "ticker": "string",
  "cik": "string",
  "filing_type": "string",
  "accession_number": "string",
  "year": 1,
  "quarter": 1,
  "items": [
    {
      "number": "string",
      "name": "string",
      "text": "string",
      "exhibits": [
        {
          "number": "string",
          "description": "string",
          "url": "https://example.com",
          "text": "string"
        }
      ]
    }
  ]
}

Odpověď s položkami podání SEC

Get SEC filing items