Felo API PlatformFelo API Platform
همه endpointهای Financial Data
v0.2.0-beta
OpenAPI 3.1.0

دریافت همه صورت‌های مالی

سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت

Financial Data

​

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

Financial Data عملیات

دریافت همه صورت‌های مالی

​

هر سه صورت مالی یک شرکت در یک فراخوانی. یک شیء financials برمی‌گرداند که income_statements، balance_sheets و cash_flow_statements را در خود دارد، هر یک به همان شکلی که ابزارهای اختصاصی برمی‌گردانند. period الزامی است (annual، quarterly یا ttm)؛ شرکت را با ticker یا cik شناسایی کنید و با limit محدود کنید. وقتی به تصویر کامل نیاز دارید و در غیر این صورت سه فراخوانی می‌کردید از آن استفاده کنید. وقتی فقط یک صورت می‌خواهید، get_financial_financials_income_statements، get_financial_financials_balance_sheets یا get_financial_financials_cash_flow_statements داده بسیار کمتری برمی‌گردانند؛ وقتی چند فیلد نام‌دار از چند شرکت می‌خواهید، post_financial_financials_search_line_items باز هم باریک‌تر است.

مرجع قیمت‌گذاری

  • اندازه‌گیری: مبنای هزینه ثابت برای درخواست موفق.
  • برآورد درخواست مرجع: 0.02 دلار آمریکا.
  • ضریب مشتری مرجع: 1.0. آن را دوباره روی مبلغ تسویه‌شده مشتری اعمال نکنید.

فقط فراداده مرجع، نه نقل‌قول حساب، نه قیمت تضمین‌شده و نه سقف هزینه. اعتبار منابع، اعتبار Felo نیست. هزینه‌های نهایی تابع سوابق صورت‌حساب Felo است.

پارامترهای پرس‌وجو
  • cik
    نوع: string

    کلید شاخص مرکزی (CIK) شرکت.

  • cursor
    نوع: string

    نشانگر صفحه‌بندی مبهم از next_page_url یک پاسخ قبلی. در صورت ارائه، همه پارامترهای دیگر کوئری نادیده گرفته می‌شوند: نشانگر فیلترهای درخواست اصلی را حمل می‌کند. آن را مبهم در نظر بگیرید؛ آن را نسازید یا تغییر ندهید.

  • filing_date
    نوع: string قالب: date

    فیلتر بر اساس تاریخ دقیق ثبت SEC به قالب YYYY-MM-DD. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند.

  • filing_date_gt
    نوع: string قالب: date

    فیلتر بر اساس تاریخ ثبت SEC بزرگ‌تر از تاریخ به قالب YYYY-MM-DD. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند.

  • filing_date_gte
    نوع: string قالب: date

    فیلتر بر اساس تاریخ ثبت SEC بزرگ‌تر یا مساوی تاریخ به قالب YYYY-MM-DD. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند.

  • filing_date_lt
    نوع: string قالب: date

    فیلتر بر اساس تاریخ ثبت SEC کوچک‌تر از تاریخ به قالب YYYY-MM-DD. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند.

  • filing_date_lte
    نوع: string قالب: date

    فیلتر بر اساس تاریخ ثبت SEC کوچک‌تر یا مساوی تاریخ به قالب YYYY-MM-DD. برای کوئری‌های point-in-time مفید است: فقط داده‌هایی را برمی‌گرداند که تا تاریخ داده‌شده به‌صورت عمومی ثبت شده‌اند. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند.

  • limit
    نوع: integer قالب: int32

    حداکثر تعداد صورت‌های مالی برای بازگرداندن. این مجموع در همه صفحه‌هاست، نه اندازه صفحه: هر صفحه تا 10 رکورد دارد که با next_page_url به هم مرتبط‌اند.

  • period
    نوع: string فهرست مقادیر
    الزامی

    دوره زمانی صورت‌های مالی.

    مقادیر
    • annual
    • quarterly
    • ttm
  • report_period
    نوع: string قالب: date

    فیلتر بر اساس تاریخ دقیق دوره گزارش به قالب YYYY-MM-DD.

  • report_period_gt
    نوع: string قالب: date

    فیلتر بر اساس دوره گزارش بزرگ‌تر از تاریخ در قالب YYYY-MM-DD.

  • report_period_gte
    نوع: string قالب: date

    فیلتر بر اساس دوره گزارش بزرگ‌تر یا مساوی تاریخ در قالب YYYY-MM-DD.

  • report_period_lt
    نوع: string قالب: date

    فیلتر بر اساس دوره گزارش کوچک‌تر از تاریخ در قالب YYYY-MM-DD.

  • report_period_lte
    نوع: string قالب: date

    فیلتر بر اساس دوره گزارش کوچک‌تر یا مساوی تاریخ در قالب YYYY-MM-DD.

  • ticker
    نوع: string

    نماد تیکر. اگر cik ارائه نشود الزامی است.

