> ## Documentation Index
> Fetch the complete documentation index at: https://whitebit-mintlify-fix-broken-links-1776643999.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# WhiteBIT API Changelog

> Track updates, improvements, and fixes to the WhiteBIT API platform including new endpoints and changes.

<Update label="Coming soon">
  ## Reduce-only order parameter

  **Position-closing guarantee for collateral orders**

  A new `reduceOnly` boolean parameter for collateral order endpoints. When set to `true`, the order can only decrease or close an existing position — the order never increases the position or opens a new one.

  **Behavior:**

  * If the order amount exceeds the current position size, the system automatically reduces the order to match
  * The API returns error code `116` if no open position exists or the order direction matches the position direction
  * Pending reduce-only orders are auto-canceled with status `AUTO_CANCELED_REDUCE_ONLY` when the associated position closes

  **Supported on 6 collateral order creation endpoints:**

  <CardGroup cols={3}>
    <Card title="Collateral Limit Order" href="/api-reference/collateral-trading/collateral-limit-order" icon="chart-line" horizontal />

    <Card title="Collateral Bulk Limit Order" href="/api-reference/collateral-trading/collateral-bulk-limit-order" icon="layer-group" horizontal />

    <Card title="Collateral Market Order" href="/api-reference/collateral-trading/collateral-market-order" icon="bolt" horizontal />

    <Card title="Collateral Stop-Limit Order" href="/api-reference/collateral-trading/collateral-stop-limit-order" icon="hand" horizontal />

    <Card title="Collateral Trigger Market Order" href="/api-reference/collateral-trading/collateral-trigger-market-order" icon="crosshairs" horizontal />

    <Card title="Collateral OCO Order" href="/api-reference/collateral-trading/create-collateral-oco-order" icon="code-branch" horizontal />
  </CardGroup>

  The `reduceOnly` field also appears in the response of [query active orders](/api-reference/spot-trading/query-unexecuted-orders), [query executed orders](/api-reference/spot-trading/query-executed-orders), and [query conditional orders](/api-reference/collateral-trading/query-unexecuted-conditional-orders).

  **WebSocket channels:**

  The `reduce_only` field is added to the [Orders Pending](/websocket/account-streams/orders-pending) and [Orders Executed](/websocket/account-streams/orders-executed) channels — both in query responses and real-time update events.
</Update>

## Previous Changes

<Update label="March 6, 2026">
  ## Mining Pool API

  **Comprehensive mining pool management endpoints**

  Introduced a complete Mining Pool API with 10 endpoints for managing mining operations, including account monitoring, payout configuration, worker management, and watcher link generation.

  **Public endpoints:**

  * Pool statistics and connection information

  **Mining account management:**

  * Reward history with pagination
  * Account-level hashrate monitoring with configurable intervals (5m, 1h, 24h)
  * Fee and stratum connection details

  **Payout configuration:**

  * Get and set payout destination (main balance or external BTC address)
  * Support for all standard Bitcoin address formats

  **Worker monitoring:**

  * List online workers with pagination
  * Individual worker hashrate history

  **Watcher links:**

  * Create read-only access links with granular permissions (dashboard, rewards, workers)
  * Configurable expiration periods (1h, 24h, 7d, always)
  * List active watcher links

  All authenticated endpoints require the MINING\_POOL feature to be enabled on the API key.

  <CardGroup cols={3}>
    <Card title="Pool Overview" href="/api-reference/mining-pool/pool-overview" icon="chart-simple" horizontal />

    <Card title="Get Rewards" href="/api-reference/mining-pool/get-rewards" icon="coins" horizontal />

    <Card title="Account Hashrate" href="/api-reference/mining-pool/account-hashrate" icon="chart-line" horizontal />

    <Card title="Get Payout Destination" href="/api-reference/mining-pool/get-payout-destination" icon="wallet" horizontal />

    <Card title="Set Payout Destination" href="/api-reference/mining-pool/set-payout-destination" icon="pen-to-square" horizontal />

    <Card title="Miner Info" href="/api-reference/mining-pool/miner-info" icon="info" horizontal />

    <Card title="Worker Names" href="/api-reference/mining-pool/worker-names" icon="users" horizontal />

    <Card title="Worker Hashrate" href="/api-reference/mining-pool/worker-hashrate" icon="gauge" horizontal />

    <Card title="Create Watcher Link" href="/api-reference/mining-pool/create-watcher-link" icon="link" horizontal />

    <Card title="List Watcher Links" href="/api-reference/mining-pool/list-watcher-links" icon="list" horizontal />
  </CardGroup>
</Update>

