Many Axiora endpoints share a common parameter vocabulary: instrument_id, from, to, date, interval, and page_size. Learn that vocabulary once and the rest of the API becomes much more predictable.
Path vs query parameters
/api/v1/markets/{market}/trading-daysList trading days for one market
listTradingDays
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| market | path | MarketId | Yes | — |
| from | query | string (date) | No | — |
| to | query | string (date) | No | — |
| page[size] | query | integer (default 100) | No | — |
- Path parameters identify a resource such as
market,instrument_id, orindicator - Query parameters filter the result set, constrain time windows, or control size
- Reused parameter names keep the same meaning across endpoints
Time and date ranges
/api/v1/equities/{instrument_id}/barsList equity bars
listEquityBars
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| instrument_id | path | string | Yes | — |
| interval | query | IntervalId | Yes | — |
| adjustment | query | AdjustmentId | No | — |
| from | query | string (date-time) | No | — |
| to | query | string (date-time) | No | — |
| date | query | string (date) | No | — |
| page[size] | query | integer (default 100) | No | — |
Time parameters are usually one of two forms:
- Date for trading days, reporting periods, and day-level windows
- Datetime for intraday points, trades, and more granular market data
Recommended practice:
- Start with a short range while integrating
- Expand the window once parsing works
- Specify
interval,from, andtoexplicitly for larger pulls
curl "https://heliumlabz.com/api/v1/equities/000001.SZ/bars?interval=1d&from=2026-01-01&to=2026-03-01" \
-H "X-API-Key: $ASHARE_API_KEY"Pagination and result size
Collection endpoints commonly include meta and links, which means you should not assume a single request always returns the full result set.
Meta
| Field | Type | Required | Description |
|---|---|---|---|
| next_cursor | string | null | Yes | — |
SelfLinks
| Field | Type | Required | Description |
|---|---|---|---|
| self | string | Yes | — |
Recommended practice
Treat page_size as a stability and throughput control rather than maximizing it blindly. For long time ranges, use pagination or split the query window into smaller chunks.