general
categories
Returns the available category names for a package. Combine a ticker, package, and category to build standard WebSocket groups and historical download queries.
GET/{PACKAGE}/categoriesPublic
Returns the available category names for a package. Combine a ticker, package, and category to build standard WebSocket groups and historical download queries.
Category Querying
- Public Endpoint: Open endpoint; no credentials required.
- Package Routes: Available routes are
GET /classic/categories,GET /state/categories, andGET /orderflow/categories. - WebSocket Group Construction: Combine returned category names with tickers to construct WebSocket groups (
{TICKER}_{PACKAGE}_{CATEGORY}, e.g.SPX_state_gamma_zero) and historical download queries.
Request
Example: /state/categories
Headers
| Name | Type | Description |
|---|---|---|
User-Agent | string | Required. Identify your client application. |
Accept | string | Required. Set to "application/json". |
Path parameters
| Name | Type | Description |
|---|---|---|
PACKAGE | string | Data package: classic, state, or orderflow. |
Response
| Field | Type | Description |
|---|---|---|
[] | string | A category name for the requested package, such as gex_full, gamma_zero, or orderflow. |
[
"gex_full",
"gex_zero",
"gex_one",
"delta_zero",
"delta_one",
"gamma_zero",
"gamma_one",
"vanna_zero",
"vanna_one",
"charm_zero",
"charm_one"
][
"gex_full",
"gex_zero",
"gex_one"
]{
"type": "array",
"items": {
"type": "string"
},
"description": "Array of category names for the requested package."
}type: array
items:
type: string
description: Array of category names for the requested package.