Skip to main content
POST
Retrieve CDS observations by issuer.

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 issuer identifiers in a supported namespace, StartDate and EndDate are date-only inclusive boundaries, and provider or environment fields select the source.

Queries dated CDS observations by issuer selector and date range.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetCdsDataRequest, 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

Issuer selectors whose CDS observations are requested.

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 CDS observations grouped by input issuer identifier and errors for invalid provider scope, unsupported issuers, or missing data.

Returns dated CDS observations for the selected issuers.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetCdsDataResponse, 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.

cds_data
object[] | null

CDS observations returned for the requested issuers.