Skip to content

Commit 5dc73e4

Browse files
userFRMuserFRM
committed
docs(stock,index): align interval / time / venue surface with upstream
Apply the same parity sweep to the stock and index history / snapshot / at_time pages. interval is optional with a `1s` default and the upstream enum extended to `tick` and `10ms`. start_time / end_time are documented as HH:MM:SS.SSS ET wall-clock with the upstream 09:30:00 / 16:00:00 defaults instead of 'milliseconds from midnight'. The `Use "0"` claim is removed across the board — the SDK does not have a tick-by-tick sentinel that maps to a real upstream value, and the doc was implying behaviour the wire does not expose. venue (stock-only) is documented with the upstream `nqb` / `utp_cta` enum and `nqb` default. min_time on stock snapshots takes the same HH:MM:SS.SSS form. stock_history_trade_quote: exclusive flag documented with the `true` upstream default.
1 parent f52f322 commit 5dc73e4

15 files changed

Lines changed: 42 additions & 42 deletions

File tree

‎docs-site/docs/historical/index-data/history/ohlc.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,16 @@ for (const auto& t : data) {
5656
<div class="param-desc">End date in <code>YYYYMMDD</code> format</div>
5757
</div>
5858
<div class="param">
59-
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
60-
<div class="param-desc">Accepts milliseconds (<code>"60000"</code>) or shorthand (<code>"1m"</code>). Valid presets: <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>.</div>
59+
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
60+
<div class="param-desc">Sampling interval. Allowed values: <code>tick</code>, <code>10ms</code>, <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>. Millisecond strings (e.g. <code>"60000"</code>) are accepted and snapped to the nearest preset. Default: <code>"1s"</code>. Sub-minute intervals are available only for single-day requests.</div>
6161
</div>
6262
<div class="param">
6363
<div class="param-header"><code>start_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
64-
<div class="param-desc">Start time of day as milliseconds from midnight</div>
64+
<div class="param-desc">Start time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"09:30:00"</code>.</div>
6565
</div>
6666
<div class="param">
6767
<div class="param-header"><code>end_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
68-
<div class="param-desc">End time of day as milliseconds from midnight</div>
68+
<div class="param-desc">End time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"16:00:00"</code>.</div>
6969
</div>
7070
</div>
7171

‎docs-site/docs/historical/index-data/history/price.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@ for (const auto& t : data) {
4949
<div class="param-desc">Date in <code>YYYYMMDD</code> format</div>
5050
</div>
5151
<div class="param">
52-
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
53-
<div class="param-desc">Accepts milliseconds (<code>"60000"</code>) or shorthand (<code>"1m"</code>). Valid presets: <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>.</div>
52+
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
53+
<div class="param-desc">Sampling interval. Allowed values: <code>tick</code>, <code>10ms</code>, <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>. Millisecond strings (e.g. <code>"60000"</code>) are accepted and snapped to the nearest preset. Default: <code>"1s"</code>. Sub-minute intervals are available only for single-day requests.</div>
5454
</div>
5555
<div class="param">
5656
<div class="param-header"><code>start_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
57-
<div class="param-desc">Start time of day as milliseconds from midnight</div>
57+
<div class="param-desc">Start time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"09:30:00"</code>.</div>
5858
</div>
5959
<div class="param">
6060
<div class="param-header"><code>end_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
61-
<div class="param-desc">End time of day as milliseconds from midnight</div>
61+
<div class="param-desc">End time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"16:00:00"</code>.</div>
6262
</div>
6363
</div>
6464

‎docs-site/docs/historical/index-data/snapshot/market-value.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ for (const auto& t : data) {
4949
</div>
5050
<div class="param">
5151
<div class="param-header"><code>min_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
52-
<div class="param-desc">Minimum time of day as milliseconds from midnight</div>
52+
<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>
5353
</div>
5454
</div>
5555

‎docs-site/docs/historical/index-data/snapshot/ohlc.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ for (const auto& t : data) {
4949
</div>
5050
<div class="param">
5151
<div class="param-header"><code>min_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
52-
<div class="param-desc">Minimum time of day as milliseconds from midnight</div>
52+
<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>
5353
</div>
5454
</div>
5555

‎docs-site/docs/historical/index-data/snapshot/price.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ for (const auto& t : data) {
4646
</div>
4747
<div class="param">
4848
<div class="param-header"><code>min_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
49-
<div class="param-desc">Minimum time of day as milliseconds from midnight</div>
49+
<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>
5050
</div>
5151
</div>
5252

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ for (const auto& t : data) {
6363
</div>
6464
<div class="param">
6565
<div class="param-header"><code>venue</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
66-
<div class="param-desc">Data venue filter</div>
66+
<div class="param-desc">Feed selector. Allowed values: <code>nqb</code> (Nasdaq Basic), <code>utp_cta</code> (merged UTP &amp; CTA). Default: <code>"nqb"</code>.</div>
6767
</div>
6868
</div>
6969

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ for (const auto& t : data) {
6161
</div>
6262
<div class="param">
6363
<div class="param-header"><code>venue</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
64-
<div class="param-desc">Data venue filter</div>
64+
<div class="param-desc">Feed selector. Allowed values: <code>nqb</code> (Nasdaq Basic), <code>utp_cta</code> (merged UTP &amp; CTA). Default: <code>"nqb"</code>.</div>
6565
</div>
6666
</div>
6767

‎docs-site/docs/historical/stock/history/ohlc.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,20 +86,20 @@ for (const auto& t : data) {
8686
<div class="param-desc">Date in <code>YYYYMMDD</code> format</div>
8787
</div>
8888
<div class="param">
89-
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
90-
<div class="param-desc">Accepts milliseconds (<code>"60000"</code>) or shorthand (<code>"1m"</code>). Valid presets: <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>.</div>
89+
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
90+
<div class="param-desc">Sampling interval. Allowed values: <code>tick</code>, <code>10ms</code>, <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>. Millisecond strings (e.g. <code>"60000"</code>) are accepted and snapped to the nearest preset. Default: <code>"1s"</code>. Sub-minute intervals are available only for single-day requests.</div>
9191
</div>
9292
<div class="param">
9393
<div class="param-header"><code>start_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
94-
<div class="param-desc">Start time as milliseconds from midnight ET</div>
94+
<div class="param-desc">Start time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"09:30:00"</code>. Legacy millisecond strings are also accepted.</div>
9595
</div>
9696
<div class="param">
9797
<div class="param-header"><code>end_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
98-
<div class="param-desc">End time as milliseconds from midnight ET</div>
98+
<div class="param-desc">End time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"16:00:00"</code>. Legacy millisecond strings are also accepted.</div>
9999
</div>
100100
<div class="param">
101101
<div class="param-header"><code>venue</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
102-
<div class="param-desc">Data venue filter</div>
102+
<div class="param-desc">Feed selector. Allowed values: <code>nqb</code> (Nasdaq Basic), <code>utp_cta</code> (merged UTP &amp; CTA). Default: <code>"nqb"</code>.</div>
103103
</div>
104104
</div>
105105

@@ -119,8 +119,8 @@ for (const auto& t : data) {
119119
<div class="param-desc">End date in <code>YYYYMMDD</code> format</div>
120120
</div>
121121
<div class="param">
122-
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
123-
<div class="param-desc">Accepts milliseconds (<code>"60000"</code>) or shorthand (<code>"1m"</code>). Valid presets: <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>.</div>
122+
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
123+
<div class="param-desc">Bar size. Allowed values: <code>tick</code>, <code>10ms</code>, <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>. Millisecond strings (e.g. <code>"60000"</code>) are accepted and snapped to the nearest preset. Default: <code>"1s"</code>. Sub-minute intervals are available only for single-day requests.</div>
124124
</div>
125125
</div>
126126

‎docs-site/docs/historical/stock/history/quote.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: NBBO quotes for a stock at a configurable sampling interval.
55

66
# stock_history_quote
77

8-
NBBO quotes for a stock on a given date, sampled at a configurable interval. Use `"0"` as the interval to get every quote change.
8+
NBBO quotes for a stock on a given date, sampled at a configurable interval.
99

1010
<TierBadge tier="value" />
1111

@@ -52,20 +52,20 @@ for (const auto& t : data) {
5252
<div class="param-desc">Date in <code>YYYYMMDD</code> format</div>
5353
</div>
5454
<div class="param">
55-
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge required">required</span></div>
56-
<div class="param-desc">Accepts milliseconds (<code>"60000"</code>) or shorthand (<code>"1m"</code>). Valid presets: <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>. Use <code>"0"</code> to get every quote change.</div>
55+
<div class="param-header"><code>interval</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
56+
<div class="param-desc">Sampling interval. Allowed values: <code>tick</code>, <code>10ms</code>, <code>100ms</code>, <code>500ms</code>, <code>1s</code>, <code>5s</code>, <code>10s</code>, <code>15s</code>, <code>30s</code>, <code>1m</code>, <code>5m</code>, <code>10m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>. Millisecond strings (e.g. <code>"60000"</code>) are accepted and snapped to the nearest preset. Default: <code>"1s"</code>. Sub-minute intervals are available only for single-day requests.</div>
5757
</div>
5858
<div class="param">
5959
<div class="param-header"><code>start_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
60-
<div class="param-desc">Start time as milliseconds from midnight ET</div>
60+
<div class="param-desc">Start time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"09:30:00"</code>. Legacy millisecond strings are also accepted.</div>
6161
</div>
6262
<div class="param">
6363
<div class="param-header"><code>end_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
64-
<div class="param-desc">End time as milliseconds from midnight ET</div>
64+
<div class="param-desc">End time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"16:00:00"</code>. Legacy millisecond strings are also accepted.</div>
6565
</div>
6666
<div class="param">
6767
<div class="param-header"><code>venue</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
68-
<div class="param-desc">Data venue filter</div>
68+
<div class="param-desc">Feed selector. Allowed values: <code>nqb</code> (Nasdaq Basic), <code>utp_cta</code> (merged UTP &amp; CTA). Default: <code>"nqb"</code>.</div>
6969
</div>
7070
</div>
7171

@@ -116,6 +116,6 @@ for (const auto& t : data) {
116116
117117
## Notes
118118

119-
- Setting `interval` to `"0"` returns every NBBO change, which can produce hundreds of thousands of rows for active symbols. Use the Rust `_stream` variant for large responses.
119+
- Sub-minute intervals (`tick`, `10ms`, `100ms`, `500ms`, `1s`, `5s`, `10s`, `15s`, `30s`) are accepted for single-day requests only.
120120
- Python users chain `.to_pandas()` on the return value: `tdx.stock_history_quote(...).to_pandas()`.
121121
- Shorthand is supported: `"1m"`, `"5m"`, `"1h"`. Milliseconds (`"60000"`, `"300000"`, `"3600000"`) are auto-converted to the nearest valid preset.

‎docs-site/docs/historical/stock/history/trade-quote.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,19 @@ for (const auto& t : data) {
5353
</div>
5454
<div class="param">
5555
<div class="param-header"><code>start_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
56-
<div class="param-desc">Start time as milliseconds from midnight ET</div>
56+
<div class="param-desc">Start time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"09:30:00"</code>. Legacy millisecond strings are also accepted.</div>
5757
</div>
5858
<div class="param">
5959
<div class="param-header"><code>end_time</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
60-
<div class="param-desc">End time as milliseconds from midnight ET</div>
60+
<div class="param-desc">End time (inclusive) in <code>HH:MM:SS.SSS</code> ET wall-clock format. Default: <code>"16:00:00"</code>. Legacy millisecond strings are also accepted.</div>
6161
</div>
6262
<div class="param">
6363
<div class="param-header"><code>exclusive</code><span class="param-type">bool</span><span class="param-badge optional">optional</span></div>
64-
<div class="param-desc">Use exclusive time bounds</div>
64+
<div class="param-desc">When <code>true</code>, only quotes with timestamp strictly before the trade timestamp are paired. Default: <code>true</code>.</div>
6565
</div>
6666
<div class="param">
6767
<div class="param-header"><code>venue</code><span class="param-type">string</span><span class="param-badge optional">optional</span></div>
68-
<div class="param-desc">Data venue filter</div>
68+
<div class="param-desc">Feed selector. Allowed values: <code>nqb</code> (Nasdaq Basic), <code>utp_cta</code> (merged UTP &amp; CTA). Default: <code>"nqb"</code>.</div>
6969
</div>
7070
</div>
7171

0 commit comments

Comments
 (0)