پاسخ‌ها
  • 200
    نوع: object · ResponseE40Feb4D3D6B_FinancialsResponse

    پاسخ صورت‌های مالی

    • financials
      نوع: object
      • balance_sheets
        نوع: array object[] · ResponseE40Feb4D3D6B_BalanceSheet[]
        • accession_number
          نوع: string | null

          شماره الحاق SEC اظهارنامه.

        • accumulated_other_comprehensive_income
          نوع: number

          سود جامع سایر انباشته شرکت.

        • cash_and_equivalents
          نوع: number

          نقد و معادل نقد شرکت.

        • currency
          نوع: string

          واحد پولی که داده‌های مالی به آن گزارش می‌شوند.

        • current_assets
          نوع: number

          دارایی‌های جاری شرکت.

        • current_debt
          نوع: number

          بدهی جاری شرکت.

        • current_investments
          نوع: number

          سرمایه‌گذاری‌های جاری شرکت.

        • current_liabilities
          نوع: number

          بدهی‌های جاری شرکت.

        • deferred_revenue
          نوع: number

          درآمد معوق شرکت.

        • deposit_liabilities
          نوع: number

          بدهی‌های سپرده شرکت.

        • filing_date
          نوع: string | null قالب: date

          روز تقویمی که SEC اظهارنامه را پذیرفت، به وقت شرقی (منطقه زمانی عملیاتی SEC). جفت روز تقویمی با filing_datetime. Null وقتی هیچ اظهارنامه SEC تاریخ‌دار به ردیف مرتبط نیست.

        • filing_datetime
          نوع: string | null قالب: date-time

          مهر زمانی زیرروزانه که زمان پذیرش اظهارنامه توسط SEC را ثبت می‌کند، به وقت شرقی. برگرفته از فیلد acceptanceDateTime در EDGAR submissions API مربوط به SEC. همراه با filing_date (دقت روز تقویمی برای همان رویداد).

        • filing_url
          نوع: string | null قالب: uri

          نشانی URL اظهارنامه SEC.

        • fiscal_period
          نوع: string

          دوره مالی ترازنامه.

        • form_type
          نوع: string | null

          فرم SEC که این ردیف از آن گرفته شده است (10-K، 10-Q/A، 20-F، S-1، ...). فرم دقیق همان‌گونه که ثبت شده، بنابراین اصلاحیه‌ها پسوند /A خود را حفظ می‌کنند. Null وقتی period برابر ttm است: پنجره دوازده ماهه متحرک می‌تواند چند اظهارنامه را در بر بگیرد، پس آن را به یک اظهارنامه نسبت نمی‌دهیم. یک ردیف quarterly می‌تواند 10-K داشته باشد وقتی سه‌ماهه چهارم از اظهارنامه سال مالی استخراج می‌شود.

        • goodwill_and_intangible_assets
          نوع: number

          سرقفلی و دارایی‌های نامشهود شرکت.

        • inventory
          نوع: number

          موجودی شرکت.

        • investments
          نوع: number

          سرمایه‌گذاری‌های شرکت.

        • non_current_assets
          نوع: number

          دارایی‌های غیرجاری شرکت.

        • non_current_debt
          نوع: number

          بدهی غیرجاری شرکت.

        • non_current_investments
          نوع: number

          سرمایه‌گذاری‌های غیرجاری شرکت.

        • non_current_liabilities
          نوع: number

          بدهی‌های غیرجاری شرکت.

        • outstanding_shares
          نوع: number

          سهام در گردش شرکت.

        • period
          نوع: string فهرست مقادیر

          بازه زمانی ترازنامه.

          مقادیر
          • quarterly
          • ttm
          • annual
        • property_plant_and_equipment
          نوع: number

          املاک، تأسیسات و تجهیزات شرکت.

        • report_period
          نوع: string قالب: date

          دوره گزارش ترازنامه.

        • retained_earnings
          نوع: number

          سود انباشته شرکت.

        • shareholders_equity
          نوع: number

          حقوق صاحبان سهام شرکت.

        • tax_assets
          نوع: number

          دارایی‌های مالیاتی شرکت.

        • tax_liabilities
          نوع: number

          بدهی‌های مالیاتی شرکت.

        • ticker
          نوع: string

          نماد تیکر.

        • total_assets
          نوع: number

          کل دارایی‌های شرکت.

        • total_debt
          نوع: number

          کل بدهی شرکت.

        • total_liabilities
          نوع: number

          کل بدهی‌های شرکت.

        • trade_and_non_trade_payables
          نوع: number

          حساب‌های پرداختنی تجاری و غیرتجاری شرکت.

        • trade_and_non_trade_receivables
          نوع: number

          حساب‌های دریافتنی تجاری و غیرتجاری شرکت.

      • cash_flow_statements
        نوع: array object[] · ResponseE40Feb4D3D6B_CashFlowStatement[]
        • accession_number
          نوع: string | null

          شماره الحاق SEC اظهارنامه.

        • business_acquisitions_and_disposals
          نوع: number

          تحصیل و واگذاری کسب‌وکارهای شرکت.

        • capital_expenditure
          نوع: number

          هزینه سرمایه‌ای شرکت.

        • change_in_cash_and_equivalents
          نوع: number

          تغییر در نقد و معادل نقد شرکت.

        • currency
          نوع: string

          واحد پولی که داده‌های مالی به آن گزارش می‌شوند.

        • depreciation_and_amortization
          نوع: number

          استهلاک و مستهلک‌سازی شرکت.

        • dividends_and_other_cash_distributions
          نوع: number

          سود سهام و سایر توزیع‌های نقدی شرکت.

        • effect_of_exchange_rate_changes
          نوع: number

          اثر تغییرات نرخ ارز شرکت.

        • ending_cash_balance
          نوع: number

          مانده نقد پایان دوره شرکت.

        • filing_date
          نوع: string | null قالب: date

          روز تقویمی که SEC اظهارنامه را پذیرفت، به وقت شرقی (منطقه زمانی عملیاتی SEC). جفت روز تقویمی با filing_datetime. Null وقتی هیچ اظهارنامه SEC تاریخ‌دار به ردیف مرتبط نیست.

        • filing_datetime
          نوع: string | null قالب: date-time

          مهر زمانی زیرروزانه که زمان پذیرش اظهارنامه توسط SEC را ثبت می‌کند، به وقت شرقی. برگرفته از فیلد acceptanceDateTime در EDGAR submissions API مربوط به SEC. همراه با filing_date (دقت روز تقویمی برای همان رویداد).

        • filing_url
          نوع: string | null قالب: uri

          نشانی URL اظهارنامه SEC.

        • fiscal_period
          نوع: string

          دوره مالی صورت جریان نقدی.

        • form_type
          نوع: string | null

          فرم SEC که این ردیف از آن گرفته شده است (10-K، 10-Q/A، 20-F، S-1، ...). فرم دقیق همان‌گونه که ثبت شده، بنابراین اصلاحیه‌ها پسوند /A خود را حفظ می‌کنند. Null وقتی period برابر ttm است: پنجره دوازده ماهه متحرک می‌تواند چند اظهارنامه را در بر بگیرد، پس آن را به یک اظهارنامه نسبت نمی‌دهیم. یک ردیف quarterly می‌تواند 10-K داشته باشد وقتی سه‌ماهه چهارم از اظهارنامه سال مالی استخراج می‌شود.

        • free_cash_flow
          نوع: number

          جریان نقدی آزاد شرکت.

        • investment_acquisitions_and_disposals
          نوع: number

          تحصیل و واگذاری سرمایه‌گذاری‌های شرکت.

        • issuance_or_purchase_of_equity_shares
          نوع: number

          انتشار یا خرید سهام سرمایه شرکت.

        • issuance_or_repayment_of_debt_securities
          نوع: number

          انتشار یا بازپرداخت اوراق بدهی شرکت.

        • net_cash_flow_from_financing
          نوع: number

          جریان نقدی خالص از تأمین مالی شرکت.

        • net_cash_flow_from_investing
          نوع: number

          جریان نقدی خالص از سرمایه‌گذاری شرکت.

        • net_cash_flow_from_operations
          نوع: number

          جریان نقدی خالص از عملیات شرکت.

        • net_income
          نوع: number

          سود خالص شرکت.

        • period
          نوع: string فهرست مقادیر

          بازه زمانی صورت جریان نقدی.

          مقادیر
          • quarterly
          • ttm
          • annual
        • report_period
          نوع: string قالب: date

          دوره گزارش صورت جریان نقدی.

        • share_based_compensation
          نوع: number

          پاداش مبتنی بر سهام شرکت.

        • ticker
          نوع: string

          نماد تیکر.

      • income_statements
        نوع: array object[] · ResponseE40Feb4D3D6B_IncomeStatement[]
        • accession_number
          نوع: string | null

          شماره الحاق SEC اظهارنامه.

        • consolidated_income
          نوع: number

          درآمد تلفیقی شرکت.

        • cost_of_revenue
          نوع: number

          بهای درآمد شرکت.

        • currency
          نوع: string

          واحد پولی که داده‌های مالی به آن گزارش می‌شوند.

        • dividends_per_common_share
          نوع: number

          سود سهام به ازای هر سهم عادی شرکت.

        • earnings_per_share
          نوع: number

          سود هر سهم شرکت.

        • earnings_per_share_diluted
          نوع: number

          سود رقیق‌شده هر سهم شرکت.

        • ebit
          نوع: number

          سود قبل از بهره و مالیات شرکت.

        • filing_date
          نوع: string | null قالب: date

          روز تقویمی که SEC اظهارنامه را پذیرفت، به وقت شرقی (منطقه زمانی عملیاتی SEC). جفت روز تقویمی با filing_datetime. Null وقتی هیچ اظهارنامه SEC تاریخ‌دار به ردیف مرتبط نیست.

        • filing_datetime
          نوع: string | null قالب: date-time

          مهر زمانی زیرروزانه که زمان پذیرش اظهارنامه توسط SEC را ثبت می‌کند، به وقت شرقی. برگرفته از فیلد acceptanceDateTime در EDGAR submissions API مربوط به SEC. همراه با filing_date (دقت روز تقویمی برای همان رویداد).

        • filing_url
          نوع: string | null قالب: uri

          نشانی URL اظهارنامه SEC.

        • fiscal_period
          نوع: string

          دوره مالی صورت سود و زیان.

        • form_type
          نوع: string | null

          فرم SEC که این ردیف از آن گرفته شده است (10-K، 10-Q/A، 20-F، S-1، ...). فرم دقیق همان‌گونه که ثبت شده، بنابراین اصلاحیه‌ها پسوند /A خود را حفظ می‌کنند. Null وقتی period برابر ttm است: پنجره دوازده ماهه متحرک می‌تواند چند اظهارنامه را در بر بگیرد، پس آن را به یک اظهارنامه نسبت نمی‌دهیم. یک ردیف quarterly می‌تواند 10-K داشته باشد وقتی سه‌ماهه چهارم از اظهارنامه سال مالی استخراج می‌شود.

        • gross_profit
          نوع: number

          سود ناخالص شرکت.

        • income_tax_expense
          نوع: number

          هزینه‌های مالیات بر درآمد شرکت.

        • interest_expense
          نوع: number

          هزینه‌های بهره شرکت.

        • net_income
          نوع: number

          سود خالص شرکت.

        • net_income_common_stock
          نوع: number

          سود خالص قابل تخصیص به سهامداران عادی شرکت.

        • net_income_discontinued_operations
          نوع: number

          سود خالص از عملیات متوقف‌شده شرکت.

        • net_income_non_controlling_interests
          نوع: number

          سود خالص از منافع غیرکنترلی شرکت.

        • operating_expense
          نوع: number

          هزینه‌های عملیاتی شرکت.

        • operating_income
          نوع: number

          درآمد عملیاتی شرکت.

        • period
          نوع: string فهرست مقادیر

          بازه زمانی صورت سود و زیان.

          مقادیر
          • quarterly
          • ttm
          • annual
        • preferred_dividends_impact
          نوع: number

          اثر سود سهام ممتاز بر سود خالص شرکت.

        • report_period
          نوع: string قالب: date

          دوره گزارش صورت سود و زیان.

        • research_and_development
          نوع: number

          هزینه‌های تحقیق و توسعه شرکت.

        • revenue
          نوع: number

          کل درآمد شرکت.

        • selling_general_and_administrative_expenses
          نوع: number

          هزینه‌های فروش، عمومی و اداری شرکت.

        • ticker
          نوع: string

          نماد تیکر.

        • weighted_average_shares
          نوع: number

          میانگین موزون سهام شرکت.

        • weighted_average_shares_diluted
          نوع: number

          میانگین موزون رقیق‌شده سهام شرکت.

    • next_page_url
      نوع: string

      نشانی URL مطلق صفحه بعدی نتایج. فقط زمانی وجود دارد که نتایج بیشتری باقی مانده باشد؛ برای ادامه آن را همان‌گونه که هست درخواست کنید. هر صفحه تا 10 رکورد نگه می‌دارد.

    application/json
  • 400

    درخواست پردازش نشد. پارامترهای درخواست را بررسی کنید.

  • 401

    یک کلید API معتبر Felo لازم است.

  • 402

    درخواست ادامه نمی‌یابد چون یک الزام صورت‌حساب برآورده نشده است.

  • 403

    حساب مجاز به انجام این عملیات نیست.

  • 429

    به سقف درخواست یا هزینه رسیده‌اید.

  • 502

    سرویس نتوانست درخواست را کامل کند.

  • 503

    سرویس API یا صورت‌حساب موقتاً در دسترس نیست.

  • 504

    سرویس هنگام پردازش درخواست به پایان مهلت رسید.

  • default

    پاسخ خطا؛ پاسخ‌های عبوری بالادست ممکن است از قالب‌های ارائه‌دهنده استفاده کنند

    application/json