<Update label="March 6, 2026">
  ## Mining Account Management

  **Create and list mining accounts**

  Added endpoints to create and manage mining pool accounts programmatically.

  **Account creation:**

  * Create named mining accounts with optional referral codes
  * Unique account names with alphanumeric and underscore support
  * Automatic validation for duplicate names

  **Account listing:**

  * Retrieve all mining accounts or filter by name
  * Results sorted by creation date (newest first)

  All endpoints require the MINING\_POOL feature to be enabled on the API key.

  <CardGroup cols={2}>
    <Card title="Create Mining Account" href="/api-reference/mining-pool/create-mining-account" icon="plus" horizontal />

    <Card title="Get Mining Accounts" href="/api-reference/mining-pool/get-mining-accounts" icon="list" horizontal />
  </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**

  Refined the description of the Book Ticker WebSocket stream to explicitly state instant BBO snapshot with incremental updates.

  <Card title="ws - Book Ticker" href="/websocket/market-streams/book-ticker" icon="ticket" horizontal />
</Update>

<Update label="September 21, 2025">
  ## Flex Earn Endpoints

  **Introduced Smart Flex private endpoints**

  Added documentation for Smart Flex (Flex Earn) endpoints: list plans, manage investments, view histories, and configure auto-reinvestment.

  <CardGroup cols={2}>
    <Card title="v4 - Get Flex Plans" href="/api-reference/account-wallet/get-flex-plans" icon="list" horizontal />

    <Card title="v4 - Get User Flex Investments" href="/api-reference/account-wallet/get-user-flex-investments" icon="wallet" horizontal />

    <Card title="v4 - Get Flex Investment History" href="/api-reference/account-wallet/get-flex-investment-history" icon="book" horizontal />

    <Card title="v4 - Get Flex Payment History" href="/api-reference/account-wallet/get-flex-payment-history" icon="credit-card" horizontal />

    <Card title="v4 - Create Flex Investment" href="/api-reference/account-wallet/create-flex-investment" icon="plus" horizontal />

    <Card title="v4 - Withdraw from Flex Investment" href="/api-reference/account-wallet/withdraw-from-flex-investment" icon="arrow-down" horizontal />

    <Card title="v4 - Close Flex Investment" href="/api-reference/account-wallet/close-flex-investment" icon="x" horizontal />

    <Card title="v4 - Update Flex Auto-Reinvestment" href="/api-reference/account-wallet/update-flex-auto-reinvestment" icon="recycle" horizontal />
  </CardGroup>
</Update>

<Update label="July 16, 2025">
  ## API Documentation Updates

  **Enhanced Query executed orders documentation**

  Updated documentation for `/api/v4/trade-account/order/history` endpoint to clarify date range filtering capabilities with `startDate` and `endDate` parameters.

  <Card title="Trade API - Query executed orders" href="/api-reference/spot-trading/query-executed-orders" icon="shop" horizontal />
</Update>

<Update label="July 14, 2025">
  ## Public API Update

  **New Funding History endpoint**

  Added new endpoint `/api/v4/public/funding-history/{market}` to retrieve funding rate history for futures markets.

  <Card title="Public API - Funding History" href="/api-reference/market-data/funding-history" icon="clock-rotate-left" horizontal />
</Update>

<Update label="July 10, 2025">
  ## Private API Update

  **Issue JWT Token for Private API**

  New endpoint to issue JWT token for private API access.

  <Card title="v4 - Issue JWT Token" href="/api-reference/account-wallet/issue-jwt-token" icon="key" horizontal />

  **Issue card token using JWT**

  New endpoint to issue a card token using JWT for secure transactions.

  <Card title="v4 - Issue Card Token" href="/api-reference/account-wallet/issue-card-token" icon="credit-card" horizontal />

  **Withdraw endpoint update**

  Address now accepts card tokens for withdrawals.

  <Card title="v4 - Create Withdraw Request" href="/api-reference/account-wallet/create-withdraw-request" icon="arrow-up-from-bracket" horizontal />
</Update>

<Update label="July 9, 2025">
  ## 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.

  <Card title="ws - Book Ticker" href="/websocket/market-streams/book-ticker" icon="ticket" horizontal />
</Update>

