AutoShares API
  • What is AutoShares?
  • API Documentation
    • Quick Start Guide
    • API Overview
    • Authentication
      • Authenticate with AutoShares SSO/Auth0
      • Triggering authentication with /login
      • For logout scenario
    • Onboarding Users
      • Account Setup
        • Syntax
        • Add Account To User
        • Add Account To User By Username
        • Get All Accounts Of A User
        • Get All Users Of An Account
        • Get Account Info
        • Update Alias Account For Current User
        • Remove Account From User
        • Get User's Trading Settings
        • Get User's Exchanges
      • Access Agreements
    • Account Balances and Buying Power
      • Get Balance Information For A User
      • Get Account's Balance Info
      • Get Historical Account Value
    • Order Processing and Trading
      • Place Order
        • Syntax
      • Verify Order Placement
        • Syntax
      • Verify Order Replacement
        • Syntax
      • Replace Order
        • Syntax
      • Cancel an Order
        • Syntax
      • Get Order's Info
        • Syntax
      • Get Filtered Orders
        • Syntax
      • Validate Order by ID
      • Positions
        • Get User's Positions
          • Syntax
        • Get User's Positions in a Security
          • Syntax
        • Get Market Value of all Security Groups
      • Managing Transactions
        • Get Transactions
          • Syntax
    • Streaming Data and Quotes
      • Streaming API Endpoints
        • Get Streamers' Info
        • Recover a Streamer Session
      • Quotes
      • Orders
      • Positions
      • Watchlists
      • Account Balances
      • User Balance
      • Securities
        • Get Equity Info by Internal ID
          • Syntax
        • Get Equity Info by Ticker
          • Syntax
        • Get Equity Info by Mask
          • Syntax
        • Get Filtered Equities
          • Syntax
        • Get Option Info by Internal ID
          • Syntax
        • Get Option Info by Ticker
          • Syntax
        • Get Options Expiration Dates
          • Syntax
        • Get an Option Chain
        • Get Filtered Options
          • Syntax
        • Get Company Logo By Symbol
    • Historical Chart Data
      • Get Comparison Chart Data
        • Syntax
      • Get Candles and Indicators for a Security
        • Syntax
      • Get Chart Data in the Excel Format
        • Syntax
    • Price Alerts
      • Create Price Alert
        • Syntax
      • Delete Price Alert
        • Syntax
      • Get Specific Alert
        • Syntax
      • Get User's Price Alerts
        • Syntax
      • Modify Price Alert
        • Syntax
    • Watchlists
      • Add Security to Watchlist by ID
        • Syntax
      • Add Security to Watchlist by Ticker
        • Syntax
      • Create New Watchlist
        • Syntax
      • Delete Watchlist
        • Syntax
      • Get Specific Watchlist
        • Syntax
      • Get User's Watchlists
        • Syntax
      • Remove Security From Watchlist by ID
        • Syntax
      • Remove Security from Watchlist by Ticker
        • Syntax
      • Rename Watchlist
        • Syntax
      • News
        • Get News for a Security
        • Get Corporate Actions for a Security
    • [Webhooks and SDKs]
    • Wires, ACH, and Account Transfers
      • ACH Setup
        • Create A New ACH Relationship
        • Get an ACH Relationship
        • Modify an ACH Relationship
      • Deposit / Withdraw Funds
        • Deposit / Withdraw Funds via ACH
      • Get a Transfer's Info
        • Get an ACH Transfer's Info
        • Get All Transfers
    • Terms and Definitions
      • Part I
      • Part II
      • Part III
Powered by GitBook
On this page
  • Overview
  • Response
  • Common Mistakes
  • Failing to Specify the Query Parameters
  1. API Documentation
  2. Streaming Data and Quotes
  3. Securities

Get Options Expiration Dates

Fetch expiration dates of options with a particular underlying security

Overview

This endpoint enables you to retrieve the expiration dates of all options in which the underlying security is provided in the request's query.

There are four required parameters that must be provided in the request's header and query:

  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. underlying (query). This is the ticker symbol of the option's underlying security.

Here's the final template for this API request:

GET apiURL/v1.0/options/expirations?underlying=AAPL

Response

In response to this API request, you'll receive a list of expiration dates for options in which the underlying security was specified in the request query.

[
    {
        "SeriesId": 103,
        "SeriesType": "Standard",
        "ExpirationDate": "2019-02-15T00:00:00Z",
        "ExpirationType": "Regular"
    },
    {
        "SeriesId": 103,
        "SeriesType": "Standard",
        "ExpirationDate": "2019-02-22T00:00:00Z",
        "ExpirationType": "Weekly"
    },
    {
        "SeriesId": 103,
        "SeriesType": "Standard",
        "ExpirationDate": "2019-03-01T00:00:00Z",
        "ExpirationType": "Weekly"
    },
    {
        "SeriesId": 103,
        "SeriesType": "Standard",
        "ExpirationDate": "2019-03-08T00:00:00Z",
        "ExpirationType": "Weekly"
    },
]

where:

Parameter
Description

SeriesId

This is the internal identifier of the option series to which this option belongs.

SeriesType

This is the type of option series. Possible values: Standard, NonStandard, Binary, Flex, Undefined.

ExpirationDate

This is the expiration date of the option.

ExpirationType

This is the expiration type of the option. Possible values: Regular, Quarterly, Weekly, Flex, Undefined, Mini, NonStandard.

Common Mistakes

Here are some of the common mistakes that developers make when attempting to retrieve expiration data of options with a particular underlying security.

Failing to Specify the Query Parameters

It's crucial to understand that the underlying query parameter must be indicated in the request; otherwise you'll receive the 404 status code and the following message:

{
    "Message": "No HTTP resource was found that matches the request URI 'https://pub-api-etnatrader-dev.etnasoft.us/api/v1.0/equities?pageNumber=0&pageSize=2&sortField=Type'."
}

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

PreviousSyntaxNextSyntax

Last updated 1 year ago