Felo API PlatformFelo API Platform
Wszystkie endpointy Financial Data
v0.2.0-beta
OpenAPI 3.1.0

Pobierz pozycje dokumentu SEC

Felo API Support
MIT
Serwer:https://openapi.felo.ai
Biblioteki klienckie
Shell Curl

Financial Data

​

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

Financial Data Operacje

Pobierz pozycje dokumentu SEC

​

Pełny tekst numerowanych pozycji w jednym dokumencie SEC. ticker, filing_type (10-K, 10-Q lub 8-K) i year są wymagane; zawęź dalej za pomocą quarter, item, accession_number lub include_exhibits. Zwraca items — każdy z number, title i pełnym text — a także filing_url i accession_number. Uważaj na rozmiar: 10-K wraca jako około 19 pozycji pełnej prozy, więc żądaj konkretnego item, zamiast pobierać wszystko, chyba że naprawdę potrzebujesz całego dokumentu. Aby najpierw ustalić, który dokument otworzyć, użyj get_financial_filings.

Cennik referencyjny

  • Rozliczanie: stała podstawa kosztu za udane żądanie.
  • Szacunek referencyjny dla żądania: USD 0.02.
  • Referencyjny mnożnik klienta: 1.0. Nie stosuj go ponownie do rozliczonej kwoty klienta.

Wyłącznie metadane referencyjne, a nie wycena konta, gwarantowana cena lub limit wydatków. Kredyty zasobów nie są kredytami Felo. Ostateczne obciążenia są zgodne z zapisami rozliczeniowymi Felo.

Parametry zapytania
  • accession_number
    Typ: string

    Numer accession dokumentu, jeśli 8-K.

  • filing_type
    Typ: string enum
    wymagane

    Typ dokumentu.

    wartości
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    Typ: boolean

    Czy dołączyć surowy tekst z powiązanych eksponatów. Dotyczy tylko dokumentów 8-K. Gdy true, obiekty eksponatów będą zawierać pole 'text' z pełną treścią eksponatu.

  • item
    Typ: string enum

    Pozycja do pobrania.

    wartości
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    Typ: integer

    Kwartał dokumentu, jeśli 10-Q.

  • ticker
    Typ: string
    wymagane

    Symbol tickera.

  • year
    Typ: integer
    wymagane

    Rok dokumentu.

Odpowiedzi
  • 200
    Typ: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    Odpowiedź z pozycjami dokumentu SEC

    • accession_number
      Typ: string

      Numer accession dokumentu.

    • cik
      Typ: string

      Central Index Key (CIK) spółki.

    • filing_type
      Typ: string

      Typ dokumentu.

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

        Tablica załączników powiązanych z tą pozycją. Obecna tylko dla dokumentów 8-K, gdy załączniki istnieją.

        • description
          Typ: string

          Opis załącznika.

        • number
          Typ: string

          Numer załącznika (np. '99.1').

        • text
          Typ: string

          Surowa treść tekstowa załącznika. Dołączana tylko wtedy, gdy parametr 'include_exhibits' ma wartość true.

        • url
          Typ: string Format: uri

          URL dokumentu załącznika w witrynie SEC.

      • name
        Typ: string

        Nazwa pozycji.

      • number
        Typ: string

        Numer pozycji.

      • text
        Typ: string

        Tekst pozycji.

    • quarter
      Typ: integer

      Kwartał dokumentu.

    • resource
      Typ: string

      Identyfikator typu zasobu.

    • ticker
      Typ: string

      Symbol tickera spółki.

    • year
      Typ: integer

      Rok dokumentu.

    application/json
  • 202
    Typ: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    Dokument jest wciąż przygotowywany. Odpytuj result_url z treści odpowiedzi, aby pobrać wynik. Ta odpowiedź nie jest rozliczana.

    • accession_number
      Typ: string

      Numer accession przygotowywanego dokumentu.

    • estimated_ready_at
      Typ: string Format: date-time

      Przewidywany czas gotowości dokumentu.

    • message
      Typ: string

      Czytelny dla człowieka opis kolejnych kroków.

    • request_id
      Typ: string Format: uuid

      Identyfikator tego żądania; przydatny przy kontakcie z pomocą techniczną.

    • result_url
      Typ: string

      URL do odpytywania o wynik.

    • status
      enum
      const:  
      processing

      Zawsze 'processing' w odpowiedzi 202.

      wartości
      • processing
    application/json
  • 400

    Nie można przetworzyć żądania. Sprawdź parametry żądania.

  • 401

    Wymagany jest prawidłowy klucz API Felo.

  • 402

    Nie można kontynuować żądania, ponieważ nie spełniono wymogu rozliczeniowego.

  • 403

    Konto nie ma uprawnień do wykonania tej operacji.

  • 429

    Osiągnięto limit żądań lub wydatków.

  • 502

    Usługa nie mogła ukończyć żądania.

  • 503

    API lub usługa rozliczeniowa jest tymczasowo niedostępna.

  • 504

    Upłynął limit czasu usługi podczas przetwarzania żądania.

  • default

    Odpowiedź błędu; odpowiedzi przekazywane bezpośrednio od dostawcy upstream mogą używać formatów dostawcy

    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"
        }
      ]
    }
  ]
}

Odpowiedź z pozycjami dokumentu SEC

Get SEC filing items