GET /api/v1/market/hsgt-flow

Returns northbound and southbound flow data for the Shanghai/Shenzhen-Hong Kong Stock Connect.

Request

GET /api/v1/market/hsgt-flow

Headers

Header	Value
F-API-KEY	Your API key

Query Parameters

Parameter	Type	Required	Filter	Description
direction	string	No	exact	Flow direction (northbound, southbound)
trade_date	string	No	exact	Trade date (YYYY-MM-DD)
source	string	No	exact	Data source
date_from	string	No	range	Start date
date_to	string	No	range	End date
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 trade_date)
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/market/hsgt-flow?direction=northbound&date_from=2024-01-01&date_to=2024-01-31"

Response

{
  "code": 0,
  "message": "ok",
  "data": [
    {
      "direction": "northbound",
      "trade_date": "2024-01-02",
      "net_inflow": 5200000000,
      "buy_amount": 18500000000,
      "sell_amount": 13300000000,
      "cumulative_inflow": 1850000000000,
      "source": "exchange",
      "updated_at": "2024-01-02T15:30:00Z"
    }
  ],
  "meta": {
    "total": 22,
    "limit": 100,
    "offset": 0,
    "has_more": false
  }
}