Skip to content
Merged
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
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,8 @@ client
});
```

Accounts already upgraded to the unified V5 account can get error 6023 ("The current API version has expired. Please upgrade to the V5 interface") on legacy USDT-M private calls such as `getLinearSwapCrossAccountInfo` and `submitLinearSwapCrossOrder`. Use the `getMultiAsset*` and `submitMultiAsset*` methods (cancel, update, close, and margin helpers are named the same way). Accounts that are not on the unified V5 account can keep the legacy methods. Those methods stay in the SDK.

See [FuturesClient](./src/FuturesClient.ts) for further information.

## WebSockets
Expand All @@ -339,7 +341,7 @@ Key WebSocket features:

- Event driven messaging
- Smart WebSocket persistence with automatic reconnection
- Heartbeat mechanisms to detect disconnections
- Heartbeat mechanisms to detect disconnections. Futures public sockets (`linearSwapPublic`) allow 200 concurrent connections per IP per backend instance, with no minute-level connect-rate limit. Going over that cap returns error 4000. A connection with no ping for 25 seconds is closed without notice. The SDK default `pingInterval` is 10 seconds.
- Automatic resubscription after reconnection
- Support for Spot and Derivatives markets (linear swap, coin swap, delivery)
- Support for both public and private WebSocket streams
Expand Down Expand Up @@ -403,6 +405,11 @@ wsClient.subscribe(
WS_KEY_MAP.linearSwapPublic,
);

// Futures public WS (linearSwapPublic): 200 connections per IP per backend
// instance, no per-minute connect cap. Over the cap returns error 4000.
// A socket with no ping for 25s is closed with no notice. The SDK pings
// on pingInterval (default 10s) and answers server pings.

// Derivatives index/mark price streams
wsClient.subscribe(
['market.BTC-USDT.index.1min', 'market.BTC-USDT.mark_price.1min'],
Expand Down
Loading