Market data across contract positions

Frequency counts based on TermScout's market data across contract positons. Without any query parameters, will return total contract counts for each contract position, defaulting to the IT template.

To filter on a specific template or label, include a template-id, label-id and selected. Set selected to 1 for frequency counts where the given label is true. Set selected to 0 for frequency counts where the label is not true.

To construct frequency percentages for a given label, first call the endpoint with no label-id to get the denominator. Then call the endpoint with label-id and selected included to get the numerator. Then you can divide the numerator by the denominator for each contract position returned.

get/contract-positions

Request

Query parameters

template-idstring required

ID of template to fetch counts for

label-idstring

ID of label to fetch counts for

selectedstring

Set to 1 for counts where label is true, 0 for counts where label is false

Response

200 response

idnumber

ID of the given contract position

namestring

Name of the given contract position

quantitystring

Number of contracts that meet that meet the criteria defined by the input query parameters

Changes

No recorded changes to this operation across all 1 revision of this API.