Skip to main content
POST
Retrieve stock observations across a date range.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

The query payload. Identifiers must be non-empty; supply inclusive date-only StartDate and EndDate bounds plus optional provider or environment scope.

Queries dated stock-market observations by equity selector and date range.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetStockDataRequest, Derivitec.Web.Core
market_data_environment_name
string | null

Name of the market-data environment to use. Supply either this name or provider_id, not both.

Example:

"Example market data"

provider_id
string | null

Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.

identifiers
object[] | null

Equity selectors whose stock observations are requested.

Instrument code qualified by an identifier namespace and optional market code.

start_date
string<date-time>

Inclusive lower date-only boundary for the requested observations.

end_date
string<date-time>

Inclusive upper date-only boundary for the requested observations.

Response

Returns available stock observations keyed by input identifier, together with unsupported-identifier, missing-data, or retrieval errors.

Returns dated stock-market observations.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetStockDataResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

stock_data
object[] | null

Stock-market observations returned by the query.