Felo API PlatformFelo API Platform
सभी Financial Data endpoint
v0.2.0-beta
OpenAPI 3.1.0

SEC फ़ाइलिंग आइटम प्राप्त करें

सर्वर:https://openapi.felo.ai
क्लाइंट लाइब्रेरी

Financial Data

​

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

Financial Data ऑपरेशन

SEC फ़ाइलिंग आइटम प्राप्त करें

​

एक SEC फ़ाइलिंग के अंदर क्रमांकित आइटम का पूरा पाठ। ticker, filing_type (10-K, 10-Q या 8-K) और year सभी आवश्यक हैं; quarter, item, accession_number या include_exhibits से और सीमित करें। items लौटाता है — हर एक में number, title और पूरा text — साथ में filing_url और accession_number। आकार का ध्यान रखें: एक 10-K लगभग 19 आइटम की पूरी गद्य सामग्री के रूप में आता है, इसलिए जब तक आपको सचमुच पूरा दस्तावेज़ न चाहिए, सब कुछ खींचने के बजाय कोई विशिष्ट item माँगें। यह तय करने के लिए कि पहले कौन-सी फ़ाइलिंग खोलनी है, get_financial_filings का उपयोग करें।

मूल्य संदर्भ

  • मीटरिंग: स्थिर सफल-request लागत आधार
  • संदर्भ request अनुमान: USD 0.02
  • संदर्भ ग्राहक गुणक: 1.0। निपटाई गई ग्राहक राशि पर इसे दोबारा लागू न करें।

यह केवल संदर्भ मेटाडेटा है — खाते का कोटेशन, गारंटीशुदा मूल्य या खर्च सीमा नहीं। रिसोर्स क्रेडिट Felo क्रेडिट नहीं हैं। अंतिम शुल्क Felo बिलिंग रिकॉर्ड के अनुसार लगते हैं।

क्वेरी पैरामीटर
  • accession_number
    टाइप: string

    8-K होने पर filing का accession number।

  • filing_type
    टाइप: string enum
    आवश्यक

    filing का प्रकार।

    मान
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    टाइप: boolean

    लिंक किए गए exhibits से raw टेक्स्ट शामिल करना है या नहीं। केवल 8-K filings पर लागू। true होने पर, exhibit ऑब्जेक्ट में 'text' फ़ील्ड शामिल होगा जिसमें पूरा exhibit कंटेंट होगा।

  • item
    टाइप: string enum

    वह item जो प्राप्त करना है।

    मान
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    टाइप: integer

    10-Q होने पर filing की तिमाही।

  • ticker
    टाइप: string
    आवश्यक

    ticker प्रतीक।

  • year
    टाइप: integer
    आवश्यक

    filing का वर्ष।

responses
  • 200
    टाइप: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    SEC फ़ाइलिंग आइटम response

    • accession_number
      टाइप: string

      फ़ाइलिंग का accession नंबर

    • cik
      टाइप: string

      कंपनी का Central Index Key (CIK)।

    • filing_type
      टाइप: string

      filing का प्रकार।

    • items
      टाइप: array object[] · ResponseE40Feb4D3D6B_FilingItem[]
      • exhibits
        टाइप: array object[] · ResponseE40Feb4D3D6B_Exhibit[]

        इस आइटम से जुड़े exhibits की सरणी। केवल 8-K फ़ाइलिंग के लिए मौजूद होती है जब exhibits हों।

        • description
          टाइप: string

          exhibit का विवरण

        • number
          टाइप: string

          exhibit नंबर (जैसे '99.1')

        • text
          टाइप: string

          exhibit की कच्ची टेक्स्ट सामग्री। केवल तब शामिल की जाती है जब 'include_exhibits' पैरामीटर true पर सेट हो।

        • url
          टाइप: string फ़ॉर्मेट: uri

          SEC वेबसाइट पर exhibit दस्तावेज़ का URL

      • name
        टाइप: string

        आइटम का नाम

      • number
        टाइप: string

        आइटम नंबर

      • text
        टाइप: string

        आइटम का टेक्स्ट

    • quarter
      टाइप: integer

      फ़ाइलिंग की तिमाही

    • resource
      टाइप: string

      संसाधन प्रकार का पहचानकर्ता

    • ticker
      टाइप: string

      कंपनी का ticker प्रतीक

    • year
      टाइप: integer

      filing का वर्ष।

    application/json
  • 202
    टाइप: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    फ़ाइलिंग अभी तैयार की जा रही है। परिणाम प्राप्त करने के लिए response body में result_url को पोल करें। इस response के लिए आपसे शुल्क नहीं लिया जाता।

    • accession_number
      टाइप: string

      तैयार की जा रही फ़ाइलिंग का accession नंबर

    • estimated_ready_at
      टाइप: string फ़ॉर्मेट: date-time

      फ़ाइलिंग कब तैयार होने की अपेक्षा है

    • message
      टाइप: string

      आगे क्या करना है इसका मानव-पठनीय विवरण

    • request_id
      टाइप: string फ़ॉर्मेट: uuid

      इस अनुरोध का पहचानकर्ता; सहायता से संपर्क करते समय उपयोगी

    • result_url
      टाइप: string

      परिणाम के लिए poll करने का URL

    • status
      enum
      const:  
      processing

      202 प्रतिक्रिया पर हमेशा 'processing'

      मान
      • processing
    application/json
  • 400

    request संसाधित नहीं किया जा सका। request पैरामीटर जाँचें।

  • 401

    एक वैध Felo API key आवश्यक है।

  • 402

    request आगे नहीं बढ़ सकता क्योंकि बिलिंग आवश्यकता पूरी नहीं हुई है।

  • 403

    खाते को यह ऑपरेशन करने की अनुमति नहीं है।

  • 429

    request या खर्च की सीमा तक पहुँच गए हैं।

  • 502

    सेवा request पूरा नहीं कर सकी।

  • 503

    API या बिलिंग सेवा अस्थायी रूप से उपलब्ध नहीं है।

  • 504

    request संसाधित करते समय सेवा का समय समाप्त हो गया।

  • default

    त्रुटि response; upstream passthrough response प्रोवाइडर फ़ॉर्मेट का उपयोग कर सकते हैं।

    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"
        }
      ]
    }
  ]
}
Get SEC filing items