Request Example for get/v1/beta/financial/financials
curl 'https://openapi.felo.ai/v1/beta/financial/financials?period=annual' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "financials": {
    "income_statements": [
      {
        "ticker": "string",
        "report_period": "2026-10-26",
        "fiscal_period": "string",
        "period": "quarterly",
        "currency": "string",
        "accession_number": null,
        "form_type": null,
        "filing_url": null,
        "filing_date": null,
        "filing_datetime": null,
        "revenue": 1,
        "cost_of_revenue": 1,
        "gross_profit": 1,
        "operating_expense": 1,
        "selling_general_and_administrative_expenses": 1,
        "research_and_development": 1,
        "operating_income": 1,
        "interest_expense": 1,
        "ebit": 1,
        "income_tax_expense": 1,
        "net_income_discontinued_operations": 1,
        "net_income_non_controlling_interests": 1,
        "net_income": 1,
        "net_income_common_stock": 1,
        "preferred_dividends_impact": 1,
        "consolidated_income": 1,
        "earnings_per_share": 1,
        "earnings_per_share_diluted": 1,
        "dividends_per_common_share": 1,
        "weighted_average_shares": 1,
        "weighted_average_shares_diluted": 1
      }
    ],
    "balance_sheets": [
      {
        "ticker": "string",
        "report_period": "2026-10-26",
        "fiscal_period": "string",
        "period": "quarterly",
        "currency": "string",
        "accession_number": null,
        "form_type": null,
        "filing_url": null,
        "filing_date": null,
        "filing_datetime": null,
        "total_assets": 1,
        "current_assets": 1,
        "cash_and_equivalents": 1,
        "inventory": 1,
        "current_investments": 1,
        "trade_and_non_trade_receivables": 1,
        "non_current_assets": 1,
        "property_plant_and_equipment": 1,
        "goodwill_and_intangible_assets": 1,
        "investments": 1,
        "non_current_investments": 1,
        "outstanding_shares": 1,
        "tax_assets": 1,
        "total_liabilities": 1,
        "current_liabilities": 1,
        "current_debt": 1,
        "trade_and_non_trade_payables": 1,
        "deferred_revenue": 1,
        "deposit_liabilities": 1,
        "non_current_liabilities": 1,
        "non_current_debt": 1,
        "tax_liabilities": 1,
        "shareholders_equity": 1,
        "retained_earnings": 1,
        "accumulated_other_comprehensive_income": 1,
        "total_debt": 1
      }
    ],
    "cash_flow_statements": [
      {
        "ticker": "string",
        "report_period": "2026-10-26",
        "fiscal_period": "string",
        "period": "quarterly",
        "currency": "string",
        "accession_number": null,
        "form_type": null,
        "filing_url": null,
        "filing_date": null,
        "filing_datetime": null,
        "net_income": 1,
        "depreciation_and_amortization": 1,
        "share_based_compensation": 1,
        "net_cash_flow_from_operations": 1,
        "capital_expenditure": 1,
        "business_acquisitions_and_disposals": 1,
        "investment_acquisitions_and_disposals": 1,
        "net_cash_flow_from_investing": 1,
        "issuance_or_repayment_of_debt_securities": 1,
        "issuance_or_purchase_of_equity_shares": 1,
        "dividends_and_other_cash_distributions": 1,
        "net_cash_flow_from_financing": 1,
        "change_in_cash_and_equivalents": 1,
        "effect_of_exchange_rate_changes": 1,
        "ending_cash_balance": 1,
        "free_cash_flow": 1
      }
    ]
  },
  "next_page_url": "string"
}
Get all financial statements