Skip to content

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

Choose a tag to compare

@tiagosiebler tiagosiebler released this 17 Nov 11:45
8967fb5

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