v3.1.2: Add new broker & index components V3 endpoints

What's Changed

• feat(v3.1.2): add new broker & index components v3 endpoints by @JJ-Cro in #122

Full Changelog: v3.1.1...v3.1.2

v3.1.1: Fix missing APIResponse export

What's Changed

• fix(v3.1.1, #119): export APIResponse properly by @tiagosiebler in #120

Full Changelog: v3.1.0...v3.1.1

v3.1.0: Remove deprecated V1 functionality. Add beta release support to release workflow. Update wsOptions type to reflect full functionality. Minor dependency updates around WebPack.

What's Changed

• chore(v3.0.13): remove deprecated V1 API clients and examples by @JJ-Cro in #114
• chore: update NPM publish workflow to trigger on release events and handle prerelease tags by @JJ-Cro in #115
• chore(): README.md template sections by @tiagosiebler in #117
• chore: enhance WSClientConfigurableOptions to support additional WebSocket and HTTP client options by @JJ-Cro in #116
• feat(v3.1.0): update webpack, remove deprecated V1 functionality, expand wsOptions type definition by @tiagosiebler in #118

Full Changelog: v3.0.12...v3.1.0

v3.0.12: Readme updates, bump axios

What's Changed

• chore(): README.md template sections by @tiagosiebler in #112
• [Snyk] Upgrade axios from 1.13.1 to 1.13.2 by @tiagosiebler in #111
• chore(v3.0.12): release for readme updates by @tiagosiebler in #113

Full Changelog: v3.0.11...v3.0.12

v3.0.11: Add new open interest & tax record endpoints, type/example updates, bump axios, ts-loader and js-yaml dependencies

What's Changed

• [Snyk] Upgrade axios from 1.12.2 to 1.13.1 by @tiagosiebler in #105
• [Snyk] Upgrade ts-loader from 9.4.1 to 9.5.4 by @tiagosiebler in #107
• chore(deps-dev): bump js-yaml from 3.14.1 to 3.14.2 by @dependabot[bot] in #104
• feat(v3.0.11): add new endpoints for open interest limit and tax records, update request/response types, and include example scripts by @JJ-Cro in #109

Full Changelog: v3.0.10...v3.0.11

v3.0.10: Add new broker and futures endpoints, bump axios

What's Changed

• feat(v3.0.10): add new broker and futures endpoints, and update request/response types by @JJ-Cro in #103
• [Snyk] Upgrade axios from 1.12.0 to 1.12.2 by @tiagosiebler in #97

V2 REST Client Changes

Broker Endpoints (3 new endpoints)

1. getBrokerTotalCommission()

• Endpoint: GET /api/v2/broker/total-commission
• Rate Limit: 20 req/sec/UID
• Description: Get total commission data with daily granularity
• Features:
  • Data retention: 365 days (from 2025/6/1)
  • Returns spot and futures commission breakdown
  • T+1 data updates (UTC+8)
  • Supports optional date range filtering

2. getBrokerOrderCommission()

• Endpoint: GET /api/v2/broker/order-commission
• Rate Limit: 20 req/sec/UID
• Description: Get order-level commission details
• Features:
  • Data retention: 30 days (from 2025/9/1)
  • Transaction-level commission data
  • Pagination support with cursor
  • Shows only orders marked with broker channel ID

3. getBrokerRebateInfo()

• Endpoint: GET /api/v2/broker/rebate-info
• Rate Limit: 20 req/sec/UID
• Description: Get real-time rebate information for a specific UID
• Features:
  • Real-time data
  • Returns affiliation type, user level, and rebate ratios
  • Separate ratios for spot and futures trading

Futures Account Endpoints (3 new endpoints)

4. getFuturesMaxOpenableQuantity()

• Endpoint: GET /api/v2/mix/account/max-open
• Rate Limit: 20 req/sec/UID
• Description: Calculate maximum openable quantity for a position
• Features:
  • Supports both limit and market orders
  • Configurable position side (long/short)
  • Margin coin specification

5. getFuturesLiquidationPrice()

• Endpoint: GET /api/v2/mix/account/liq-price
• Rate Limit: 20 req/sec/UID
• Description: Get estimated liquidation price for a position
• Features:
  • Requires margin amount and position details
  • Supports both limit and market order types
  • Returns estimated liquidation price

6. getFuturesIsolatedSymbols()

• Endpoint: GET /api/v2/mix/account/isolated-symbols
• Rate Limit: 10 req/1s/UID
• Description: Query trading pairs with isolated margin mode
• Features:
  • Returns symbols using isolated margin
  • Product type filtering (USDT/COIN/USDC futures)

---

V3 REST Client Changes

Account Endpoint (1 new endpoint)

7. getMaxTransferable()

• Endpoint: GET /api/v3/account/max-transferable
• Rate Limit: 3 req/sec/UID
• Permission: UTA mgt. (read)
• Description: Get maximum transferable amount for unified account
• Features:
  • Returns max transferable amount
  • Returns max transferable amount for borrowed coins
  • Coin-specific queries

---

Technical Changes

Type Definitions Added

V2 Request Types (src/types/request/v2/):

• GetBrokerTotalCommissionRequestV2
• GetBrokerOrderCommissionRequestV2
• GetBrokerRebateInfoRequestV2
• FuturesMaxOpenRequestV2
• FuturesLiquidationPriceRequestV2
• FuturesIsolatedSymbolsRequestV2

V2 Response Types (src/types/response/v2/):

• BrokerTotalCommissionV2
• BrokerOrderCommissionV2 & BrokerOrderCommissionItemV2
• BrokerRebateInfoV2
• FuturesMaxOpenV2
• FuturesLiquidationPriceV2
• FuturesIsolatedSymbolV2

V3 Request Types (src/types/request/v3/):

• GetMaxTransferableRequestV3

V3 Response Types (src/types/response/v3/):

• MaxTransferableV3

Files Modified

• src/rest-client-v2.ts - Added 6 new methods with JSDoc
• src/rest-client-v3.ts - Added 1 new method with JSDoc
• src/types/request/v2/broker.ts - Added 3 request interfaces
• src/types/response/v2/broker.ts - Added 3 response interfaces
• src/types/request/v2/futures.ts - Added 3 request interfaces
• src/types/response/v2/futures.ts - Added 3 response interfaces
• src/types/request/v3/account.ts - Added 1 request interface
• src/types/response/v3/account.ts - Added 1 response interface

Full Changelog: v3.0.9...v3.0.10

v3.0.9: Safer internal exception logger for WSAPIClient

Previously running a JSON.stringify call within the WebsocketAPIClient exception handler could in rare circumstances lead to a circular reference. This handles that scenario in a safer way.

What's Changed

• chore(3.0.9): Update wsapi error handling, bump version by @JJ-Cro in #102

Full Changelog: v3.0.8...v3.0.9

v3.0.8: Update return types for getFuturesHistoricFundingRates & getFuturesCurrentFundingRate

What's Changed

• chore(): upd getFuturesHistoricFundingRates and getFuturesCurrentFundingRate responses by @lutogin in #100
• fix(v3.0.8, #100): update getFuturesHistoricFundingRates and getFuturesCurrentFundingRate return types by @tiagosiebler in #101

New Contributors

• @lutogin made their first contribution in #100

Full Changelog: v3.0.7...v3.0.8

v3.0.7: Add new union and broker endpoints

What's Changed

• feat(v3.0.7): add missing endpoints by @JJ-Cro in #96 - resolves #95

Full Changelog: v3.0.6...v3.0.7

v3.0.6: GET request method for sub deposit/withdrawal records

What's Changed

• [Snyk] Security upgrade axios from 1.11.0 to 1.12.0 by @tiagosiebler in #91
• chore(): update tests by @JJ-Cro in #92
• fix(v3.0.6): GET request method for sub deposit/withdrawal records by @tiagosiebler in #93

Full Changelog: v3.0.5...v3.0.6