<Update label="July 9, 2025">
  ## Trade Engine Update

  **Event time and update id introduced in WebSocket events**

  WebSocket events now include `event_time` and `update_id` fields. The `event_time` field provides the timestamp of the event, while the `update_id` field is a unique identifier for each update, allowing for better tracking and synchronization of events.

  <Card title="ws - Market Depth Subscribe" href="/websocket/market-streams/depth" icon="store" horizontal />

  **Hedge mode support**

  The Hedge mode is now available for all users. This mode allows holding both long and short positions in the same asset simultaneously, providing greater flexibility in managing trades.

  <CardGroup cols={2}>
    <Card title="v4 - Collateral Limit Order" href="/api-reference/collateral-trading/collateral-limit-order" icon="sliders" horizontal />

    <Card title="v4 - Collateral Stop Limit Order" href="/api-reference/collateral-trading/collateral-stop-limit-order" icon="flag" horizontal />

    <Card title="v4 - Collateral Market Order" href="/api-reference/collateral-trading/collateral-market-order" icon="store" horizontal />

    <Card title="v4 - Collateral OCO Order" href="/api-reference/collateral-trading/create-collateral-oco-order" icon="split" horizontal />

    <Card title="v4 - Collateral Trigger Market Order" href="/api-reference/collateral-trading/collateral-trigger-market-order" icon="rocket" horizontal />

    <Card title="v4 - Collateral Account Hedge Mode" href="/api-reference/collateral-trading/collateral-account-hedge-mode" icon="shield" horizontal />

    <Card title="v4 - Update Collateral Account Hedge Mode" href="/api-reference/collateral-trading/update-collateral-account-hedge-mode" icon="shield-check" horizontal />

    <Card title="ws - Orders Pending" href="/websocket/account-streams/orders-pending" icon="clock" horizontal />

    <Card title="ws - Orders Executed" href="/websocket/account-streams/orders-executed" icon="check" horizontal />

    <Card title="ws - Positions" href="/websocket/account-streams/positions" icon="chart-bar" horizontal />
  </CardGroup>

  **Queries Limited to the Last 6 Months**

  To enhance performance and focus on the most relevant data, the API limits data queries to the past 6 months. Data can be retrieved up to six months old from the current date.

  <CardGroup cols={2}>
    <Card title="v4 - Convert History" href="/api-reference/convert/convert-history" icon="book" horizontal />

    <Card title="v4 - Executed order deals" href="/api-reference/spot-trading/query-executed-order-deals" icon="handshake" horizontal />

    <Card title="v4 - Executed orders" href="/api-reference/spot-trading/query-executed-orders" icon="check" horizontal />

    <Card title="v4 - Unexecuted (active) conditional orders" href="/api-reference/collateral-trading/query-unexecuted-conditional-orders" icon="clock" horizontal />

    <Card title="v4 - Collateral bulk limit order" href="/api-reference/collateral-trading/collateral-bulk-limit-order" icon="grid" horizontal />

    <Card title="v4 - Executed order history" href="/api-reference/spot-trading/query-executed-order-history" icon="book" horizontal />

    <Card title="v4 - Positions history" href="/api-reference/collateral-trading/positions-history" icon="chart-bar" horizontal />
  </CardGroup>
</Update>

<Update label="May 28, 2025">
  ## Withdraw update

  **HTTP Main V4 API - Withdraw**

  The `paymentDescription` field is now mandatory for withdrawal requests from whitebit-tr.com.

  <Card title="v4 - Withdraw" href="/api-reference/account-wallet/create-withdraw-request" icon="arrow-down" horizontal />
</Update>

<Update label="May 18, 2025">
  ## Travel Rule Update

  **HTTP Main V4 API - Travel Rule**

  Added new statuses DEPOSIT\_TRAVEL\_RULE\_FROZEN (27) and DEPOSIT\_TRAVEL\_RULE\_FROZEN\_PROCESSING (28) to the deposit endpoint.

  <Card title="v4 - Get Deposit/Withdraw History" href="/api-reference/account-wallet/get-deposit-withdraw-history" icon="book" horizontal />
</Update>

<Update label="May 14, 2025">
  ## Convert History Update

  **HTTP Trade V4 API - Convert**

  Added 30 days date range limit for convert history and default values for `from` and `to` parameters.

  <Card title="v4 - Convert History" href="/api-reference/convert/convert-history" icon="book" horizontal />
</Update>

<Update label="March 30, 2025">
  ## Deposit and Withdrawal Updates

  **HTTP Main V4 API - Birth Date Addition**

  Added beneficiary.birthDate field (Format: YYYY-MM-DD) to withdrawal requests and customer.birthDate (Format: YYYY-MM-DD) to deposit requests.

  <CardGroup cols={2}>
    <Card title="v4 - Withdraw" href="/api-reference/account-wallet/create-withdraw-request" icon="arrow-down" horizontal />

    <Card title="v4 - Fiat Deposit" href="/api-reference/account-wallet/get-fiat-deposit-address" icon="arrow-up" horizontal />
  </CardGroup>
</Update>
