Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@

**Mining account management:**
- Reward history with pagination
- Account-level hashrate monitoring with configurable intervals (5m, 1h, 24h)

Check warning on line 49 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (whitebit) - vale-spellcheck

changelog.mdx#L49

Did you really mean 'hashrate'?
- Fee and stratum connection details

**Payout configuration:**
Expand All @@ -55,7 +55,7 @@

**Worker monitoring:**
- List online workers with pagination
- Individual worker hashrate history

Check warning on line 58 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (whitebit) - vale-spellcheck

changelog.mdx#L58

Did you really mean 'hashrate'?

**Watcher links:**
- Create read-only access links with granular permissions (dashboard, rewards, workers)
Expand Down Expand Up @@ -101,22 +101,6 @@
</CardGroup>
</Update>

<Update label="February 11, 2025">
## API Documentation Updates
**Sub-account transfer endpoints: add transactionId for correlation**

The response of `/api/v4/sub-account/transfer` and `/api/v4/sub-account/transfer/history` includes the `transactionId` field.

Use `transactionId` to correlate transfer operations with transfer history records.

The `id` field in transfer history is deprecated. Replace `id` with `transactionId`.

<CardGroup cols={2}>
<Card title="Sub-Account Transfer" href="/api-reference/sub-accounts/sub-account-transfer" icon="arrow-right-arrow-left" horizontal/>
<Card title="Get Sub-Account Transfer History" href="/api-reference/sub-accounts/get-sub-account-transfer-history" icon="clock-rotate-left" horizontal/>
</CardGroup>
</Update>

<Update label="September 21, 2025">
## Documentation Updates
**Clarified Book Ticker stream update interval**
Expand Down Expand Up @@ -144,6 +128,22 @@
</CardGroup>
</Update>

<Update label="February 11, 2025">
## API Documentation Updates
**Sub-account transfer endpoints: add transactionId for correlation**

Check warning on line 133 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (whitebit) - vale-spellcheck

changelog.mdx#L133

Did you really mean 'transactionId'?

The response of `/api/v4/sub-account/transfer` and `/api/v4/sub-account/transfer/history` includes the `transactionId` field.

Use `transactionId` to correlate transfer operations with transfer history records.

The `id` field in transfer history is deprecated. Replace `id` with `transactionId`.

<CardGroup cols={2}>
<Card title="Sub-Account Transfer" href="/api-reference/sub-accounts/sub-account-transfer" icon="arrow-right-arrow-left" horizontal/>
<Card title="Get Sub-Account Transfer History" href="/api-reference/sub-accounts/get-sub-account-transfer-history" icon="clock-rotate-left" horizontal/>
</CardGroup>
</Update>

<Update label="July 16, 2025">
## API Documentation Updates
**Enhanced Query executed orders documentation**
Expand Down Expand Up @@ -188,7 +188,7 @@
## Public WebSocket Update
**Added BookTicker WebSocket stream**

New bookTicker stream added to WebSocket API, providing real-time updates of best bid/ask prices and quantities for markets. Includes subscription (bookTicker_subscribe) and unsubscription (bookTicker_unsubscribe) methods for managing the data feed.

Check warning on line 191 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (whitebit) - vale-spellcheck

changelog.mdx#L191

Did you really mean 'bookTicker'?

Check warning on line 191 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (whitebit) - vale-spellcheck

changelog.mdx#L191

Did you really mean 'bookTicker_subscribe'?

Check warning on line 191 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (whitebit) - vale-spellcheck

changelog.mdx#L191

Did you really mean 'unsubscription'?

Check warning on line 191 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (whitebit) - vale-spellcheck

changelog.mdx#L191

Did you really mean 'bookTicker_unsubscribe'?

<Card title="ws - Book Ticker" href="/websocket/market-streams/book-ticker" icon="ticket" horizontal/>
</Update>
Expand Down
2 changes: 1 addition & 1 deletion platform/colocation.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Colocation Services"

Check warning on line 2 in platform/colocation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (whitebit) - vale-spellcheck

platform/colocation.mdx#L2

Did you really mean 'Colocation'?
sidebarTitle: "Colocation"
description: "WhiteBIT offers professional-grade [colocation](https://docs.whitebit.com/glossary/#colocation) services for [high-frequency trading (HFT)](https://docs.whitebit.com/glossary/#high-frequency-trading-hft) and algorithmic trading operations. Place trading servers close to the exchange’s [matching engine](https://docs.whitebit.com/glossary/#matching-engine) to achieve minimal [latency](https://docs.whitebit.com/glossary/#latency) and enhanced trading performance."
---
Expand Down Expand Up @@ -31,7 +31,7 @@
#### Network Setup
- Network Speed: 10Gbit connectivity required
- Instance Type: Dedicated EC2 instances (recommended)
- Security: IP address pool required for allowlisting

Check warning on line 34 in platform/colocation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (whitebit) - vale-spellcheck

platform/colocation.mdx#L34

Did you really mean 'allowlisting'?

#### Region Selection
- Primary: eu-central-1a (recommended)
Expand All @@ -41,7 +41,7 @@
</Step>
<Step title="Technical Integration">
The technical team will assist with:
- Network configuration including aws cloud latency optimized proxy
- Network configuration including AWS cloud latency optimized proxy
- Performance testing
- Trading system integration
</Step>
Expand Down
2 changes: 1 addition & 1 deletion platform/oauth/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ When the access token expires, the application can use a refresh token to obtain
</Steps>
## Use Cases

#### Trading Bots & Algorithmic Trading
### Trading Bots & Algorithmic Trading
Enable automated trading strategies without storing WhiteBIT credentials in third-party systems. Trading bots can place, modify, and cancel orders while only having the specific permissions they need.

### Portfolio Trackers & Analytics
Expand Down
12 changes: 6 additions & 6 deletions platform/webhook.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ Passing one of these checks enables the webhook.

### For processing web-hook requests

All web hook requests are performing using POST method and with application/json content type. Consumer server should respond with 200 HTTP status code. If consumer was unable to handle web-hook, the request will be retry every 10 minutes but not more than 5 times.
All webhook requests are performed using the POST method with application/json content type. The consumer server should respond with a 200 HTTP status code. If the consumer was unable to handle the webhook, the request will be retried every 10 minutes but not more than 5 times.

#### Body data

All web-hook requests are performing with
All webhook requests are performed with

```json
{
Expand All @@ -86,12 +86,12 @@ All web-hook requests are performing with

#### Request headers

Also, all request contains additional data in headers:
Also, all requests contain additional data in headers:

1. `'Content-type': 'application/json'`
2. `'X-TXC-APIKEY': api_key` - the WhiteBIT webhook API key
3. `'X-TXC-PAYLOAD': payload'` - where payload is base64-encoded body data
4. `'X-TXC-SIGNATURE': signature` - where signature is `hex(HMAC_SHA512(payload), key=api_secret))`
3. `'X-TXC-PAYLOAD': payload` - where payload is base64-encoded body data
4. `'X-TXC-SIGNATURE': signature` - where signature is `hex(HMAC_SHA512(payload), key=api_secret)`

On the consumer side, process the security headers to verify the request originated from WhiteBIT.

Expand Down Expand Up @@ -143,7 +143,7 @@ Performed when deposit was accepted. Request example:
}
```

Performed when deposit was update. Request example:
Performed when deposit was updated. Request example:

```json
{
Expand Down