中文

API Documentation

Request conventions

Understand path params, time ranges, intervals, and pagination before reading individual endpoints.

Open llm.txt

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

GET/api/v1/markets/{market}/trading-days

List trading days for one market

listTradingDays

NameInTypeRequiredDescription
marketpathMarketIdYes
fromquerystring (date)No
toquerystring (date)No
page[size]queryinteger (default 100)No
  • Path parameters identify a resource such as market, instrument_id, or indicator
  • 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

GET/api/v1/equities/{instrument_id}/bars

List equity bars

listEquityBars

NameInTypeRequiredDescription
instrument_idpathstringYes
intervalqueryIntervalIdYes
adjustmentqueryAdjustmentIdNo
fromquerystring (date-time)No
toquerystring (date-time)No
datequerystring (date)No
page[size]queryinteger (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:

  1. Start with a short range while integrating
  2. Expand the window once parsing works
  3. Specify interval, from, and to explicitly for larger pulls
curlbash
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

FieldTypeRequiredDescription
next_cursorstring | nullYes

SelfLinks

FieldTypeRequiredDescription
selfstringYes

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.