GET /api/v1/macro/indicator

Returns macro economic indicators such as CPI, PPI, GDP, and unemployment rate.

Request

GET /api/v1/macro/indicator

Headers

Header	Value
F-API-KEY	Your API key

Query Parameters

Parameter	Type	Required	Filter	Description
indicator_name	string	No	exact	Indicator name
period	string	No	exact	Period (e.g. 2024-01)
source	string	No	exact	Data source
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 period)
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/macro/indicator?indicator_name=CPI&limit=12"

Response

{
  "code": 0,
  "message": "ok",
  "data": [
    {
      "indicator_name": "CPI",
      "period": "2024-12",
      "value": 0.1,
      "unit": "%",
      "source": "stats",
      "updated_at": "2025-01-10T00:00:00Z"
    }
  ],
  "meta": {
    "total": 12,
    "limit": 12,
    "offset": 0,
    "has_more": false
  }
}