GET /api/v1/us/financial-metrics

Returns pre-calculated financial metrics for US public companies.

Request

GET /api/v1/us/financial-metrics

Headers

Header	Value
F-API-KEY	Your API key

Query Parameters

Parameter	Type	Required	Filter	Description
cik	string	No	exact	SEC CIK
ticker	string	No	exact	Stock ticker
metric_name	string	No	exact	Metric name
fiscal_year	string	No	exact	Fiscal year
fiscal_period	string	No	exact	Fiscal period
limit	integer	No	—	Max rows per page (default 100, max 1000)
offset	integer	No	—	Rows to skip (default 0)
sort	string	No	—	Sort field (default fiscal_year)
order	asc | desc	No	—	Sort direction (default desc)

Example

curl -H "F-API-KEY: fk-xxxxx" \
  "https://finance-api.xp-java.workers.dev/api/v1/us/financial-metrics?ticker=AAPL&metric_name=ROE&limit=10"

Response

{
  "code": 0,
  "message": "ok",
  "data": [
    {
      "cik": "0000320193",
      "ticker": "AAPL",
      "fiscal_year": "2024",
      "fiscal_period": "FY",
      "metric_name": "ROE",
      "metric_value": 1.609,
      "unit": "ratio",
      "calculation_method": "net_income / avg_shareholders_equity",
      "source": "calculated",
      "updated_at": "2024-11-01T00:00:00Z"
    }
  ],
  "meta": {
    "total": 10,
    "limit": 10,
    "offset": 0,
    "has_more": false
  }
}