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

Dapatkan item pengajuan SEC

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

Financial Data

​

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

Financial Data Operasi

Dapatkan item pengajuan SEC

​

Teks lengkap item bernomor di dalam satu pengajuan SEC. ticker, filing_type (10-K, 10-Q, atau 8-K), dan year semuanya wajib; persempit lebih lanjut dengan quarter, item, accession_number, atau include_exhibits. Mengembalikan items — masing-masing dengan number, title, dan text lengkap — plus filing_url dan accession_number. Perhatikan ukurannya: 10-K kembali sebagai sekitar 19 item prosa lengkap, jadi minta item tertentu alih-alih menarik semuanya kecuali Anda benar-benar membutuhkan seluruh dokumen. Untuk menemukan pengajuan mana yang harus dibuka, gunakan get_financial_filings.

Referensi harga

  • Metering: Dasar biaya tetap per permintaan berhasil.
  • Estimasi referensi per permintaan: USD 0.02.
  • Pengali pelanggan referensi: 1.0. Jangan terapkan lagi pada jumlah pelanggan yang telah diselesaikan.

Hanya metadata referensi, bukan penawaran akun, harga yang dijamin, atau batas pengeluaran. Kredit sumber daya bukanlah kredit Felo. Biaya akhir mengikuti catatan tagihan Felo.

Parameter Kueri
  • accession_number
    Tipe: string

    Nomor aksesi pengajuan jika 8-K.

  • filing_type
    Tipe: string enum
    wajib

    Jenis pengajuan.

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

    Apakah akan menyertakan teks mentah dari lampiran tertaut. Hanya berlaku untuk pengajuan 8-K. Ketika true, objek lampiran akan menyertakan field 'text' yang berisi konten lampiran lengkap.

  • item
    Tipe: string enum

    Item yang akan diambil.

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

    Kuartal pengajuan jika 10-Q.

  • ticker
    Tipe: string
    wajib

    Simbol ticker.

  • year
    Tipe: integer
    wajib

    Tahun pengajuan.

Respons
  • 200
    Tipe: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    Respons item pengajuan SEC

    • accession_number
      Tipe: string

      Nomor aksesi pengajuan.

    • cik
      Tipe: string

      Central Index Key (CIK) perusahaan.

    • filing_type
      Tipe: string

      Jenis pengajuan.

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

        Array lampiran yang tertaut ke item ini. Hanya ada untuk pengajuan 8-K jika lampiran tersedia.

        • description
          Tipe: string

          Deskripsi lampiran.

        • number
          Tipe: string

          Nomor lampiran (misalnya, '99.1').

        • text
          Tipe: string

          Konten teks mentah lampiran. Hanya disertakan jika parameter 'include_exhibits' diatur ke true.

        • url
          Tipe: string Format: uri

          URL ke dokumen lampiran di situs web SEC.

      • name
        Tipe: string

        Nama item.

      • number
        Tipe: string

        Nomor item.

      • text
        Tipe: string

        Teks item.

    • quarter
      Tipe: integer

      Kuartal pengajuan.

    • resource
      Tipe: string

      Pengenal jenis sumber daya.

    • ticker
      Tipe: string

      Simbol ticker perusahaan.

    • year
      Tipe: integer

      Tahun pengajuan.

    application/json
  • 202
    Tipe: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    Pengajuan masih disiapkan. Lakukan polling result_url dari isi respons untuk mengambil hasil. Anda tidak ditagih untuk respons ini.

    • accession_number
      Tipe: string

      Nomor aksesi pengajuan yang sedang disiapkan.

    • estimated_ready_at
      Tipe: string Format: date-time

      Kapan pengajuan diperkirakan siap.

    • message
      Tipe: string

      Deskripsi yang mudah dibaca tentang apa yang harus dilakukan selanjutnya.

    • request_id
      Tipe: string Format: uuid

      Pengenal untuk permintaan ini; berguna saat menghubungi dukungan.

    • result_url
      Tipe: string

      URL untuk polling hasil.

    • status
      enum
      const:  
      processing

      Selalu 'processing' pada respons 202.

      nilai
      • processing
    application/json
  • 400

    Permintaan tidak dapat diproses. Periksa parameter permintaan.

  • 401

    Kunci API Felo yang valid diperlukan.

  • 402

    Permintaan tidak dapat dilanjutkan karena persyaratan penagihan belum terpenuhi.

  • 403

    Akun tidak diizinkan melakukan operasi ini.

  • 429

    Batas permintaan atau batas pengeluaran telah tercapai.

  • 502

    Layanan tidak dapat menyelesaikan permintaan.

  • 503

    API atau layanan penagihan untuk sementara tidak tersedia.

  • 504

    Layanan kehabisan waktu saat memproses permintaan.

  • default

    Respons error; respons passthrough upstream dapat 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 pengajuan SEC

Get SEC filing items