Get Option Info by Ticker

Fetch information about a particular option by providing its ticker symbol

Overview

This GET endpoint enables you to retrieve information about a particular option by providing the option's ticker symbol in the request's header. Whereas the first three methods in the Securities section deal with equities' information, this endpoint provides information exclusively about options.

There are four required parameters that must be provided in the request:

  1. Authorization (header). This is the authorization token from the very first token request. The value of this header must have the following format: Bearer BQ898r9fefi (Bearer + 1 space + the token).

  2. API version (path). Unless necessary, leave it at "1.0".

  3. symbol (path). This is the ticker symbol of the option whose information you'd like to retrieve. This ticker symbol can be fetched using the API request that lists filtered options.

Here's the final template for this API request:

GET apiURL/v1.0/options/VSSQ1 260117P00008000

Response

In response to this API request, you'll receive a JSON file with comprehensive information about the enquired option:

{
    "Id": 13210821,
    "Symbol": "VSSQ1 260117P00008000",
    "Description": "PUT Virtual Stock (static quotes) $8.00000000 EXP 01/17/26",
    "Exchange": "VIRTEX",
    "Currency": "USD",
    "AddedDate": "2018-09-11T07:20:10.318803Z",
    "ModifyDate": "2018-12-19T17:10:36.943Z",
    "Type": "Option",
    "Precision": 2,
    "VolumePrecision": 0,
    "TickSize": 0.01,
    "Enabled": true,
    "AllowTrade": true,
    "AllowMargin": true,
    "AllowShort": true,
    "OptionType": "Put",
    "ExpirationType": "Flex",
    "ExpirationDate": "2026-01-17T00:00:00Z",
    "StrikePrice": 8,
    "SeriesId": 125685,
    "UnderlyingAssetSymbol": "VSSQ1",
    "ContractSize": 100
}

where:

Common Mistakes

Here are some of the common mistakes that developers make when attempting to retrieve an option's information by their ticker symbol.

Mistaking the Character Count in Symbol

An extremely common mistake when calling this endpoint is not ensuring that the combined character count of the underlying ticker and the following spaces is 6. If it's anything other than 6, the request will fall through.

For example:

  • V 210618C00195000. Notice the five spaces between V and 2. Underlying ticker (1) + spaces (5) = 6.

  • AAPL 210618C00195000. Notice the two spaces between AAPL and 2. Underlying ticker (4) + spaces (2) = 6.

Specifying the Underlying Security's Ticker instead of the Option's Ticker Symbol

Another common mistake in retrieving information about a particular option is specifying the underlying security's ticker symbol instead of the enquired option's ticker symbol. Doing so will lead to the 409 status code.

The following article covers the syntax for this API request in detail.

Last updated