Felo API PlatformFelo API Platform
Semua endpoint Financial Data
v0.2.0-beta
OpenAPI 3.1.0

Dapatkan item pemfailan SEC

Felo API Support
MIT
Pelayan:https://openapi.felo.ai
Pustaka Klien
Shell Curl

Financial Data

​

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

Financial Data Operasi

Dapatkan item pemfailan SEC

​

Teks penuh item bernombor dalam satu pemfailan SEC. ticker, filing_type (10-K, 10-Q atau 8-K) dan year semuanya diperlukan; sempitkan lagi dengan quarter, item, accession_number atau include_exhibits. Memulangkan items — setiap satu dengan number, title dan text penuh — serta filing_url dan accession_number. Ambil perhatian saiznya: 10-K kembali sebagai kira-kira 19 item prosa penuh, jadi minta item tertentu dan bukan menarik semuanya melainkan anda benar-benar memerlukan keseluruhan dokumen. Untuk mencari pemfailan yang perlu dibuka terlebih dahulu, gunakan get_financial_filings.

Rujukan harga

  • Pemeteran: Asas kos tetap bagi setiap permintaan berjaya.
  • Anggaran rujukan setiap permintaan: USD 0.02.
  • Pengganda pelanggan rujukan: 1.0. Jangan gunakan semula pada amaun pelanggan yang telah diselesaikan.

Metadata rujukan sahaja, bukan sebut harga akaun, harga terjamin atau had perbelanjaan. Kredit sumber bukan kredit Felo. Caj akhir mengikut rekod pengebilan Felo.

Parameter Pertanyaan
  • accession_number
    Jenis: string

    Nombor aksesi pemfailan jika 8-K.

  • filing_type
    Jenis: string enum
    wajib

    Jenis pemfailan.

    nilai
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    Jenis: boolean

    Sama ada hendak menyertakan teks mentah daripada lampiran berpaut. Hanya terpakai untuk pemfailan 8-K. Apabila true, objek lampiran akan menyertakan medan 'text' yang mengandungi kandungan lampiran penuh.

  • item
    Jenis: string enum

    Item untuk diambil.

    nilai
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    Jenis: integer

    Suku tahun pemfailan jika 10-Q.

  • ticker
    Jenis: string
    wajib

    Simbol ticker.

  • year
    Jenis: integer
    wajib

    Tahun pemfailan.

Respons
  • 200
    Jenis: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    Respons item pemfailan SEC

    • accession_number
      Jenis: string

      Nombor aksesi pemfailan.

    • cik
      Jenis: string

      Central Index Key (CIK) syarikat.

    • filing_type
      Jenis: string

      Jenis pemfailan.

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

        Tatasusunan lampiran yang dipautkan pada item ini. Hanya hadir untuk pemfailan 8-K apabila lampiran wujud.

        • description
          Jenis: string

          Penerangan lampiran.

        • number
          Jenis: string

          Nombor lampiran (contohnya, '99.1').

        • text
          Jenis: string

          Kandungan teks mentah lampiran. Hanya disertakan apabila parameter 'include_exhibits' ditetapkan kepada true.

        • url
          Jenis: string Format: uri

          URL ke dokumen lampiran di laman web SEC.

      • name
        Jenis: string

        Nama item.

      • number
        Jenis: string

        Nombor item.

      • text
        Jenis: string

        Teks item.

    • quarter
      Jenis: integer

      Suku tahun pemfailan.

    • resource
      Jenis: string

      Pengecam jenis sumber.

    • ticker
      Jenis: string

      Simbol ticker syarikat.

    • year
      Jenis: integer

      Tahun pemfailan.

    application/json
  • 202
    Jenis: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    Pemfailan masih disediakan. Tinjau result_url daripada badan respons untuk mengambil hasil. Anda tidak dicaj untuk respons ini.

    • accession_number
      Jenis: string

      Nombor aksesi pemfailan yang sedang disediakan.

    • estimated_ready_at
      Jenis: string Format: date-time

      Bila pemfailan dijangka sedia.

    • message
      Jenis: string

      Penerangan mudah dibaca tentang perkara yang perlu dilakukan seterusnya.

    • request_id
      Jenis: string Format: uuid

      Pengecam untuk permintaan ini; berguna apabila menghubungi sokongan.

    • result_url
      Jenis: string

      URL untuk melakukan polling hasil.

    • status
      enum
      const:  
      processing

      Sentiasa 'processing' pada respons 202.

      nilai
      • processing
    application/json
  • 400

    Permintaan tidak dapat diproses. Semak parameter permintaan.

  • 401

    Kunci API Felo yang sah diperlukan.

  • 402

    Permintaan tidak dapat diteruskan kerana keperluan pengebilan tidak dipenuhi.

  • 403

    Akaun tidak dibenarkan melakukan operasi ini.

  • 429

    Had permintaan atau had perbelanjaan telah dicapai.

  • 502

    Perkhidmatan tidak dapat menyelesaikan permintaan.

  • 503

    API atau perkhidmatan pengebilan tidak tersedia buat sementara waktu.

  • 504

    Perkhidmatan tamat masa semasa memproses permintaan.

  • default

    Respons ralat; respons passthrough huluan mungkin menggunakan format penyedia

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

Respons item pemfailan SEC

Get SEC filing items