Felo API PlatformFelo API Platform
تمام Financial Data endpoints
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 استعمال کریں۔

قیمت کا حوالہ

  • میٹرنگ: کامیاب درخواست کی مقررہ لاگت کی بنیاد۔
  • حوالہ جاتی درخواست کا تخمینہ: USD 0.02۔
  • حوالہ جاتی صارف ملٹی پلائر: 1.0۔ تصفیہ شدہ صارف رقم پر اسے دوبارہ لاگو نہیں کریں۔

صرف حوالہ جاتی میٹا ڈیٹا، نہ کہ اکاؤنٹ کا کوٹ، ضمانت شدہ قیمت یا اخراجات کی حد۔ ریسورس کریڈٹس Felo کریڈٹس نہیں ہیں۔ حتمی چارجز Felo کے بلنگ ریکارڈز کے مطابق ہوں گے۔

کوئری پیرامیٹرز
  • accession_number
    قسم: string

    اگر 8-K ہو تو فلنگ کا الحاقی نمبر۔

  • filing_type
    قسم: string enum
    لازمی

    فلنگ کی قسم۔

    اقدار
    • 10-K
    • 10-Q
    • 8-K
  • include_exhibits
    قسم: boolean

    لنک شدہ ایگزیبٹس سے خام متن شامل کرنا ہے یا نہیں۔ صرف 8-K فلنگز پر لاگو ہے۔ true ہونے پر ایگزیبٹ آبجیکٹس میں 'text' فیلڈ شامل ہوگی جس میں ایگزیبٹ کا مکمل مواد ہوگا۔

  • item
    قسم: string enum

    حاصل کرنے کے لیے آئٹم۔

    اقدار
    • Item-1
    • Item-1A
    • Item-1B
    • Item-2
    • Item-3
  • quarter
    قسم: integer

    اگر 10-Q ہو تو فلنگ کی سہ ماہی۔

  • ticker
    قسم: string
    لازمی

    ٹکر سمبل۔

  • year
    قسم: integer
    لازمی

    فلنگ کا سال۔

جوابات
  • 200
    قسم: object · ResponseE40Feb4D3D6B_FilingItemsResponse

    SEC فائلنگ آئٹمز کا جواب

    • accession_number
      قسم: string

      فائلنگ کا ایکسیشن نمبر۔

    • cik
      قسم: string

      کمپنی کا Central Index Key (CIK)۔

    • filing_type
      قسم: string

      فلنگ کی قسم۔

    • items
      قسم: array object[] · ResponseE40Feb4D3D6B_FilingItem[]
      • exhibits
        قسم: array object[] · ResponseE40Feb4D3D6B_Exhibit[]

        اس آئٹم سے منسلک ایگزیبٹس کی صف۔ صرف 8-K فائلنگز کے لیے موجود جب ایگزیبٹس ہوں۔

        • description
          قسم: string

          ایگزیبٹ کی تفصیل۔

        • number
          قسم: string

          ایگزیبٹ نمبر (مثلاً '99.1')۔

        • text
          قسم: string

          ایگزیبٹ کا خام متنی مواد۔ صرف اس وقت شامل کیا جاتا ہے جب 'include_exhibits' پیرامیٹر true پر سیٹ ہو۔

        • url
          قسم: string فارمیٹ: uri

          SEC ویب سائٹ پر ایگزیبٹ دستاویز کا URL۔

      • name
        قسم: string

        آئٹم کا نام۔

      • number
        قسم: string

        آئٹم نمبر۔

      • text
        قسم: string

        آئٹم کا متن۔

    • quarter
      قسم: integer

      فائلنگ کی سہ ماہی۔

    • resource
      قسم: string

      ریسورس کی قسم کا شناخت کنندہ۔

    • ticker
      قسم: string

      کمپنی کا ٹکر سمبل۔

    • year
      قسم: integer

      فلنگ کا سال۔

    application/json
  • 202
    قسم: object · ResponseE40Feb4D3D6B_FilingItemsAccepted

    فائلنگ ابھی تیار ہو رہی ہے۔ نتیجہ حاصل کرنے کے لیے جواب کے باڈی میں result_url کو پول کریں۔ اس جواب کا آپ سے بل وصول نہیں کیا جاتا۔

    • accession_number
      قسم: string

      تیار کی جا رہی فائلنگ کا ایکسیشن نمبر۔

    • estimated_ready_at
      قسم: string فارمیٹ: date-time

      فائلنگ کب تیار ہونے کی توقع ہے۔

    • message
      قسم: string

      آگے کیا کرنا ہے اس کی انسانی پڑھنے کے قابل تفصیل۔

    • request_id
      قسم: string فارمیٹ: uuid

      اس درخواست کا شناخت کنندہ؛ سپورٹ سے رابطے کے وقت مفید۔

    • result_url
      قسم: string

      نتیجہ کے لیے پول کرنے کا URL۔

    • status
      enum
      const:  
      processing

      202 جواب پر ہمیشہ 'processing'۔

      اقدار
      • processing
    application/json
  • 400

    درخواست پر کارروائی نہیں ہو سکی۔ درخواست کے پیرامیٹرز چیک کریں۔

  • 401

    درست Felo API کلید درکار ہے۔

  • 402

    درخواست آگے نہیں بڑھ سکتی کیونکہ بلنگ کی شرط پوری نہیں ہوئی۔

  • 403

    اکاؤنٹ کو یہ آپریشن کرنے کی اجازت نہیں۔

  • 429

    درخواست یا اخراجات کی حد پوری ہو گئی ہے۔

  • 502

    سروس درخواست مکمل نہیں کر سکی۔

  • 503

    API یا بلنگ سروس عارضی طور پر دستیاب نہیں۔

  • 504

    درخواست پر کارروائی کے دوران سروس کا وقت ختم ہو گیا۔

  • default

    خرابی کا جواب؛ اپ اسٹریم پاس تھرو جوابات پرووائیڈر کی شکلیں استعمال کر سکتے ہیں

    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