中文

API Documentation

Equities

Equity endpoints cover instrument discovery, quotes, bars, company profiles, and deeper financial or shareholder datasets.

Open llm.txt

Equities are the richest domain in the current API. The most practical way to integrate is to start with the instrument directory and price endpoints, then layer in company and fundamental data only when your product actually needs them.

Instrument directory

GET/api/v1/equities

List equities

listEquities

NameInTypeRequiredDescription
marketqueryMarketIdNo
boardqueryBoardIdNo
codequerystringNo
namequerystringNo
page[size]queryinteger (default 100)No
StatusDescriptionSchema
200Equity collectionInstrumentCollectionResponse
400Invalid request parametersErrorResponse
401UnauthorizedErrorResponse

InstrumentCollectionResponse

FieldTypeRequiredDescription
dataArray<Instrument>Yes
data[].idstringYes
data[].codestringYes
data[].exchangeMarketIdYes
data[].marketstringYes
data[].asset_classequity | index | fundYes
data[].boardstringYes
data[].namestringYes
metaMetaYes
meta.next_cursorstring | nullYes
linksSelfLinksYes
links.selfstringYes
GET/api/v1/equities/{instrument_id}

Get one equity

getEquity

StatusDescriptionSchema
200Equity resourceInstrumentResponse
401UnauthorizedErrorResponse
404Resource not foundErrorResponse

Quotes and bars

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

List equity quotes

listEquityQuotes

NameInTypeRequiredDescription
instrument_idpathstringYes
fromquerystring (date-time)No
toquerystring (date-time)No
datequerystring (date)No
page[size]queryinteger (default 100)No
StatusDescriptionSchema
200Quote collectionQuoteCollectionResponse
400Invalid request parametersErrorResponse
401UnauthorizedErrorResponse

QuoteCollectionResponse

FieldTypeRequiredDescription
dataArray<Quote>Yes
data[].instrument_idstringYes
data[].marketstringYes
data[].asset_classstringYes
data[].timestampstring (date-time)Yes
data[].pricestring | nullNo
data[].openstring | nullNo
data[].highstring | nullNo
data[].lowstring | nullNo
data[].previous_closestring | nullNo
data[].amountstring | nullNo
data[].volumestring | nullNo
data[].changestring | nullNo
data[].change_percentstring | nullNo
metaMetaYes
meta.next_cursorstring | nullYes
linksSelfLinksYes
links.selfstringYes
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
StatusDescriptionSchema
200Bar collectionBarCollectionResponse
400Invalid request parametersErrorResponse
401UnauthorizedErrorResponse

BarCollectionResponse

FieldTypeRequiredDescription
dataArray<Bar>Yes
data[].instrument_idstringYes
data[].marketstringYes
data[].asset_classstringYes
data[].intervalIntervalIdYes
data[].adjustmentAdjustmentIdYes
data[].timestampstring (date-time)Yes
data[].trade_datestring (date)Yes
data[].openstringYes
data[].highstringYes
data[].lowstringYes
data[].closestringYes
data[].volumestringYes
data[].amountstringYes
data[].previous_closestring | nullNo
metaMetaYes
meta.next_cursorstring | nullYes
linksSelfLinksYes
links.selfstringYes
Fetch daily barsbash
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"

Company and fundamentals

GET/api/v1/equities/{instrument_id}/company-profile

Get company profile

getCompanyProfile

StatusDescriptionSchema
200Company profile resourceCompanyProfileResponse
401UnauthorizedErrorResponse
404Resource not foundErrorResponse

CompanyProfileResponse

FieldTypeRequiredDescription
dataCompanyProfileYes
data.instrument_idstringYes
data.namestring | nullNo
data.market_namestring | nullNo
data.listed_datestring | null (date)No
data.principalstring | nullNo
data.organization_typestring | nullNo
data.phonestring | nullNo
data.emailstring | nullNo
data.ipo_datestring | null (date)No
data.previous_closestring | nullNo
data.upper_limit_pricestring | nullNo
data.lower_limit_pricestring | nullNo
data.face_valuestring | nullNo
data.total_valuestring | nullNo
data.price_tickstring | nullNo
data.is_suspendedboolean | nullNo
linksSelfLinksYes
links.selfstringYes
GET/api/v1/equities/{instrument_id}/financial-statements/balance-sheets

List balance sheets

listBalanceSheets

StatusDescriptionSchema
200Balance sheet collectionBalanceSheetCollectionResponse
400Invalid request parametersErrorResponse
401UnauthorizedErrorResponse
GET/api/v1/equities/{instrument_id}/financial-indicators

List financial indicators

listFinancialIndicators

StatusDescriptionSchema
200Financial indicator collectionFinancialIndicatorCollectionResponse
400Invalid request parametersErrorResponse
401UnauthorizedErrorResponse

Extended coverage

The equity domain also includes:

  • trades via listEquityTrades
  • technical indicators via listEquityTechnicalIndicators
  • capital flow via listCapitalFlows
  • price limits via listPriceLimits
  • dividends and earnings forecasts
  • management history, share capital history, shareholder counts, and institutional holdings
  • pool types and pool constituents

Practical integration order

For market views, watchlists, or backtests, listEquities + listEquityQuotes + listEquityBars are usually enough to start. Add profile and fundamental endpoints only when you need richer company context.