Option Chain Expiry Date List

This API is used to obtain the the list of expiration dates of option chain

CLIInstall CLI

# list all expiry dates for AAPL options
longbridge option chain AAPL.US
# list all expiry dates for TSLA options
longbridge option chain TSLA.US

SDK Links

Python	longbridge.openapi.QuoteContext.option_chain_expiry_date_list
Rust	longbridge::quote::QuoteContext#option_chain_expiry_date_list
Go	QuoteContext.OptionChainExpiryDateList
Node.js	QuoteContext#optionChainExpiryDateList
Java	QuoteContext.getOptionChainExpiryDateList
C++	longbridge::quote::QuoteContext::option_chain_expiry_date_list

Info

Business Command: 20

Request

Parameters

Name	Type	Required	Description
symbol	string	Yes	Security code, in ticker.region format, for example:700.HK

Protobuf

message SecurityRequest {
  string symbol = 1;
}

Request Example

from longbridge.openapi import QuoteContext, Config, OAuthBuilder

oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = QuoteContext(config)

resp = ctx.option_chain_expiry_date_list("AAPL.US")
print(resp)

import asyncio
from longbridge.openapi import AsyncQuoteContext, Config, OAuthBuilder

async def main() -> None:
    oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url))
    config = Config.from_oauth(oauth)
    ctx = AsyncQuoteContext.create(config)

    resp = await ctx.option_chain_expiry_date_list("AAPL.US")
    print(resp)

if __name__ == "__main__":
    asyncio.run(main())

const { Config, QuoteContext, OAuth } = require('longbridge')

async function main() {
  const oauth = await OAuth.build("your-client-id", (_, url) => {
    console.log("Open this URL to authorize: " + url)
  })
  const config = Config.fromOAuth(oauth)
  const ctx = QuoteContext.new(config)
  const resp = await ctx.optionChainExpiryDateList("AAPL.US")
  console.log(resp)
}
main().catch(console.error)

import com.longbridge.*;
import com.longbridge.quote.*;

class Main {
    public static void main(String[] args) throws Exception {
        try (OAuth oauth = new OAuthBuilder("your-client-id")
                .build(url -> System.out.println("Open to authorize: " + url))
                .get();
             Config config = Config.fromOAuth(oauth);
             QuoteContext ctx = QuoteContext.create(config)) {
            LocalDate[] resp = ctx.getOptionChainExpiryDateList("AAPL.US").get();
            for (LocalDate d : resp) System.out.println(d);
        }
    }
}

use std::sync::Arc;
use longbridge::{oauth::OAuthBuilder, quote::QuoteContext, Config};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let oauth = OAuthBuilder::new("your-client-id")
        .build(|url| println!("Open this URL to authorize: {url}"))
        .await?;
    let config = Arc::new(Config::from_oauth(oauth));
    let (ctx, _) = QuoteContext::new(config);
    let resp = ctx.option_chain_expiry_date_list("AAPL.US").await?;
    println!("{:?}", resp);
    Ok(())
}

#include <iostream>
#include <longbridge.hpp>

#ifdef WIN32
#include <windows.h>
#endif

using namespace longbridge;
using namespace longbridge::quote;

static void
run(const OAuth& oauth)
{
    Config config = Config::from_oauth(oauth);
    QuoteContext ctx = QuoteContext::create(config);

    ctx.option_chain_expiry_date_list("AAPL.US", [](auto res) {
        if (!res) {
            std::cout << "failed: " << *res.status().message() << std::endl;
            return;
        }
        for (const auto& d : *res) std::cout << d.year << "-" << (int)d.month << "-" << (int)d.day << std::endl;
    });
}

int main(int argc, char const* argv[]) {
#ifdef WIN32
    SetConsoleOutputCP(CP_UTF8);
#endif

    const std::string client_id = "your-client-id";
    OAuthBuilder(client_id).build(
    [](const std::string& url) {
        std::cout << "Open this URL to authorize: " << url << std::endl;
    },
    [](auto res) {
        if (!res) {
            std::cout << "authorization failed: " << *res.status().message() << std::endl;
            return;
        }
        run(*res);
    });

    std::cin.get();
    return 0;
}

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/longbridge/openapi-go/config"
	"github.com/longbridge/openapi-go/oauth"
	"github.com/longbridge/openapi-go/quote"
)

func main() {
	o := oauth.New("your-client-id").
		OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) })
	if err := o.Build(context.Background()); err != nil {
		log.Fatal(err)
	}
	conf, err := config.New(config.WithOAuthClient(o))
	if err != nil {
		log.Fatal(err)
	}
	qctx, err := quote.NewFromCfg(conf)
	if err != nil {
		log.Fatal(err)
	}
	defer qctx.Close()
	dates, err := qctx.OptionChainExpiryDateList(context.Background(), "AAPL.US")
	if err != nil {
		log.Fatal(err)
	}
	for _, d := range dates {
		fmt.Println(d.Format("2006-01-02"))
	}
}

Response

Response Properties

Name	Type	Description
expiry_date	string[]	option chain expiry dates list，in YYMMDD format

Protobuf

message OptionChainDateListResponse {
  repeated string expiry_date = 1;
}

Response JSON Example

{
  "expiry_date": [
    "20220422",
    "20220429",
    "20220506",
    "20220513",
    "20220520",
    "20220527",
    "20220603",
    "20220617",
    "20220715",
    "20220819",
    "20220916",
    "20221021",
    "20221118",
    "20230120",
    "20230317",
    "20230616",
    "20230915",
    "20240119",
    "20240621"
  ]
}

Error Code

Protocol Error Code	Business Error Code	Description	Troubleshooting Suggestions
3	301600	Invalid request	Invalid request parameters or unpacking request failed
3	301606	Request rate limit	Reduce the frequency of requests
7	301602	Server error	Please try again or contact a technician to resolve the issue
7	301600	Symbol not found	Check that the requested symbol is correct