Skip to content

Commit f52f322

Browse files
userFRMuserFRM
committed
docs(option/{at_time,snapshot,list}): align param surface with upstream
Same parity sweep as the option/history family — strike and right are optional with default `*` and `both`; min_time on snapshot endpoints is HH:MM:SS.SSS, not milliseconds; expiration accepts YYYY-MM-DD and wildcard `*`; Greeks-input defaults documented. option_list_dates and option_list_contracts: request_type lower-case trade/quote is the upstream enum; SDK still accepts the historical TRADE/QUOTE casing. option_list_strikes already mirrored upstream exactly — no change needed.
1 parent 1198da8 commit f52f322

13 files changed

Lines changed: 119 additions & 119 deletions

File tree

‎docs-site/docs/historical/option/at-time/quote.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ for (const auto& t : data) {
4949
</div>
5050
<div class="param">
5151
<div class="param-header"><code>expiration</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
52-
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> format</div>
52+
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> or <code>YYYY-MM-DD</code> format, or <code>"*"</code> for all expirations</div>
5353
</div>
5454
<div class="param">
55-
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
56-
<div class="param-desc">Strike price in dollars as a string</div>
55+
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
56+
<div class="param-desc">Strike price in dollars (e.g. <code>"550"</code> or <code>"17.5"</code>), or <code>"*"</code> for all strikes. Default: <code>"*"</code>.</div>
5757
</div>
5858
<div class="param">
59-
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
60-
<div class="param-desc"><code>"C"</code> for call, <code>"P"</code> for put</div>
59+
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
60+
<div class="param-desc">Option side: <code>"call"</code>, <code>"put"</code>, or <code>"both"</code>. SDK also accepts <code>"C"</code>/<code>"P"</code>. Default: <code>"both"</code>.</div>
6161
</div>
6262
<div class="param">
6363
<div class="param-header"><code>start_date</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
@@ -73,11 +73,11 @@ for (const auto& t : data) {
7373
</div>
7474
<div class="param">
7575
<div class="param-header"><code>max_dte</code><span class="param-type">int</span><span class="param-badge optional">optional</span></div>
76-
<div class="param-desc">Maximum days to expiration</div>
76+
<div class="param-desc">Maximum days to expiration. Filters contracts returned when <code>expiration="*"</code>.</div>
7777
</div>
7878
<div class="param">
7979
<div class="param-header"><code>strike_range</code><span class="param-type">int</span><span class="param-badge optional">optional</span></div>
80-
<div class="param-desc">Strike range filter</div>
80+
<div class="param-desc">Returns <code>n</code> strikes above and below spot price plus one ATM strike (up to <code>2n + 1</code> strikes).</div>
8181
</div>
8282
</div>
8383

‎docs-site/docs/historical/option/at-time/trade.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ for (const auto& t : data) {
4747
</div>
4848
<div class="param">
4949
<div class="param-header"><code>expiration</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
50-
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> format</div>
50+
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> or <code>YYYY-MM-DD</code> format, or <code>"*"</code> for all expirations</div>
5151
</div>
5252
<div class="param">
53-
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
54-
<div class="param-desc">Strike price in dollars as a string</div>
53+
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
54+
<div class="param-desc">Strike price in dollars (e.g. <code>"550"</code> or <code>"17.5"</code>), or <code>"*"</code> for all strikes. Default: <code>"*"</code>.</div>
5555
</div>
5656
<div class="param">
57-
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
58-
<div class="param-desc"><code>"C"</code> for call, <code>"P"</code> for put</div>
57+
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
58+
<div class="param-desc">Option side: <code>"call"</code>, <code>"put"</code>, or <code>"both"</code>. SDK also accepts <code>"C"</code>/<code>"P"</code>. Default: <code>"both"</code>.</div>
5959
</div>
6060
<div class="param">
6161
<div class="param-header"><code>start_date</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
@@ -71,11 +71,11 @@ for (const auto& t : data) {
7171
</div>
7272
<div class="param">
7373
<div class="param-header"><code>max_dte</code><span class="param-type">int</span><span class="param-badge optional">optional</span></div>
74-
<div class="param-desc">Maximum days to expiration</div>
74+
<div class="param-desc">Maximum days to expiration. Filters contracts returned when <code>expiration="*"</code>.</div>
7575
</div>
7676
<div class="param">
7777
<div class="param-header"><code>strike_range</code><span class="param-type">int</span><span class="param-badge optional">optional</span></div>
78-
<div class="param-desc">Strike range filter</div>
78+
<div class="param-desc">Returns <code>n</code> strikes above and below spot price plus one ATM strike (up to <code>2n + 1</code> strikes).</div>
7979
</div>
8080
</div>
8181

‎docs-site/docs/historical/option/list/contracts.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ for (const auto& t : data) {
4242
<div class="param-list">
4343
<div class="param">
4444
<div class="param-header"><code>request_type</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
45-
<div class="param-desc">Data type (e.g. <code>"TRADE"</code>, <code>"QUOTE"</code>)</div>
45+
<div class="param-desc">Data type. Upstream enum: <code>"trade"</code>, <code>"quote"</code>. SDK also accepts the legacy upper-case forms <code>"TRADE"</code> / <code>"QUOTE"</code>.</div>
4646
</div>
4747
<div class="param">
4848
<div class="param-header"><code>symbol</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
49-
<div class="param-desc">Underlying symbol</div>
49+
<div class="param-desc">Underlying symbol. Upstream additionally accepts a comma-separated list or <code>"*"</code> for all symbols; the SDK takes a single symbol per call and emits the wire-side enumeration internally.</div>
5050
</div>
5151
<div class="param">
5252
<div class="param-header"><code>date</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
5353
<div class="param-desc">Date in <code>YYYYMMDD</code> format</div>
5454
</div>
5555
<div class="param">
5656
<div class="param-header"><code>max_dte</code><span class="param-type">int</span><span class="param-badge optional">optional</span></div>
57-
<div class="param-desc">Maximum days to expiration filter</div>
57+
<div class="param-desc">Maximum days to expiration. Only contracts with DTE less than or equal to this value are returned.</div>
5858
</div>
5959
</div>
6060

‎docs-site/docs/historical/option/list/dates.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,23 @@ for (const auto& item : data) {
4040
<div class="param-list">
4141
<div class="param">
4242
<div class="param-header"><code>request_type</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
43-
<div class="param-desc">Data type: <code>"TRADE"</code>, <code>"QUOTE"</code>, or <code>"OHLC"</code></div>
43+
<div class="param-desc">Data type. Upstream enum: <code>"trade"</code>, <code>"quote"</code>. SDK also accepts the legacy upper-case forms <code>"TRADE"</code> / <code>"QUOTE"</code>.</div>
4444
</div>
4545
<div class="param">
4646
<div class="param-header"><code>symbol</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
4747
<div class="param-desc">Underlying symbol</div>
4848
</div>
4949
<div class="param">
5050
<div class="param-header"><code>expiration</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
51-
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> format</div>
51+
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> or <code>YYYY-MM-DD</code> format</div>
5252
</div>
5353
<div class="param">
54-
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
55-
<div class="param-desc">Strike price in dollars as a string (e.g. <code>"500"</code> or <code>"17.5"</code>)</div>
54+
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
55+
<div class="param-desc">Strike price in dollars (e.g. <code>"500"</code> or <code>"17.5"</code>), or <code>"*"</code> for all strikes. Default: <code>"*"</code>.</div>
5656
</div>
5757
<div class="param">
58-
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
59-
<div class="param-desc"><code>"C"</code> for call, <code>"P"</code> for put</div>
58+
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
59+
<div class="param-desc">Option side: <code>"call"</code>, <code>"put"</code>, or <code>"both"</code>. SDK also accepts <code>"C"</code>/<code>"P"</code>. Default: <code>"both"</code>.</div>
6060
</div>
6161
</div>
6262

‎docs-site/docs/historical/option/snapshot/greeks-all.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,51 +49,51 @@ for (const auto& t : data) {
4949
</div>
5050
<div class="param">
5151
<div class="param-header"><code>expiration</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
52-
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> format</div>
52+
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> or <code>YYYY-MM-DD</code> format, or <code>"*"</code> for all expirations</div>
5353
</div>
5454
<div class="param">
55-
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
56-
<div class="param-desc">Strike price in dollars as a string</div>
55+
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
56+
<div class="param-desc">Strike price in dollars (e.g. <code>"550"</code> or <code>"17.5"</code>), or <code>"*"</code> for all strikes. Default: <code>"*"</code>.</div>
5757
</div>
5858
<div class="param">
59-
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
60-
<div class="param-desc"><code>"C"</code> for call, <code>"P"</code> for put</div>
59+
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
60+
<div class="param-desc">Option side: <code>"call"</code>, <code>"put"</code>, or <code>"both"</code>. SDK also accepts <code>"C"</code>/<code>"P"</code>. Default: <code>"both"</code>.</div>
6161
</div>
6262
<div class="param">
6363
<div class="param-header"><code>annual_dividend</code><span class="param-type">float</span><span class="param-badge optional">optional</span></div>
64-
<div class="param-desc">Override annual dividend</div>
64+
<div class="param-desc">Annualized expected dividend amount used in the Greeks calculation.</div>
6565
</div>
6666
<div class="param">
6767
<div class="param-header"><code>rate_type</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
68-
<div class="param-desc">Interest rate type</div>
68+
<div class="param-desc">Risk-free rate curve. Allowed values: <code>sofr</code>, <code>treasury_m1</code>, <code>treasury_m3</code>, <code>treasury_m6</code>, <code>treasury_y1</code>, <code>treasury_y2</code>, <code>treasury_y3</code>, <code>treasury_y5</code>, <code>treasury_y7</code>, <code>treasury_y10</code>, <code>treasury_y20</code>, <code>treasury_y30</code>. Default: <code>"sofr"</code>.</div>
6969
</div>
7070
<div class="param">
7171
<div class="param-header"><code>rate_value</code><span class="param-type">float</span><span class="param-badge optional">optional</span></div>
72-
<div class="param-desc">Override interest rate value</div>
72+
<div class="param-desc">Override the risk-free rate (as a percent). When set, takes precedence over <code>rate_type</code> for that call.</div>
7373
</div>
7474
<div class="param">
7575
<div class="param-header"><code>stock_price</code><span class="param-type">float</span><span class="param-badge optional">optional</span></div>
76-
<div class="param-desc">Override underlying price</div>
76+
<div class="param-desc">Override the underlying spot price used in the Greeks calculation.</div>
7777
</div>
7878
<div class="param">
7979
<div class="param-header"><code>version</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
80-
<div class="param-desc">Greeks calculation version</div>
80+
<div class="param-desc">Greeks methodology selector. Allowed values: <code>latest</code> (use real time-to-expiry), <code>1</code> (fix 0DTE to 0.15 days). Default: <code>"latest"</code>.</div>
8181
</div>
8282
<div class="param">
8383
<div class="param-header"><code>max_dte</code><span class="param-type">int</span><span class="param-badge optional">optional</span></div>
84-
<div class="param-desc">Maximum days to expiration</div>
84+
<div class="param-desc">Maximum days to expiration. Filters contracts returned when <code>expiration="*"</code>.</div>
8585
</div>
8686
<div class="param">
8787
<div class="param-header"><code>strike_range</code><span class="param-type">int</span><span class="param-badge optional">optional</span></div>
88-
<div class="param-desc">Strike range filter</div>
88+
<div class="param-desc">Returns <code>n</code> strikes above and below spot price plus one ATM strike (up to <code>2n + 1</code> strikes).</div>
8989
</div>
9090
<div class="param">
9191
<div class="param-header"><code>min_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
92-
<div class="param-desc">Minimum time of day as milliseconds from midnight</div>
92+
<div class="param-desc">Filters snapshots to timestamps at or after this ET wall-clock time. Format <code>HH:MM:SS.SSS</code>; legacy millisecond strings are also accepted.</div>
9393
</div>
9494
<div class="param">
9595
<div class="param-header"><code>use_market_value</code><span class="param-type">bool</span><span class="param-badge optional">optional</span></div>
96-
<div class="param-desc">Use market value instead of last trade price</div>
96+
<div class="param-desc">When <code>true</code>, use the market value bid/ask/price inputs for the Greeks calculation. Default: <code>false</code>.</div>
9797
</div>
9898
</div>
9999

‎docs-site/docs/historical/option/snapshot/greeks-first-order.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -51,51 +51,51 @@ Parameters are identical to [option_snapshot_greeks_all](./greeks-all#parameters
5151
</div>
5252
<div class="param">
5353
<div class="param-header"><code>expiration</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
54-
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> format</div>
54+
<div class="param-desc">Expiration date in <code>YYYYMMDD</code> or <code>YYYY-MM-DD</code> format, or <code>"*"</code> for all expirations</div>
5555
</div>
5656
<div class="param">
57-
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
58-
<div class="param-desc">Strike price in dollars as a string</div>
57+
<div class="param-header"><code>strike</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
58+
<div class="param-desc">Strike price in dollars (e.g. <code>"550"</code> or <code>"17.5"</code>), or <code>"*"</code> for all strikes. Default: <code>"*"</code>.</div>
5959
</div>
6060
<div class="param">
61-
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
62-
<div class="param-desc"><code>"C"</code> for call, <code>"P"</code> for put</div>
61+
<div class="param-header"><code>right</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
62+
<div class="param-desc">Option side: <code>"call"</code>, <code>"put"</code>, or <code>"both"</code>. SDK also accepts <code>"C"</code>/<code>"P"</code>. Default: <code>"both"</code>.</div>
6363
</div>
6464
<div class="param">
6565
<div class="param-header"><code>annual_dividend</code><span class="param-type">float</span><span class="param-badge optional">optional</span></div>
66-
<div class="param-desc">Override annual dividend</div>
66+
<div class="param-desc">Annualized expected dividend amount used in the Greeks calculation.</div>
6767
</div>
6868
<div class="param">
6969
<div class="param-header"><code>rate_type</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
70-
<div class="param-desc">Interest rate type</div>
70+
<div class="param-desc">Risk-free rate curve. Allowed values: <code>sofr</code>, <code>treasury_m1</code>, <code>treasury_m3</code>, <code>treasury_m6</code>, <code>treasury_y1</code>, <code>treasury_y2</code>, <code>treasury_y3</code>, <code>treasury_y5</code>, <code>treasury_y7</code>, <code>treasury_y10</code>, <code>treasury_y20</code>, <code>treasury_y30</code>. Default: <code>"sofr"</code>.</div>
7171
</div>
7272
<div class="param">
7373
<div class="param-header"><code>rate_value</code><span class="param-type">float</span><span class="param-badge optional">optional</span></div>
74-
<div class="param-desc">Override interest rate value</div>
74+
<div class="param-desc">Override the risk-free rate (as a percent). When set, takes precedence over <code>rate_type</code> for that call.</div>
7575
</div>
7676
<div class="param">
7777
<div class="param-header"><code>stock_price</code><span class="param-type">float</span><span class="param-badge optional">optional</span></div>
78-
<div class="param-desc">Override underlying price</div>
78+
<div class="param-desc">Override the underlying spot price used in the Greeks calculation.</div>
7979
</div>
8080
<div class="param">
8181
<div class="param-header"><code>version</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
82-
<div class="param-desc">Greeks calculation version</div>
82+
<div class="param-desc">Greeks methodology selector. Allowed values: <code>latest</code> (use real time-to-expiry), <code>1</code> (fix 0DTE to 0.15 days). Default: <code>"latest"</code>.</div>
8383
</div>
8484
<div class="param">
8585
<div class="param-header"><code>max_dte</code><span class="param-type">int</span><span class="param-badge optional">optional</span></div>
86-
<div class="param-desc">Maximum days to expiration</div>
86+
<div class="param-desc">Maximum days to expiration. Filters contracts returned when <code>expiration="*"</code>.</div>
8787
</div>
8888
<div class="param">
8989
<div class="param-header"><code>strike_range</code><span class="param-type">int</span><span class="param-badge optional">optional</span></div>
90-
<div class="param-desc">Strike range filter</div>
90+
<div class="param-desc">Returns <code>n</code> strikes above and below spot price plus one ATM strike (up to <code>2n + 1</code> strikes).</div>
9191
</div>
9292
<div class="param">
9393
<div class="param-header"><code>min_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
94-
<div class="param-desc">Minimum time of day as milliseconds from midnight</div>
94+
<div class="param-desc">Filters snapshots to timestamps at or after this ET wall-clock time. Format <code>HH:MM:SS.SSS</code>; legacy millisecond strings are also accepted.</div>
9595
</div>
9696
<div class="param">
9797
<div class="param-header"><code>use_market_value</code><span class="param-type">bool</span><span class="param-badge optional">optional</span></div>
98-
<div class="param-desc">Use market value instead of last trade price</div>
98+
<div class="param-desc">When <code>true</code>, use the market value bid/ask/price inputs for the Greeks calculation. Default: <code>false</code>.</div>
9999
</div>
100100
</div>
101101

0 commit comments

Comments
 (0)