From 02b70c15e95c7282e96ab3464ca2732ef0f74c58 Mon Sep 17 00:00:00 2001 From: MarketDataApp <112879596+MarketDataApp@users.noreply.github.com> Date: Wed, 9 Sep 2026 20:04:39 +0000 Subject: [PATCH] docs: sync from documentation@88ab62c6f64aea352e8f40b562e19fa17fd0eb13 --- docs/authentication.md | 2 +- docs/options/README.md | 2 +- docs/options/chain.md | 2 +- docs/settings.md | 2 +- docs/utilities/user.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/authentication.md b/docs/authentication.md index fde67bb..eb6a964 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -124,7 +124,7 @@ var options = new MarketDataClientOptions { ValidateTokenOnStartup = false }; ``` > [!NOTE] -> **Demo mode** +> **[Demo mode]** > > If no token is found anywhere in the cascade, the SDK runs in **demo mode** — startup validation is skipped and you can call the free, public endpoints (such as `AAPL` quotes and `client.Utilities.GetStatusAsync()`). Authenticated endpoints throw `AuthenticationException` on first use. diff --git a/docs/options/README.md b/docs/options/README.md index d929d16..29090f5 100644 --- a/docs/options/README.md +++ b/docs/options/README.md @@ -7,6 +7,6 @@ Reach the resource through `client.Options`. For CSV output, call the paired `*C ## Options Endpoints - [Option Chain (C# SDK)](./chain.md) — Retrieve a complete or filtered option chain with the C# SDK. Every contract returns a full quote with greeks, implied volatility and open interest. -- [Expirations (C# SDK)](./expirations.md) +- [Expirations (C# SDK)](./expirations.md) — Call GetExpirationsAsync on the C# SDK Options resource to list expiration dates for an underlying symbol, filtered by strike or historical date. - [Option Quotes (C# SDK)](./quotes.md) - [Lookup (C# SDK)](./lookup.md) — Turn a human-readable option description into a well-formed OCC option symbol with the C# SDK and its OptionsLookupRequest type. diff --git a/docs/options/chain.md b/docs/options/chain.md index 4553fd1..fd3b836 100644 --- a/docs/options/chain.md +++ b/docs/options/chain.md @@ -23,7 +23,7 @@ Task GetChainAsync(OptionsChainRequest request, ...) ``` > [!CAUTION] -> **Quota** +> **[Quota]** > > A chain response bills roughly **one credit per contract returned**. An unfiltered chain for a liquid underlying can run to thousands of contracts. Always narrow with an expiration filter, `StrikeLimit`, or `Side` unless you really need the whole chain. diff --git a/docs/settings.md b/docs/settings.md index 4c84b69..b61386b 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -95,7 +95,7 @@ await csv.SaveToFileAsync("prices.csv"); // write it to disk `CsvResponse` carries the same metadata as every other response (`StatusCode`, `RequestId`, `RateLimit`, `IsNoData`, ...), with `IsCsv == true`. > [!NOTE] -> **`MARKETDATA_OUTPUT_FORMAT`** +> **[`MARKETDATA_OUTPUT_FORMAT`]** > > This key exists for parity with the other Market Data SDKs and is **advisory only** in C#: it stores a hint on `OutputFormat` but never reroutes a typed method to CSV or vice versa. Call the `*CsvAsync` method when you want CSV. diff --git a/docs/utilities/user.md b/docs/utilities/user.md index 4dffc11..846e8a8 100644 --- a/docs/utilities/user.md +++ b/docs/utilities/user.md @@ -22,7 +22,7 @@ public record User( ``` > [!NOTE] -> **Rate-limit state** +> **[Rate-limit state]** > > This endpoint is also what the client calls at startup to validate your token. The rate-limit numbers the SDK tracks — including the reset time and consumed count — come from the `x-api-ratelimit-*` response headers, not from this body, and surface through [`client.LatestRateLimit`](../client.md#rate-limits) and `response.RateLimit`. `User` is the typed view of the account body only.