Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Assets

Get an option contract by ID or Symbol (BETA)

Get an option contract by symbol or contract ID. The symbol or id should be passed in as a path parameter.

get/v1/options/contracts/{symbol_or_id}

Response

An option contract

close_pricestring

The close price of the option contract.

close_price_datestring date

The date of the close price data.

expiration_datestring date required

The expiration date of the option contract.

idstring required

The unique identifier of the option contract.

multiplierstring required

The multiplier of the option contract is crucial for calculating both the trade premium and the extended strike price. In standard contracts, the multiplier is always set to 100. For instance, if a contract is traded at $1.50 and the multiplier is 100, the total amount debited when buying the contract would be $150.00. Similarly, when exercising a call contract, the total cost will be equal to the strike price times the multiplier.

namestring required

The name of the option contract.

open_intereststring

The open interest of the option contract.

open_interest_datestring date

The date of the open interest data.

root_symbolstring

The root symbol of the option contract.

sizestring required

Represents the number of underlying shares to be delivered in case the contract is exercised/assigned. For standard contracts, this is always 100. This field should not be used as a multiplier, specially for non-standard contracts.

status'active' | 'inactive' required

The status of the option contract.

strike_pricestring required

The strike price of the option contract.

style'american' | 'european' required

The style of the option contract.

symbolstring required

The symbol representing the option contract.

tradableboolean required

Indicates whether the option contract is tradable.

type'call' | 'put' required

The type of the option contract.

underlying_asset_idstring required

The unique identifier of the underlying asset.

underlying_symbolstring required

The underlying symbol of the option contract.

Example response

{
  "close_price": "148.38",
  "close_price_date": "2023-12-11",
  "deliverables": [
    {
      "allocation_percentage": "100",
      "amount": "100",
      "asset_id": "b0b6dd9d-8b9b-48a9-ba46-b9d54906e415",
      "settlement_method": "CCC",
      "settlement_type": "T+2",
      "symbol": "AAPL",
      "type": "equity"
    }
  ],
  "expiration_date": "2025-06-20",
  "id": "98359ef7-5124-49f3-85ea-5cf02df6defa",
  "multiplier": "100",
  "name": "AAPL Jun 20 2025 100 Call",
  "open_interest": "237",
  "open_interest_date": "2023-12-11",
  "root_symbol": "AAPL",
  "size": "100",
  "status": "active",
  "strike_price": "100",
  "style": "american",
  "symbol": "AAPL250620C00100000",
  "tradable": true,
  "type": "call",
  "underlying_asset_id": "b0b6dd9d-8b9b-48a9-ba46-b9d54906e415",
  "underlying_symbol": "AAPL"
}