--- title: "Market data across contract positions" method: GET path: "/contract-positions" --- # Market data across contract positions `GET /contract-positions` ## Request - Base URL: `https://api.termscout.com` - URL: `https://api.termscout.com/contract-positions` - Auth: one of: - API key in header `Authorization` - API key in header `x-api-key` - TypeScript: (a function with typed inputs; its response is checked against the schema) 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. ## Query parameters - `template-id` string, required - `label-id` string - `selected` string ## Response `200` 200 response - ContractPosition[]: Frequency counts for all relevant contract positions - `id` number: ID of the given contract position - `name` string: Name of the given contract position - `quantity` string: Number of contracts that meet that meet the criteria defined by the input query parameters --- [API](https://skmtc.dev/termscout/apis/termscout-data.md) - [All operations](https://skmtc.dev/termscout/apis/termscout-data/llms.txt) - [OpenAPI document](https://skmtc.dev/termscout/apis/termscout-data/revisions/ccf2baad9b8b?raw)