v1

latestOpenAPI 3.0.32026-08-0615081.4 KB
v1

Generate a properly formatted OCC option symbol based on the user's human-readable description of an option. This endpoint converts text such as "AAPL 7/26/23 $200 Call" to OCC option symbol format: AAPL230726C00200000. The user input must be URL-encoded.

get/v1/options/lookup/{userInput}/

Path parameters

userInputstring required

The human-readable string input that contains (1) stock symbol (2) strike (3) expiration date (4) option side (i.e. put or call). This endpoint will translate the user's input into a valid OCC option symbol.

Query parameters

format'csv' | 'json'

Response

object required