Skip to content

Macro & Market Endpoints

Query endpoints for macro indicators and market-wide data.

GET /api/v1/macro/indicator

Macro economic indicators.

Query Parameters:

ParameterTypeFilter TypeDescription
indicator_namestringexactIndicator name
periodstringexactPeriod (e.g. 2024-01)
sourcestringexactData source
date_fromstringdate rangeStart date
date_tostringdate rangeEnd date

Example:

Terminal window
curl -H "F-API-KEY: fk-xxxxx" \
"https://finance-api.xp-java.workers.dev/api/v1/macro/indicator?indicator_name=CPI&limit=12"

GET /api/v1/market/margin-trading

Margin trading balance and flows by market.

Query Parameters:

ParameterTypeFilter TypeDescription
marketstringexactMarket identifier
trade_datestringexactTrade date
sourcestringexactData source
date_fromstringdate rangeStart date
date_tostringdate rangeEnd date

GET /api/v1/market/hsgt-flow

Shanghai/Shenzhen-Hong Kong Stock Connect flows.

Query Parameters:

ParameterTypeFilter TypeDescription
directionstringexactFlow direction (northbound, southbound)
trade_datestringexactTrade date
sourcestringexactData source
date_fromstringdate rangeStart date
date_tostringdate rangeEnd date