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 عملیات

دریافت معیارهای مالی

​

نسبت‌های محاسبه‌شده برای یک شرکت در طول زمان، حدود 49 در هر دوره: market_cap، enterprise_value، price_to_earnings_ratio، price_to_book_ratio، price_to_sales_ratio، enterprise_value_to_ebitda_ratio، free_cash_flow_yield، peg_ratio، gross_margin، operating_margin، net_margin، return_on_equity، return_on_assets، return_on_invested_capital، نسبت‌های گردش و نقدینگی، هر یک با report_period و fiscal_period مهر شده. period الزامی است؛ با ticker یا cik شناسایی کنید. از آن برای روند یک نسبت در دوره‌ها استفاده کنید. فقط برای مقادیر فعلی، get_financial_financial_metrics_snapshot یک ردیف و بسیار کوچک‌تر است.

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

  • اندازه‌گیری: مبنای هزینه ثابت برای درخواست موفق.
  • برآورد درخواست مرجع: 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

    حداکثر تعداد نتایج برای بازگرداندن. این مجموع در همه صفحه‌هاست، نه اندازه صفحه: هر صفحه تا 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_FinancialMetricsResponse

    معیارها و نسبت‌های مالی تاریخی یک ticker

    • accession_number
      نوع: string | null

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

    • asset_turnover
      نوع: number

      درآمد تقسیم بر میانگین کل دارایی‌ها.

    • book_value_growth
      نوع: number

      رشد سال‌به‌سال ارزش دفتری.

    • book_value_per_share
      نوع: number

      حقوق صاحبان سهام تقسیم بر سهام در گردش.

    • cash_ratio
      نوع: number

      نقد و معادل نقد تقسیم بر بدهی‌های جاری.

    • currency
      نوع: string

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

    • current_ratio
      نوع: number

      دارایی‌های جاری تقسیم بر بدهی‌های جاری.

    • days_sales_outstanding
      نوع: number

      میانگین حساب‌های دریافتنی تقسیم بر درآمد در طول دوره.

    • debt_to_assets
      نوع: number

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

    • debt_to_equity
      نوع: number

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

    • earnings_growth
      نوع: number

      رشد سال‌به‌سال سود.

    • earnings_per_share
      نوع: number

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

    • earnings_per_share_growth
      نوع: number

      رشد سود هر سهم در طول دوره.

    • ebitda_growth
      نوع: number

      رشد EBITDA در طول دوره.

    • enterprise_value
      نوع: number

      ارزش کل شرکت (ارزش بازار + بدهی - نقد).

    • enterprise_value_to_ebitda_ratio
      نوع: number

      نسبت ارزش شرکت به EBITDA.

    • enterprise_value_to_revenue_ratio
      نوع: 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_growth
      نوع: number

      رشد جریان نقدی آزاد در طول دوره.

    • free_cash_flow_per_share
      نوع: number

      جریان نقدی آزاد تقسیم بر سهام در گردش.

    • free_cash_flow_yield
      نوع: number

      بازده جریان نقدی آزاد.

    • gross_margin
      نوع: number

      سود ناخالص به‌عنوان درصدی از درآمد.

    • interest_coverage
      نوع: number

      EBIT تقسیم بر هزینه بهره.

    • inventory_turnover
      نوع: number

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

    • net_margin
      نوع: number

      سود خالص به‌عنوان درصدی از درآمد.

    • next_page_url
      نوع: string

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

    • operating_cash_flow_ratio
      نوع: number

      جریان نقدی عملیاتی تقسیم بر بدهی‌های جاری.

    • operating_cycle
      نوع: number

      گردش موجودی + گردش حساب‌های دریافتنی.

    • operating_income_growth
      نوع: number

      رشد درآمد عملیاتی در طول دوره.

    • operating_margin
      نوع: number

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

    • payout_ratio
      نوع: number

      سود سهام پرداختی به‌عنوان درصدی از سود خالص.

    • peg_ratio
      نوع: number

      نسبت قیمت به رشد سود.

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

      بازه زمانی شاخص‌های مالی.

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

      نسبت قیمت به ارزش دفتری.

    • price_to_earnings_ratio
      نوع: number

      نسبت قیمت به سود.

    • price_to_sales_ratio
      نوع: number

      نسبت قیمت به فروش.

    • quick_ratio
      نوع: number

      دارایی‌های سریع تقسیم بر بدهی‌های جاری.

    • receivables_turnover
      نوع: number

      درآمد تقسیم بر میانگین حساب‌های دریافتنی.

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

      دوره گزارش شاخص‌های مالی.

    • return_on_assets
      نوع: number

      سود خالص به‌عنوان درصدی از کل دارایی‌ها.

    • return_on_equity
      نوع: number

      سود خالص به‌عنوان درصدی از حقوق صاحبان سهام.

    • return_on_invested_capital
      نوع: number

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

    • revenue_growth
      نوع: number

      رشد سال‌به‌سال درآمد.

    • ticker
      نوع: string

      نماد تیکر شرکت.

    • working_capital_turnover
      نوع: number

      درآمد تقسیم بر میانگین سرمایه در گردش.

    application/json
  • 400

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

  • 401

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

  • 402

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

  • 403

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

  • 429

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

  • 502

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

  • 503

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

  • 504

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

  • default

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

    application/json
Request Example for get/v1/beta/financial/financial-metrics
curl 'https://openapi.felo.ai/v1/beta/financial/financial-metrics?period=annual' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "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,
  "enterprise_value": 1,
  "price_to_earnings_ratio": 1,
  "price_to_book_ratio": 1,
  "price_to_sales_ratio": 1,
  "enterprise_value_to_ebitda_ratio": 1,
  "enterprise_value_to_revenue_ratio": 1,
  "free_cash_flow_yield": 1,
  "peg_ratio": 1,
  "gross_margin": 1,
  "operating_margin": 1,
  "net_margin": 1,
  "return_on_equity": 1,
  "return_on_assets": 1,
  "return_on_invested_capital": 1,
  "asset_turnover": 1,
  "inventory_turnover": 1,
  "receivables_turnover": 1,
  "days_sales_outstanding": 1,
  "operating_cycle": 1,
  "working_capital_turnover": 1,
  "current_ratio": 1,
  "quick_ratio": 1,
  "cash_ratio": 1,
  "operating_cash_flow_ratio": 1,
  "debt_to_equity": 1,
  "debt_to_assets": 1,
  "interest_coverage": 1,
  "revenue_growth": 1,
  "earnings_growth": 1,
  "book_value_growth": 1,
  "earnings_per_share_growth": 1,
  "free_cash_flow_growth": 1,
  "operating_income_growth": 1,
  "ebitda_growth": 1,
  "payout_ratio": 1,
  "earnings_per_share": 1,
  "book_value_per_share": 1,
  "free_cash_flow_per_share": 1,
  "next_page_url": "string"
}
Get financial metrics