Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Get financial metrics

伺服器:https://openapi.felo.ai
用戶端程式庫

Financial Data

​

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

Get financial metrics

​

Computed ratios for one company over time, about 49 per period: 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, the turnover and liquidity ratios, each stamped with report_period and fiscal_period. period is required; identify by ticker or cik. Use it to trend a ratio across periods. For the current values only, get_financial_financial_metrics_snapshot is one row and much smaller.

查詢參數
  • ticker
    類型: string

    The ticker symbol of the company. Required if cik is not provided.

  • cik
    類型: string

    The Central Index Key (CIK) of the company. Can be used instead of ticker.

  • period
    類型: string 列舉
    必填

    The time period for the financial data.

    值
    • annual
    • quarterly
    • ttm
  • limit
    類型: integer

    The maximum number of results to return.

  • report_period
    類型: string 格式: date

    Filter by exact report period date in YYYY-MM-DD format.

  • report_period_gte
    類型: string 格式: date

    Filter by report period greater than or equal to date in YYYY-MM-DD format.

  • report_period_lte
    類型: string 格式: date

    Filter by report period less than or equal to date in YYYY-MM-DD format.

  • report_period_gt
    類型: string 格式: date

    Filter by report period greater than date in YYYY-MM-DD format.

  • report_period_lt
    類型: string 格式: date

    Filter by report period less than date in YYYY-MM-DD format.

回應
  • 200
    類型: object · FinancialMetricsResponse

    The historical financial metrics and ratios for a ticker

    • financial_metrics
      類型: array object[] · FinancialMetric[]

      Historical financial metrics and ratios for the requested ticker.

      • asset_turnover
        類型: number

        Revenue divided by average total assets.

      • book_value_growth
        類型: number

        Year-over-year growth in book value.

      • book_value_per_share
        類型: number

        Shareholders' equity divided by shares outstanding.

      • cash_ratio
        類型: number

        Cash and cash equivalents divided by current liabilities.

      • current_ratio
        類型: number

        Current assets divided by current liabilities.

      • days_sales_outstanding
        類型: number

        Average accounts receivable divided by revenue over the period.

      • debt_to_assets
        類型: number

        Total debt divided by total assets.

      • debt_to_equity
        類型: number

        Total debt divided by shareholders' equity.

      • earnings_growth
        類型: number

        Year-over-year growth in earnings.

      • earnings_per_share
        類型: number

        Net income divided by weighted average shares outstanding.

      • earnings_per_share_growth
        類型: number

        Growth in earnings per share over the period.

      • ebitda_growth
        類型: number

        Growth in EBITDA over the period.

      • enterprise_value
        類型: number

        The total value of the company (market cap + debt - cash).

      • enterprise_value_to_ebitda_ratio
        類型: number

        Enterprise value to EBITDA ratio.

      • enterprise_value_to_revenue_ratio
        類型: number

        Enterprise value to revenue ratio.

      • free_cash_flow_growth
        類型: number

        Growth in free cash flow over the period.

      • free_cash_flow_per_share
        類型: number

        Free cash flow divided by shares outstanding.

      • free_cash_flow_yield
        類型: number

        Free cash flow yield.

      • gross_margin
        類型: number

        Gross profit as a percentage of revenue.

      • interest_coverage
        類型: number

        EBIT divided by interest expense.

      • inventory_turnover
        類型: number

        Cost of goods sold divided by average inventory.

      • market_cap
        類型: number

        The market capitalization of the company.

      • net_margin
        類型: number

        Net income as a percentage of revenue.

      • operating_cash_flow_ratio
        類型: number

        Operating cash flow divided by current liabilities.

      • operating_cycle
        類型: number

        Inventory turnover + receivables turnover.

      • operating_income_growth
        類型: number

        Growth in operating income over the period.

      • operating_margin
        類型: number

        Operating income as a percentage of revenue.

      • payout_ratio
        類型: number

        Dividends paid as a percentage of net income.

      • peg_ratio
        類型: number

        Price to earnings growth ratio.

      • price_to_book_ratio
        類型: number

        Price to book ratio.

      • price_to_earnings_ratio
        類型: number

        Price to earnings ratio.

      • price_to_sales_ratio
        類型: number

        Price to sales ratio.

      • quick_ratio
        類型: number

        Quick assets divided by current liabilities.

      • receivables_turnover
        類型: number

        Revenue divided by average accounts receivable.

      • return_on_assets
        類型: number

        Net income as a percentage of total assets.

      • return_on_equity
        類型: number

        Net income as a percentage of shareholders' equity.

      • return_on_invested_capital
        類型: number

        Net operating profit after taxes as a percentage of invested capital.

      • revenue_growth
        類型: number

        Year-over-year growth in revenue.

      • ticker
        類型: string

        The ticker symbol of the company.

      • working_capital_turnover
        類型: number

        Revenue divided by average working capital.

    application/json
  • 400
    類型: object · ErrorResponse

    Bad request

    • error
      類型: string

      A short error message.

    • message
      類型: string

      A more detailed error message.

    application/json
  • 401
    類型: object · ErrorResponse

    Unauthorized

    • error
      類型: string

      A short error message.

    • message
      類型: string

      A more detailed error message.

    application/json
  • 402
    類型: object · ErrorResponse

    The request requires a paid subscription

    • error
      類型: string

      A short error message.

    • message
      類型: string

      A more detailed error message.

    application/json
  • 403

    The account is not permitted to perform this operation.

  • 404
    類型: object · ErrorResponse

    The specified resource was not found

    • error
      類型: string

      A short error message.

    • message
      類型: string

      A more detailed error message.

    application/json
  • 429

    A request or spending limit has been reached.

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

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'
{
  "financial_metrics": [
    {
      "ticker": "string",
      "market_cap": 1,
      "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
    }
  ]
}
Get financial metrics