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

Financial Metrics Snapshot (Real-Time)

服务器:https://openapi.felo.ai
客户端库

Financial Data

​

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

Financial Metrics Snapshot (Real-Time)

​

The same ratio set as get_financial_financial_metrics but current-only: one snapshot object of about 41 fields — 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, the margin and return ratios, and the liquidity ratios. Takes only ticker or cik, with no period argument. Use it to size up a company right now. For history, or to see whether a multiple is unusual for this company, use get_financial_financial_metrics.

查询参数
  • ticker
    类型: string

    The ticker symbol of the company.

  • cik
    类型: string

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

响应
  • 200
    类型: object · FinancialMetricSnapshotResponse

    Financial metrics snapshot response

    • snapshot
      类型: object · FinancialMetricSnapshot
      • asset_turnover
        类型: number 可为 null

        Revenue divided by average total assets.

      • book_value_growth
        类型: number 可为 null

        Year-over-year growth in book value.

      • book_value_per_share
        类型: number 可为 null

        Shareholders' equity divided by shares outstanding.

      • cash_ratio
        类型: number 可为 null

        Cash and cash equivalents divided by current liabilities.

      • current_ratio
        类型: number 可为 null

        Current assets divided by current liabilities.

      • days_sales_outstanding
        类型: number 可为 null

        Average accounts receivable divided by revenue over the period.

      • debt_to_assets
        类型: number 可为 null

        Total debt divided by total assets.

      • debt_to_equity
        类型: number 可为 null

        Total debt divided by shareholders' equity.

      • earnings_growth
        类型: number 可为 null

        Year-over-year growth in earnings.

      • earnings_per_share
        类型: number 可为 null

        Net income divided by weighted average shares outstanding.

      • earnings_per_share_growth
        类型: number 可为 null

        Growth in earnings per share over the period.

      • ebitda_growth
        类型: number 可为 null

        Growth in EBITDA over the period.

      • enterprise_value
        类型: number 可为 null

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

      • enterprise_value_to_ebitda_ratio
        类型: number 可为 null

        Enterprise value to EBITDA ratio.

      • enterprise_value_to_revenue_ratio
        类型: number 可为 null

        Enterprise value to revenue ratio.

      • free_cash_flow_growth
        类型: number 可为 null

        Growth in free cash flow over the period.

      • free_cash_flow_per_share
        类型: number 可为 null

        Free cash flow divided by shares outstanding.

      • free_cash_flow_yield
        类型: number 可为 null

        Free cash flow yield.

      • gross_margin
        类型: number 可为 null

        Gross profit as a percentage of revenue.

      • interest_coverage
        类型: number 可为 null

        EBIT divided by interest expense.

      • inventory_turnover
        类型: number 可为 null

        Cost of goods sold divided by average inventory.

      • market_cap
        类型: number 可为 null

        The total market capitalization (stock price × shares outstanding).

      • net_margin
        类型: number 可为 null

        Net income as a percentage of revenue.

      • operating_cash_flow_ratio
        类型: number 可为 null

        Operating cash flow divided by current liabilities.

      • operating_cycle
        类型: number 可为 null

        Inventory turnover + receivables turnover.

      • operating_income_growth
        类型: number 可为 null

        Growth in operating income over the period.

      • operating_margin
        类型: number 可为 null

        Operating income as a percentage of revenue.

      • payout_ratio
        类型: number 可为 null

        Dividends paid as a percentage of net income.

      • peg_ratio
        类型: number 可为 null

        Price to earnings growth ratio.

      • price_to_book_ratio
        类型: number 可为 null

        Price to book ratio.

      • price_to_earnings_ratio
        类型: number 可为 null

        Price to earnings ratio.

      • price_to_sales_ratio
        类型: number 可为 null

        Price to sales ratio.

      • quick_ratio
        类型: number 可为 null

        Quick assets divided by current liabilities.

      • receivables_turnover
        类型: number 可为 null

        Revenue divided by average accounts receivable.

      • return_on_assets
        类型: number 可为 null

        Net income as a percentage of total assets.

      • return_on_equity
        类型: number 可为 null

        Net income as a percentage of shareholders' equity.

      • return_on_invested_capital
        类型: number 可为 null

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

      • revenue_growth
        类型: number 可为 null

        Year-over-year growth in revenue.

      • ticker
        类型: string

        The ticker symbol of the company.

      • working_capital_turnover
        类型: number 可为 null

        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/snapshot
curl https://openapi.felo.ai/v1/beta/financial/financial-metrics/snapshot \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "snapshot": {
    "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
  }
}
Financial Metrics Snapshot (Real-Time)