v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Stock

Historical auctions

The historical auctions endpoint provides auction prices for a list of stock symbols between the specified dates.

get/v2/stocks/auctions

Query parameters

symbolsstring required

A comma-separated list of stock symbols.

startstring date-time

The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the beginning of the current day, but at least 15 minutes ago if the user doesn't have real-time access for the feed.

endstring date-time

The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the current time if the user has a real-time access for the feed, otherwise 15 minutes before the current time.

limitinteger

The maximum number of data points to return in the response page. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol!

asofstring

The as-of date of the queried stock symbol(s). Format: YYYY-MM-DD. Default: current day.

This date is used to identify the underlying entity of the provided symbol(s), so that name changes for this entity can be found. Data for past symbol(s) is returned if the query date range spans the name change.

The special value of "-" means symbol mapping is skipped. Data is returned based on the symbol alone without looking up previous names. The same happens if the queried symbol is not found on the given asof date.

Example: FB was renamed to META in 2022-06-09. Querying META with an asof date after 2022-06-09 will also yield FB data. The data for the FB ticker will be labeled as META because they are considered the same underlying entity as of 2022-06-09. Querying FB with an asof date after 2022-06-09 will only return data with the FB ticker, not with META. But with an asof date before 2022-06-09, META will also be returned (as FB).

feedstring

Only sip is valid for auctions.

currencystring

The currency of all prices in ISO 4217 format. Default: USD.

page_tokenstring

The pagination token from which to continue. The value to pass here is returned in specific requests when more data is available, usually because of a response result limit.

sort'asc' | 'desc'

Sort data in ascending or descending order.

Sort data in ascending or descending order.

Response

OK

auctionsobject required
currencystring
next_page_tokenstring nullable required

Pagination token for the next page.