Skip to content

docs(quote): replace the option chain pages with the OpenAPI endpoint - #1244

Open
nlimpid wants to merge 1 commit into
longbridge:mainfrom
nlimpid:docs/openapi-option-chain
Open

docs(quote): replace the option chain pages with the OpenAPI endpoint#1244
nlimpid wants to merge 1 commit into
longbridge:mainfrom
nlimpid:docs/openapi-option-chain

Conversation

@nlimpid

@nlimpid nlimpid commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Background

The option chain moves off quote socket commands 20/21 onto the fundamental-data OpenAPI service (gemini OpenAPIOptionChain). The old pages come down and the contract list ships as its own HTTP page on a new URL.

Changes

Removedquote/options/optionchain_date and optionchain-date-strike, all three locales. Both rows also drop out of socket/biz_command, since the endpoint is no longer a business command.

Addedquote/options/option-chain, slug /quote/pull/option-chain, all three locales. Follows the plain-HTTP page shape used by ai/agents.mdx (http-basic table + Query Parameters + cURL tab + Schemas). No SDKLinks / CliCommand / QuotePermission: the SDK method name is not settled, the CLI has no such command, and this endpoint carries no quote-permission gate.

quote/overview keeps one row for the endpoint; the Pull group's rowspan is adjusted to match and was verified against the actual row count in every locale.

Contract documented

field value
standard_only (query) true / 1 returns standard contracts only; omitted or false returns everything including standard_attr = old
direction C / P
option_type W / Q / empty
standard_attr old / empty
days_to_expiry ET-midnight based, 0 on expiry day, negative once expired

The response example is a real SIT payload (BABA.US / 20261218) and includes genuine post-corporate-action contracts (BABA2261218C10000.US), not invented ones.

Notes

  • Old URLs /quote/pull/optionchain-date(-strike) now 404 — new slug was chosen deliberately over reusing the old one.
  • The expiry-date list endpoint is not documented yet; its gateway path is still undecided, so that page is deliberately out of scope here.
  • direction is a literal C/P rather than the enum ordinal it used to serialize as, matching option_type and standard_attr. The gemini-side proto change lands alongside this.

The option chain moves off quote socket commands 20/21 onto the
fundamental-data OpenAPI service, so the old pages come down and the
contract list ships as its own HTTP page rather than inheriting their URLs.

- drop quote/options/optionchain_date and optionchain-date-strike across en/zh-CN/zh-HK
- add quote/options/option-chain, slug /quote/pull/option-chain, documenting
  standard_only and the standard_attr / option_type / days_to_expiry fields
- response example is a real SIT payload (BABA.US 20261218) carrying old contracts
- rework the quote/overview rows and rowspan; socket/biz_command loses both entries
  since the endpoint is no longer a business command
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant