中文

API Documentation

Markets and classifications

Build your market dictionary, trading calendar, and classification filters before querying instruments.

Open llm.txt

These endpoints provide the dictionaries and filter dimensions that the rest of the platform depends on. They are usually the first supporting APIs you integrate before building instrument search or market-aware UX.

Market basics

GET/api/v1/markets

List supported markets

listMarkets

This endpoint does not define request parameters.

StatusDescriptionSchema
200Market collectionMarketCollectionResponse
401UnauthorizedErrorResponse

MarketCollectionResponse

FieldTypeRequiredDescription
dataArray<Market>Yes
data[].idMarketIdYes
data[].namestringYes
metaMetaYes
meta.next_cursorstring | nullYes
linksSelfLinksYes
links.selfstringYes
GET/api/v1/markets/{market}

Get one market

getMarket

StatusDescriptionSchema
200Market resourceMarketResponse
401UnauthorizedErrorResponse
404Resource not foundErrorResponse

Trading calendar

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
StatusDescriptionSchema
200Trading day collectionTradingDayCollectionResponse
400Invalid request parametersErrorResponse
401UnauthorizedErrorResponse
404Resource not foundErrorResponse

TradingDayCollectionResponse

FieldTypeRequiredDescription
dataArray<TradingDay>Yes
data[].marketMarketIdYes
data[].datestring (date)Yes
metaMetaYes
meta.next_cursorstring | nullYes
linksSelfLinksYes
links.selfstringYes

Typical uses:

  • validate a requested date before querying market data
  • power trading-day pickers in UI
  • avoid calling time-series endpoints on closed-market dates

Sector and industry classifications

GET/api/v1/classifications/sectors

List sector classifications

listSectors

StatusDescriptionSchema
200Sector collectionClassificationCollectionResponse
401UnauthorizedErrorResponse
GET/api/v1/classifications/primary-industries

List primary industries

listPrimaryIndustries

StatusDescriptionSchema
200Primary industry collectionClassificationCollectionResponse
401UnauthorizedErrorResponse

ClassificationCollectionResponse

FieldTypeRequiredDescription
dataArray<Classification>Yes
data[].idstringYes
data[].namestringYes
data[].typestringYes
metaMetaYes
meta.next_cursorstring | nullYes
linksSelfLinksYes
links.selfstringYes
Initialize sector filtersbash
curl https://heliumlabz.com/api/v1/classifications/sectors \
-H "X-API-Key: $ASHARE_API_KEY"