Skip to content

Commit 012bc2a

Browse files
MarketDataAppgithub-actions[bot]
authored andcommitted
docs: sync from documentation@55164185fe511ca702da688caec0b042df83ceda
1 parent 9dccddf commit 012bc2a

3 files changed

Lines changed: 29 additions & 29 deletions

File tree

docs/client.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -273,15 +273,15 @@ response.saveToFile(Path.of("aapl.json")); // cache the raw body
273273

274274
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()`.
275275

276-
| Subtype | When it's thrown |
277-
|---|---|
278-
| `AuthenticationError` | Missing or invalid token (HTTP 401) |
279-
| `BadRequestError` | Invalid parameters (HTTP 4xx) |
280-
| `NotFoundError` | The resource doesn't exist (HTTP 404) |
281-
| `RateLimitError` | Quota exceeded (HTTP 429); see `getRetryAfter()` |
282-
| `ServerError` | API-side failure (HTTP 5xx) |
283-
| `NetworkError` | Connection failure or timeout |
284-
| `ParseError` | The response could not be decoded |
276+
| Subtype | When it's thrown |
277+
|-----------------------|--------------------------------------------------|
278+
| `AuthenticationError` | Missing or invalid token (HTTP 401) |
279+
| `BadRequestError` | Invalid parameters (HTTP 4xx) |
280+
| `NotFoundError` | The resource doesn't exist (HTTP 404) |
281+
| `RateLimitError` | Quota exceeded (HTTP 429); see `getRetryAfter()` |
282+
| `ServerError` | API-side failure (HTTP 5xx) |
283+
| `NetworkError` | Connection failure or timeout |
284+
| `ParseError` | The response could not be decoded |
285285

286286
Async calls surface the same exceptions through the `CompletableFuture` (wrapped in a `CompletionException`); the sync wrappers unwrap them so you catch the cause directly.
287287

docs/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Add the SDK as a dependency. The published artifact is a single JAR; it does **n
1616
```kotlin
1717
// build.gradle.kts
1818
dependencies {
19-
implementation("app.marketdata:marketdata-sdk-java:1.0.0")
19+
implementation("app.marketdata:marketdata-sdk-java:0.1.0")
2020
}
2121
```
2222

@@ -25,7 +25,7 @@ dependencies {
2525
```groovy
2626
// build.gradle
2727
dependencies {
28-
implementation 'app.marketdata:marketdata-sdk-java:1.0.0'
28+
implementation 'app.marketdata:marketdata-sdk-java:0.1.0'
2929
}
3030
```
3131

@@ -35,7 +35,7 @@ dependencies {
3535
<dependency>
3636
<groupId>app.marketdata</groupId>
3737
<artifactId>marketdata-sdk-java</artifactId>
38-
<version>1.0.0</version>
38+
<version>0.1.0</version>
3939
</dependency>
4040
```
4141

docs/settings.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ import com.marketdata.sdk.DateFormat;
6969
client.stocks().dateFormat(DateFormat.TIMESTAMP);
7070
```
7171

72-
| Value | Description |
73-
|---|---|
74-
| `UNIX` | Unix timestamp in seconds (e.g. `1609362000`) |
75-
| `TIMESTAMP` | ISO-8601 timestamp (e.g. `2020-12-30 16:00:00 -05:00`) |
76-
| `SPREADSHEET` | Excel/Sheets serial date number (e.g. `44195.66667`) |
72+
| Value | Description |
73+
|---------------|--------------------------------------------------------|
74+
| `UNIX` | Unix timestamp in seconds (e.g. `1609362000`) |
75+
| `TIMESTAMP` | ISO-8601 timestamp (e.g. `2020-12-30 16:00:00 -05:00`) |
76+
| `SPREADSHEET` | Excel/Sheets serial date number (e.g. `44195.66667`) |
7777

7878
For more details, see the [API Date Format documentation](https://www.marketdata.app/docs/api/universal-parameters/date-format).
7979

@@ -88,11 +88,11 @@ import com.marketdata.sdk.Mode;
8888
client.stocks().mode(Mode.CACHED);
8989
```
9090

91-
| Value | Description |
92-
|---|---|
93-
| `LIVE` | Real-time data (paid plans) |
94-
| `DELAYED` | 15+ minute delayed data |
95-
| `CACHED` | Cached data — lower cost per request |
91+
| Value | Description |
92+
|-----------|--------------------------------------|
93+
| `LIVE` | Real-time data (paid plans) |
94+
| `DELAYED` | 15+ minute delayed data |
95+
| `CACHED` | Cached data — lower cost per request |
9696

9797
For more details, see the [API Data Mode documentation](https://www.marketdata.app/docs/api/universal-parameters/mode).
9898

@@ -153,10 +153,10 @@ csv.saveToFile(Path.of("quotes.csv"))
153153

154154
## Environment Variables Reference
155155

156-
| Variable | Purpose | Default |
157-
|--------------------------|-------------------------------|------------------------------|
158-
| `MARKETDATA_TOKEN` | API authentication token | _(none)_ |
159-
| `MARKETDATA_BASE_URL` | API base URL | `https://api.marketdata.app` |
160-
| `MARKETDATA_API_VERSION` | API version | `v1` |
161-
| `MARKETDATA_DATE_FORMAT` | Default date format | _(API default)_ |
162-
| `MARKETDATA_LOGGING_LEVEL` | SDK logging level (`java.util.logging`) | _(consumer default)_ |
156+
| Variable | Purpose | Default |
157+
|----------------------------|-----------------------------------------|------------------------------|
158+
| `MARKETDATA_TOKEN` | API authentication token | _(none)_ |
159+
| `MARKETDATA_BASE_URL` | API base URL | `https://api.marketdata.app` |
160+
| `MARKETDATA_API_VERSION` | API version | `v1` |
161+
| `MARKETDATA_DATE_FORMAT` | Default date format | _(API default)_ |
162+
| `MARKETDATA_LOGGING_LEVEL` | SDK logging level (`java.util.logging`) | _(consumer default)_ |

0 commit comments

Comments
 (0)