v1

latestOpenAPI 3.0.22026-08-06172357.6 KB

CUSIP for Options and Futures

Search option and future CUSIP data using various filter parameters

get/cusip/option/search

Query parameters

qstring required

The syntax is <search field>:<search value> pair separated by colon and multiple <search field>:<search value> pairs can be connected by AND, OR and NOT logical operator.

Supported Search Fields

Search Field	Data Type	Example	Comment
cusip	string	cusip:00E01FUX6
isin	string	isin:US00E01FUX60
underlyingCusip	string	underlyingCusip:00206R102
underlyingIsin	string	underlyingIsin:US00206R1023
contractLevelFoIndicator	string	contractLevelFoIndicator:C	C = Call Option, P = Put Option, F = Futures Contract
occCode	string	occCode:"T 260116C00022000"
opraOsiCode	string	opraOsiCode:"T A1626D220000"
underlyingSymbol	string	underlyingSymbol:T
contractName	string	contractName:"AT&T Incorporated"
strikePrice	string	strikePrice:20
promptDate	date	promptDate:[2022-09-02 TO 2028-09-02]

pageSizeinteger

Specifies the maximum number of CUSIP records to return in the response.

Accept any integer between 1 and 10000. Default:1000

For trial users, the maximum number of records in the response is limited to 5

sortstring

Specifies the field and direction for sorting the API response. Format: <sort field> <sort direction> (e.g., "optionFutureCusip asc" or "contractName desc"). The default sort field is cusip. If the sort direction is not provided, ascending (asc) is used by default.

Supported sort fields:

cusip
isin
underlyingCusip
underlyingIsin
occCode

pageinteger

The page number in the search result. User uses this parameter to navigate to next page.

Example: Any integer between 1 and 10. Default:1

*If user uses maximum pageSize and page number, API can return up to 100,000 records per API call

Response

Successful retrieval of CUSIP Issuer result.

Example response

{
  "response": {
    "header": {
      "totalCount": 1,
      "queryTime": 90,
      "query": "/cusip/search?q=cusip:303075105",
      "page": 1,
      "pageSize": 1000
    },
    "cusipRecords": [
      {
        "cusip": "00CAV8MF7",
        "isin": "US00CAV8MF71",
        "underlyingCusip": "00206R102",
        "underlyingIsin": "US00206R1023",
        "occCode": "T     260116C00010000",
        "opraOsiCode": "MSFT L1925C195000",
        "underlyingSymbol": "T",
        "contractName": "AT&T Incorporated",
        "strikePrice": 10,
        "promptDate": "01/16/2026",
        "contractLevelFoIndicator": "C",
        "exchangeCode": "AMEX",
        "isoMicCode": "XCBO",
        "contractStartDate": "09/12/2023",
        "isoCfiCode": "OCASPS",
        "usCfiCode": "OCASPS"
      }
    ]
  }
}