Skip to main content
GET
Retrieve a concise tradable overview.

Authorizations

Authorization
string
header
required

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

Query Parameters

tradableId
string

Required non-blank platform tradable identifier supplied as a query parameter. This endpoint does not use a route parameter or request body.

Response

Returns the brief or an unsuccessful payload with lookup errors.

Response envelope for a human-readable brief of the selected tradable.

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

brief
string | null

Generated text describing the selected tradable when the request succeeds.