From d0084e93a539b1fcd7816b6eb029ab38214cb316 Mon Sep 17 00:00:00 2001 From: MarketDataApp <112879596+MarketDataApp@users.noreply.github.com> Date: Mon, 29 Jun 2026 23:48:50 +0000 Subject: [PATCH] docs: sync from documentation@4a05fe83c796f050d7ba26a53cfb9b53f5eb7c9c --- docs/client.md | 18 +++++++++--------- docs/settings.md | 34 +++++++++++++++++----------------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/client.md b/docs/client.md index 9edf09d..7e55cfe 100644 --- a/docs/client.md +++ b/docs/client.md @@ -273,15 +273,15 @@ response.saveToFile(Path.of("aapl.json")); // cache the raw body Everything the SDK throws is a `MarketDataException`. It is a **sealed** hierarchy — the seven subtypes below are the complete set, so you can branch on them exhaustively and the compiler will tell you if a future major version adds one. Each exception carries support context: `getStatusCode()`, `getRequestId()`, `getRequestUrl()`, and `getSupportInfo()`. -| Subtype | When it's thrown | -|---|---| -| `AuthenticationError` | Missing or invalid token (HTTP 401) | -| `BadRequestError` | Invalid parameters (HTTP 4xx) | -| `NotFoundError` | The resource doesn't exist (HTTP 404) | -| `RateLimitError` | Quota exceeded (HTTP 429); see `getRetryAfter()` | -| `ServerError` | API-side failure (HTTP 5xx) | -| `NetworkError` | Connection failure or timeout | -| `ParseError` | The response could not be decoded | +| Subtype | When it's thrown | +|-----------------------|--------------------------------------------------| +| `AuthenticationError` | Missing or invalid token (HTTP 401) | +| `BadRequestError` | Invalid parameters (HTTP 4xx) | +| `NotFoundError` | The resource doesn't exist (HTTP 404) | +| `RateLimitError` | Quota exceeded (HTTP 429); see `getRetryAfter()` | +| `ServerError` | API-side failure (HTTP 5xx) | +| `NetworkError` | Connection failure or timeout | +| `ParseError` | The response could not be decoded | Async calls surface the same exceptions through the `CompletableFuture` (wrapped in a `CompletionException`); the sync wrappers unwrap them so you catch the cause directly. diff --git a/docs/settings.md b/docs/settings.md index 55f9127..c9b0159 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -69,11 +69,11 @@ import com.marketdata.sdk.DateFormat; client.stocks().dateFormat(DateFormat.TIMESTAMP); ``` -| Value | Description | -|---|---| -| `UNIX` | Unix timestamp in seconds (e.g. `1609362000`) | -| `TIMESTAMP` | ISO-8601 timestamp (e.g. `2020-12-30 16:00:00 -05:00`) | -| `SPREADSHEET` | Excel/Sheets serial date number (e.g. `44195.66667`) | +| Value | Description | +|---------------|--------------------------------------------------------| +| `UNIX` | Unix timestamp in seconds (e.g. `1609362000`) | +| `TIMESTAMP` | ISO-8601 timestamp (e.g. `2020-12-30 16:00:00 -05:00`) | +| `SPREADSHEET` | Excel/Sheets serial date number (e.g. `44195.66667`) | For more details, see the [API Date Format documentation](https://www.marketdata.app/docs/api/universal-parameters/date-format). @@ -88,11 +88,11 @@ import com.marketdata.sdk.Mode; client.stocks().mode(Mode.CACHED); ``` -| Value | Description | -|---|---| -| `LIVE` | Real-time data (paid plans) | -| `DELAYED` | 15+ minute delayed data | -| `CACHED` | Cached data — lower cost per request | +| Value | Description | +|-----------|--------------------------------------| +| `LIVE` | Real-time data (paid plans) | +| `DELAYED` | 15+ minute delayed data | +| `CACHED` | Cached data — lower cost per request | For more details, see the [API Data Mode documentation](https://www.marketdata.app/docs/api/universal-parameters/mode). @@ -153,10 +153,10 @@ csv.saveToFile(Path.of("quotes.csv")) ## Environment Variables Reference -| Variable | Purpose | Default | -|--------------------------|-------------------------------|------------------------------| -| `MARKETDATA_TOKEN` | API authentication token | _(none)_ | -| `MARKETDATA_BASE_URL` | API base URL | `https://api.marketdata.app` | -| `MARKETDATA_API_VERSION` | API version | `v1` | -| `MARKETDATA_DATE_FORMAT` | Default date format | _(API default)_ | -| `MARKETDATA_LOGGING_LEVEL` | SDK logging level (`java.util.logging`) | _(consumer default)_ | +| Variable | Purpose | Default | +|----------------------------|-----------------------------------------|------------------------------| +| `MARKETDATA_TOKEN` | API authentication token | _(none)_ | +| `MARKETDATA_BASE_URL` | API base URL | `https://api.marketdata.app` | +| `MARKETDATA_API_VERSION` | API version | `v1` | +| `MARKETDATA_DATE_FORMAT` | Default date format | _(API default)_ | +| `MARKETDATA_LOGGING_LEVEL` | SDK logging level (`java.util.logging`) | _(consumer default)_ |