Option Lookup
The Option Lookup gRPC service provides options tickers/expirations for the given underlying ticker. This API requires that the customer have an active Option Lookup subscription and a JWT to be included with the request.
tip
For an introduction to gRPC, visit: https://grpc.io/docs/what-is-grpc/introduction/
🔗URLs​
option-lookup.quodd.com
🔒Authentication​
Obtain a JWT token and add it to MetaData as follows:
{
"Authorization": "Bearer YOUR_TOKEN_HERE"
}
💻Proto File​
Download proto file.
📄Optionlookup.proto​
OptionLookupService​
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetOptionTickers | GetOptionTickersRequest | GetOptionTickersResponse | Returns options tickers for underlying ticker. |
| GetOptionExpirations | GetOptionExpirationsRequest | GetOptionExpirationsResponse | Returns options expiration dates for underlying ticker. |
GetOptionTickersRequest​
| Field | Type | Description |
|---|---|---|
| underlying_ticker | string | Underlying ticker. |
| option_type | string | (optional) Type of option contract. |
| expiration_date | string | (optional) Expiration date of option contract. |
GetOptionTickersResponse​
| Field | Type | Label | Description |
|---|---|---|---|
| options | Option | repeated | Option tickers for underlying ticker. |
| error | string | Details of error. |
Option​
| Field | Type | Description |
|---|---|---|
| ticker | string | The option ticker. |
| underlying_ticker | string | Underlying ticker. |
| expiration_date | string | Expiration date of option contract. |
| option_type | string | Type of option contract. |
| strike_price | double | Strike price of option contract. |
GetOptionExpirationsRequest​
| Field | Type | Description |
|---|---|---|
| underlying_ticker | string | Underlying ticker. |
GetOptionExpirationsResponse​
| Field | Type | Label | Description |
|---|---|---|---|
| expirations | string | repeated | Option Expiration dates for underlying ticker. |
| error | string | Details of the error. |
🚀Quick start​
gRPCurl​
Command-line tool for interacting with gRPC servers
Example GetOptionTickers Request:
grpcurl -H 'authorization: Bearer TOKEN' -proto 'optionlookup.proto' -d '{ "underlying_ticker": "MSFT", "option_type": "C", "expiration_date":"2025-01-17" }' option-lookup.quodd.com:443 optionlookup.OptionLookupService/GetOptionTickers
Example GetOptionExpirations Request:
grpcurl -H 'authorization: Bearer TOKEN' -proto 'optionlookup.proto' -d '{ "underlying_ticker": "MSFT" }' option-lookup.quodd.dev:443 optionlookup.OptionLookupService/GetOptionExpirations