GET Option Activity

Returns option activity signals

Response (200 OK)

[
  {
    "id": "string",
    "date": "string (YYYY-MM-DD)",
    "time": "string (HH:MM:SS)",
    "ticker": "string",
    "exchange": "string",
    "description": "string",
    "description_extended": "string",
    "updated": "integer",
    "sentiment": "string",
    "aggressor_ind": "string (float)",
    "option_symbol": "string (SPY190826P00292000)",
    "underlying_type": "string",
    "underlying_price": "string (float)",
    "cost_basis": "string (float)",
    "put_call": "string",
    "strike_price": "string (float)",
    "price": "string (float)",
    "size": "string (integer)",
    "date_expiration": "string (YYYY-MM-DD)",
    "option_activity_type": "string",
    "trade_count": "string (integer)",
    "open_interest": "string (integer)",
    "volume": "string (integer)",
    "bid": "string (float)",
    "ask": "string (float)",
    "midpoint": "string (float)",
    "execution_estimate": "string"
  }
]

Authorizations

token · string · query · required

Headers

accept · enum<string> · default: application/json

Specifies return format. Query parameters work the same for both formats.

Available options:

application/json,

application/xml (deprecated)

Query Parameters

page · integer · default: 0

Page offset.

pagesize · integer

Number of results returned. Limit 1000

parameters[date] · string<YYYY-MM-DD>

Date to query for data. Shorthand for date_from and date_to if they are the same. Defaults for latest.

parameters[date_from] · string<YYYY-MM-DD>

Date to query from point in time.

parameters[date_to] · string<YYYY-MM-DD>

Date to query to point in time.

parameters[tickers] · string<csv>

One or more ticker symbols separated by a comma.

parameters[id] · string<csv>

One or more ids separated by a comma.

parameters[updated] · integer

Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated.

Response

200

application/json

success

The response is of type object[].