Merge pull request #398 from tiagosiebler/wsapi
v4.0.0: WebSocket API, WebsocketClient upgrades, decommission deprecated v1-v3 API groups
This commit is contained in:
Tiago
513
README.md
513
README.md
@@ -19,21 +19,66 @@
|
||||
|
||||
[1]: https://www.npmjs.com/package/bybit-api
|
||||
|
||||
Node.js & JavaScript SDK for the Bybit REST APIs and WebSockets:
|
||||
Professional Node.js, JavaScript & TypeScript SDK for the Bybit REST APIs and WebSockets:
|
||||
|
||||
- Complete integration with all Bybit REST APIs & WebSockets.
|
||||
- Complete integration with all Bybit REST APIs & WebSockets, including the WebSocket API.
|
||||
- Actively maintained with a modern, promise-driven interface.
|
||||
- TypeScript support (with type declarations for most API requests & responses).
|
||||
- Over 450 end-to-end tests making real API calls & WebSocket connections, validating any changes before they reach npm.
|
||||
- Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
|
||||
- Event driven messaging.
|
||||
- TypeScript support (thorough type declarations for most API requests & responses, including WS API).
|
||||
- JavaScript support (TypeScript not required but definitely recommended).
|
||||
- Thorough & automatic end-to-end tests making real API calls & WebSocket connections, validating any changes before they reach npm.
|
||||
- Proxy support via axios integration.
|
||||
- Robust WebSocket consumer integration with configurable heartbeats & automatic reconnect then resubscribe workflows.
|
||||
- Event driven messaging
|
||||
- Smart websocket persistence
|
||||
- Automatically handle silent websocket disconnections through timed heartbeats, including the scheduled 24hr disconnect.
|
||||
- Automatically handle listenKey persistence and expiration/refresh.
|
||||
- Automatically handle authentication.
|
||||
- Emit `reconnected` event when dropped connection is restored.
|
||||
- Proxy support via axios integration.
|
||||
- WebSocket API integration, with two design patterns to choose from:
|
||||
- Asynchronous promise-driven responses:
|
||||
- Make requests like a REST API, using the WebSocket API. No need to subscribe to asynchronous events.
|
||||
- Send commands with the await sendWSAPIRequest(...) method.
|
||||
- Await responses to commands directly in the fully typed sendWSAPIRequest() call.
|
||||
- The method directly returns a promise. Use a try/catch block for convenient error handling without the complexity of asynchronous WebSockets.
|
||||
- See example for more details: [examples/ws-api-promises.ts](./examples/ws-api-promises.ts)
|
||||
- Asynchronous event-driven responses:
|
||||
- Subscribe to `response` and `error` events from WebsocketClient's event emitter.
|
||||
- Send commands with the sendWSAPIRequest(...) method.
|
||||
- Responses to commands will arrive via the `response` and `error` events.
|
||||
- See example for more details: [examples/ws-api-events.ts](./examples/ws-api-events.ts)
|
||||
- Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
|
||||
|
||||
# Table of Contents
|
||||
|
||||
## Overview
|
||||
- [Installation](#installation)
|
||||
- [Issues & Discussion](#issues--discussion)
|
||||
- [Related Projects](#related-projects)
|
||||
- [Documentation](#documentation)
|
||||
- [Examples](#examples)
|
||||
|
||||
## REST API Examples
|
||||
- [API Clients](#api-clients)
|
||||
- [REST API Usage](#rest-api-usage)
|
||||
|
||||
## WebSocket Integration & Examples
|
||||
- [WebSockets](#websockets)
|
||||
- [WebSocket Subscriptions - Consuming Events](#websocket-subscriptions---consuming-events)
|
||||
- [Websocket API - Sending Orders via WebSockets](#websocket-api---sending-orders-via-websockets)
|
||||
- [Consumer Load Balancing](#balancing-load-across-multiple-connections)
|
||||
|
||||
## Additional Features
|
||||
- [Logging](#logging)
|
||||
- [Customise Logging](#customise-logging)
|
||||
- [Debug HTTP Requests](#debug-http-requests)
|
||||
- [Browser Usage](#browser-usage)
|
||||
- [Import](#import)
|
||||
- [Webpack](#webpack)
|
||||
|
||||
## Contributing
|
||||
- [Contributions & Thanks](#contributions--thanks)
|
||||
|
||||
------
|
||||
|
||||
## Installation
|
||||
|
||||
`npm install --save bybit-api`
|
||||
@@ -68,7 +113,7 @@ Check out my related JavaScript/TypeScript/Node.js projects:
|
||||
|
||||
## Documentation
|
||||
|
||||
Most methods accept JS objects. These can be populated using parameters specified by Bybit's API documentation, or check the type definition in each class within the github repository (see table below for convenient links to each class).
|
||||
Most methods accept JS objects. These can be populated using parameters specified by Bybit's API documentation, or check the type definition in each class within the github repository (see table below for convenient links to each class). TypeScript is definitely recommended, but not required.
|
||||
|
||||
- [Bybit API Docs](https://bybit-exchange.github.io/docs/v5/intro)
|
||||
- [REST Endpoint Function List](./docs/endpointFunctionList.md)
|
||||
@@ -76,62 +121,17 @@ Most methods accept JS objects. These can be populated using parameters specifie
|
||||
|
||||
## Structure
|
||||
|
||||
This connector is fully compatible with both TypeScript and pure JavaScript projects, while the connector is written in TypeScript. A pure JavaScript version can be built using `npm run build`, which is also the version published to [npm](https://www.npmjs.com/package/bybit-api).
|
||||
The SDK is written in TypeScript, but fully compatible with both TypeScript and pure JavaScript projects. A pure JavaScript version can be built using `npm run build`. The output of the `build` command is the version published to npm, packaged as a JavaScript module (with types available for you TypeScript users).
|
||||
|
||||
The version on npm is the output from the `build` command and can be used in projects without TypeScript (although TypeScript is definitely recommended).
|
||||
|
||||
- [src](./src) - the whole connector written in TypeScript
|
||||
- [lib](./lib) - the JavaScript version of the project (built from TypeScript). This should not be edited directly, as it will be overwritten with each release.
|
||||
- [src](./src) - the complete SDK written in TypeScript.
|
||||
- [lib](./lib) - the JavaScript version of the project (built from TypeScript) that is published to npm. This should not be edited directly, as it will be overwritten with each release.
|
||||
- [examples](./examples) - examples & demonstrations. Contributions are welcome!
|
||||
- [test](./test) - automated end-to-end tests that run before every release, making real API calls.
|
||||
|
||||
---
|
||||
|
||||
## REST API Clients
|
||||
|
||||
Bybit has several API groups (originally one per product). Each generation is labelled with the version number (e.g. v1/v2/v3/v5). New projects & developments should use the newest available API generation (e.g. use the V5 APIs instead of V3).
|
||||
|
||||
Refer to the [V5 interface mapping page](https://bybit-exchange.github.io/docs/v5/intro#v5-and-v3-interface-mapping-list) for more information on which V5 endpoints can be used instead of previous V3 endpoints.
|
||||
|
||||
Here are the available REST clients and the corresponding API groups described in the documentation:
|
||||
|
||||
| Class | Description |
|
||||
| :----------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| [ **V5 API** ] | The new unified V5 APIs (successor to previously fragmented APIs for all API groups). To learn more about the V5 API, please read the [V5 upgrade guideline](https://bybit-exchange.github.io/docs/v5/upgrade-guide). |
|
||||
| [RestClientV5](src/rest-client-v5.ts) | Unified V5 all-in-one REST client for all [V5 REST APIs](https://bybit-exchange.github.io/docs/v5/intro) |
|
||||
| [WebsocketClient](src/websocket-client.ts) | All WebSocket Events (Public & Private for all API categories) |
|
||||
| [ **Derivatives v3** ] | The Derivatives v3 APIs (successor to the Futures V2 APIs) |
|
||||
| [UnifiedMarginClient](src/unified-margin-client.ts) | [Derivatives (v3) Unified Margin APIs](https://bybit-exchange.github.io/docs/derivatives/unified/place-order) |
|
||||
| [ContractClient](src/contract-client.ts) | [Derivatives (v3) Contract APIs](https://bybit-exchange.github.io/docs/derivatives/contract/place-order). |
|
||||
| [ **Other** ] | Other standalone API groups |
|
||||
| [CopyTradingClient](src/copy-trading-client.ts) | [Copy Trading APIs](https://bybit-exchange.github.io/docs/category/copy-trade) |
|
||||
| [AccountAssetClientV3](src/account-asset-client-v3.ts) | [Account Asset V3 APIs](https://bybit-exchange.github.io/docs/account-asset/internal-transfer) |
|
||||
|
||||
---
|
||||
|
||||
### Deprecated/Obsolete APIs
|
||||
|
||||
The following API clients are for previous generation REST APIs and will be removed in the next major release. Some have already stopped working (because bybit stopped supporting them). You should use the V5 APIs for all new development.
|
||||
|
||||
<details>
|
||||
<summary>Click me to see the list of APIs</summary>
|
||||
|
||||
| Class | Description |
|
||||
| :--------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------: |
|
||||
| [ **Futures v2** ] | The Futures v2 APIs |
|
||||
| [~~InverseClient~~](src/inverse-client.ts) | [Inverse Perpetual Futures (v2) APIs](https://bybit-exchange.github.io/docs/futuresV2/inverse/) |
|
||||
| [~~LinearClient~~](src/linear-client.ts) | [USDT Perpetual Futures (v2) APIs](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-introduction) |
|
||||
| [~~InverseFuturesClient~~](src/inverse-futures-client.ts) | [Inverse Futures (v2) APIs](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-introduction) |
|
||||
| [ **Spot** ] | The spot APIs |
|
||||
| [SpotClientV3](src/spot-client-v3.ts) | [Spot Market (v3) APIs](https://bybit-exchange.github.io/docs/spot/public/instrument) |
|
||||
| [~~SpotClient~~](src/spot-client.ts) (deprecated, SpotClientV3 recommended) | [Spot Market (v1) APIs](https://bybit-exchange.github.io/docs/spot/v1/#t-introduction) |
|
||||
| [ **USDC Contract** ] | The USDC Contract APIs |
|
||||
| [USDCPerpetualClient](src/usdc-perpetual-client.ts) | [USDC Perpetual APIs](https://bybit-exchange.github.io/docs/usdc/option/?console#t-querydeliverylog) |
|
||||
| [USDCOptionClient](src/usdc-option-client.ts) | [USDC Option APIs](https://bybit-exchange.github.io/docs/usdc/option/#t-introduction) |
|
||||
| [~~AccountAssetClient~~](src/account-asset-client.ts) (deprecated, AccountAssetClientV3 recommended) | [Account Asset V1 APIs](https://bybit-exchange.github.io/docs/account_asset/v1/#t-introduction) |
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
## Examples
|
||||
|
||||
Examples for using each client can be found in:
|
||||
|
||||
@@ -140,73 +140,99 @@ Examples for using each client can be found in:
|
||||
|
||||
If you're missing an example, you're welcome to request one. Priority will be given to [github sponsors](https://github.com/sponsors/tiagosiebler).
|
||||
|
||||
### Usage
|
||||
## API Clients
|
||||
|
||||
You should be using the V5 APIs. If you aren't, you should upgrade your project to use the V5 APIs as soon as possible. Bybit used to have several API groups (originally one per product), but the V5 API is currently the latest standard.
|
||||
|
||||
Refer to the [V5 interface mapping page](https://bybit-exchange.github.io/docs/v5/intro#v5-and-v3-interface-mapping-list) for more information on which V5 endpoints can be used instead of previous V3 endpoints. To learn more about the V5 API, please read the [V5 upgrade guideline](https://bybit-exchange.github.io/docs/v5/upgrade-guide).
|
||||
|
||||
Here are the available REST clients and the corresponding API groups described in the documentation:
|
||||
|
||||
| Class | Description |
|
||||
| :----------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| [ **V5 API** ] | The new unified V5 APIs (successor to previously fragmented APIs for all API groups). |
|
||||
| [RestClientV5](src/rest-client-v5.ts) | Unified V5 all-in-one REST client for all [V5 REST APIs](https://bybit-exchange.github.io/docs/v5/intro) |
|
||||
| [WebsocketClient](src/websocket-client.ts) | All WebSocket features (Public & Private consumers for all API categories & the WebSocket API) |
|
||||
|
||||
|
||||
## REST API Usage
|
||||
|
||||
Create API credentials on Bybit's website:
|
||||
|
||||
- [Livenet](https://bybit.com/app/user/api-management?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
|
||||
- [Testnet](https://testnet.bybit.com/app/user/api-management)
|
||||
|
||||
All REST clients have can be used in a similar way. However, method names, parameters and responses may vary depending on the API category you're using!
|
||||
|
||||
Not sure which function to call or which parameters to use? Click the class name in the table above to look at all the function names (they are in the same order as the official API docs), and check the API docs for a list of endpoints/parameters/responses.
|
||||
|
||||
The following is a minimal example for using the REST clients included with this SDK. For more detailed examples, refer to the [examples](./examples/) folder in the repository on GitHub:
|
||||
|
||||
```typescript
|
||||
const {
|
||||
InverseClient,
|
||||
LinearClient,
|
||||
InverseFuturesClient,
|
||||
SpotClientV3,
|
||||
UnifiedMarginClient,
|
||||
USDCOptionClient,
|
||||
USDCPerpetualClient,
|
||||
AccountAssetClient,
|
||||
CopyTradingClient,
|
||||
RestClientV5,
|
||||
} = require('bybit-api');
|
||||
const { RestClientV5 } = require('bybit-api');
|
||||
// or
|
||||
// import { RestClientV5 } from 'bybit-api';
|
||||
|
||||
const restClientOptions = {
|
||||
/** Your API key. Optional, if you plan on making private api calls */
|
||||
key?: string;
|
||||
/** Your API key */
|
||||
key: 'apiKeyHere',
|
||||
|
||||
/** Your API secret. Optional, if you plan on making private api calls */
|
||||
secret?: string;
|
||||
/** Your API secret */
|
||||
secret: 'apiSecretHere',
|
||||
|
||||
/** Set to `true` to connect to testnet. Uses the live environment by default. */
|
||||
testnet?: boolean;
|
||||
|
||||
/** Override the max size of the request window (in ms) */
|
||||
recv_window?: number;
|
||||
|
||||
/** Default: false. If true, we'll throw errors if any params are undefined */
|
||||
strict_param_validation?: boolean;
|
||||
// testnet: true,
|
||||
|
||||
/**
|
||||
* Optionally override API protocol + domain
|
||||
* e.g baseUrl: 'https://api.bytick.com'
|
||||
**/
|
||||
baseUrl?: string;
|
||||
* Set to `true` to use Bybit's V5 demo trading:
|
||||
* https://bybit-exchange.github.io/docs/v5/demo
|
||||
*
|
||||
* Note: to use demo trading, you should have `testnet` disabled.
|
||||
*
|
||||
* You can find a detailed demoTrading example in the examples folder on GitHub.
|
||||
*/
|
||||
// demoTrading: true,
|
||||
|
||||
/** Default: true. whether to try and post-process request exceptions. */
|
||||
parse_exceptions?: boolean;
|
||||
/** Override the max size of the request window (in ms) */
|
||||
// recv_window: 5000, // 5000 = 5 seconds
|
||||
|
||||
/**
|
||||
* Enable keep alive for REST API requests (via axios).
|
||||
* See: https://github.com/tiagosiebler/bybit-api/issues/368
|
||||
*/
|
||||
// keepAlive: true,
|
||||
|
||||
/**
|
||||
* When using HTTP KeepAlive, how often to send TCP KeepAlive packets over
|
||||
* sockets being kept alive. Only relevant if keepAlive is set to true.
|
||||
* Default: 1000 (defaults comes from https agent)
|
||||
*/
|
||||
// keepAliveMsecs: 1000, // 1000 = 1 second
|
||||
|
||||
/**
|
||||
* Optionally override API domain used:
|
||||
* apiRegion: 'default' | 'bytick' | 'NL' | 'HK' | 'TK',
|
||||
**/
|
||||
|
||||
// apiRegion: 'bytick',
|
||||
|
||||
/** Default: false. Enable to parse/include per-API/endpoint rate limits in responses. */
|
||||
parseAPIRateLimits?: boolean;
|
||||
// parseAPIRateLimits: true,
|
||||
|
||||
/** Default: false. Enable to throw error if rate limit parser fails */
|
||||
throwOnFailedRateLimitParse?: boolean;
|
||||
/**
|
||||
* Allows you to provide a custom "signMessage" function,
|
||||
* e.g. to use node crypto's much faster createHmac method
|
||||
*
|
||||
* Look at examples/fasterHmacSign.ts for a demonstration:
|
||||
*/
|
||||
// customSignMessageFn: (message: string, secret: string) => Promise<string>;
|
||||
};
|
||||
|
||||
const API_KEY = 'xxx';
|
||||
const API_SECRET = 'yyy';
|
||||
const useTestnet = false;
|
||||
|
||||
const client = new RestClientV5({
|
||||
key: API_KEY,
|
||||
secret: API_SECRET,
|
||||
testnet: useTestnet,
|
||||
// demoTrading: true,
|
||||
|
||||
// Optional: enable to try parsing rate limit values from responses
|
||||
// parseAPIRateLimits: true
|
||||
},
|
||||
@@ -214,7 +240,7 @@ const client = new RestClientV5({
|
||||
);
|
||||
|
||||
// For public-only API calls, simply don't provide a key & secret or set them to undefined
|
||||
// const client = new RestClientV5({});
|
||||
// const client = new RestClientV5();
|
||||
|
||||
client.getAccountInfo()
|
||||
.then(result => {
|
||||
@@ -224,7 +250,7 @@ client.getAccountInfo()
|
||||
console.error("getAccountInfo error: ", err);
|
||||
});
|
||||
|
||||
client.getOrderbook({ category: 'linear', symbol: 'BTCUSD' })
|
||||
client.getOrderbook({ category: 'linear', symbol: 'BTCUSDT' })
|
||||
.then(result => {
|
||||
console.log("getOrderBook result: ", result);
|
||||
})
|
||||
@@ -233,131 +259,252 @@ client.getOrderbook({ category: 'linear', symbol: 'BTCUSD' })
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## WebSockets
|
||||
|
||||
All API groups can be used via a shared `WebsocketClient`. However, to listen to multiple API groups at once, you will need to make one WebsocketClient instance per API group.
|
||||
The WebsocketClient will automatically use the latest V5 WebSocket endpoints by default. To use a different endpoint, use the `market` parameter. Except for the WebSocket API - this can be accessed without any special configuration.
|
||||
|
||||
The WebsocketClient can be configured to a specific API group using the market parameter. These are the currently available API groups:
|
||||
| API Category | Market | Description |
|
||||
|:----------------------------: |:-------------------: |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| V5 Subscriptions | `market: 'v5'` | The [v5](https://bybit-exchange.github.io/docs/v5/ws/connect) websocket topics for all categories under one market. Use the subscribeV5 method when subscribing to v5 topics. |
|
||||
|
||||
---
|
||||
|
||||
### Older Websocket APIs
|
||||
|
||||
The following API groups are still available in the WebsocketClient but are deprecated and may no longer work. They will be removed in the next major release:
|
||||
|
||||
<details>
|
||||
<summary>Click me to see the table</summary>
|
||||
|
||||
| API Category | Market | Description |
|
||||
| :------------------------------: | :-------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ~~Unified Margin - Options~~ | `market: 'unifiedOption'` | The [derivatives v3](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocket) category for unified margin. Note: public topics only support options topics. If you need USDC/USDT perps, use `unifiedPerp` instead. |
|
||||
| ~~Unified Margin - Perps~~ | `market: 'unifiedPerp'` | The [derivatives v3](https://bybit-exchange.github.io/docs/derivativesV3/unified_margin/#t-websocket) category for unified margin. Note: public topics only support USDT/USDC perpetual topics - use `unifiedOption` if you need public options topics. |
|
||||
| ~~Futures v2 - Inverse Perps~~ | `market: 'inverse'` | The [inverse v2 perps](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-websocket) category. |
|
||||
| ~~Futures v2 - USDT Perps~~ | `market: 'linear'` | The [USDT/linear v2 perps](https://bybit-exchange.github.io/docs/futuresV2/linear/#t-websocket) category. |
|
||||
| ~~Futures v2 - Inverse Futures~~ | `market: 'inverse'` | The [inverse futures v2](https://bybit-exchange.github.io/docs/futuresV2/inverse_futures/#t-websocket) category uses the same market as inverse perps. |
|
||||
| ~~Spot v3~~ | `market: 'spotv3'` | The [spot v3](https://bybit-exchange.github.io/docs/spot/v3/#t-websocket) category. |
|
||||
| ~~Spot v1~~ | `market: 'spot'` | The older [spot v1](https://bybit-exchange.github.io/docs/spot/v1/#t-websocket) category. Use the `spotv3` market if possible, as the v1 category does not have automatic re-subscribe if reconnected. |
|
||||
| ~~Copy Trading~~ | `market: 'linear'` | The [copy trading](https://bybit-exchange.github.io/docs/copy_trading/#t-websocket) category. Use the linear market to listen to all copy trading topics. |
|
||||
| ~~USDC Perps~~ | `market: 'usdcPerp` | The [USDC perps](https://bybit-exchange.github.io/docs/usdc/perpetual/#t-websocket) category. |
|
||||
| ~~USDC Options~~ | `market: 'usdcOption'` | The [USDC options](https://bybit-exchange.github.io/docs/usdc/option/#t-websocket) category. |
|
||||
| ~~Contract v3 USDT~~ | `market: 'contractUSDT'` | The [Contract V3](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocket) category (USDT perps) |
|
||||
| ~~Contract v3 Inverse~~ | `market: 'contractInverse'` | The [Contract V3](https://bybit-exchange.github.io/docs/derivativesV3/contract/#t-websocket) category (inverse perps) |
|
||||
|
||||
</details
|
||||
|
||||
---
|
||||
|
||||
### WebSocket Examples
|
||||
## WebSocket Subscriptions - Consuming events
|
||||
|
||||
Here's a minimal example for using the websocket client. For more complete examples, look into the ws-\* examples in the [examples](./examples/) folder in the repo on GitHub.
|
||||
|
||||
```javascript
|
||||
const { WebsocketClient } = require('bybit-api');
|
||||
// or
|
||||
// import { WebsocketClient } from 'bybit-api';
|
||||
|
||||
const API_KEY = 'xxx';
|
||||
const PRIVATE_KEY = 'yyy';
|
||||
|
||||
const wsConfig = {
|
||||
key: API_KEY,
|
||||
secret: PRIVATE_KEY,
|
||||
/**
|
||||
* API credentials are optional. They are only required if you plan on using
|
||||
* any account-specific topics or the WS API
|
||||
*/
|
||||
key: 'yourAPIKeyHere',
|
||||
secret: 'yourAPISecretHere',
|
||||
|
||||
/*
|
||||
The following parameters are optional:
|
||||
*/
|
||||
|
||||
// Connects to livenet by default. Set testnet to true to use the testnet environment.
|
||||
/**
|
||||
* Set to `true` to connect to Bybit's testnet environment.
|
||||
* - If demo trading, `testnet` should be set to false!
|
||||
* - If testing a strategy, use demo trading instead. Testnet market
|
||||
* data is very different from real market conditions.
|
||||
*/
|
||||
// testnet: true
|
||||
|
||||
// If you can, use the v5 market (the newest generation of Bybit's websockets)
|
||||
market: 'v5',
|
||||
/**
|
||||
* Set to `true` to connect to Bybit's V5 demo trading:
|
||||
* https://bybit-exchange.github.io/docs/v5/demo
|
||||
*
|
||||
* Refer to the examples folder on GitHub for a more detailed demonstration.
|
||||
*/
|
||||
// demoTrading; true;
|
||||
|
||||
// how long to wait (in ms) before deciding the connection should be terminated & reconnected
|
||||
// pongTimeout: 1000,
|
||||
|
||||
// how often to check (in ms) that WS connection is still alive
|
||||
// pingInterval: 10000,
|
||||
|
||||
// how long to wait before attempting to reconnect (in ms) after connection is closed
|
||||
// reconnectTimeout: 500,
|
||||
|
||||
// recv window size for authenticated websocket requests (higher latency connections (VPN) can cause authentication to fail if the recv window is too small)
|
||||
// recv window size for websocket authentication (higher latency connections
|
||||
// (VPN) can cause authentication to fail if the recv window is too small)
|
||||
// recvWindow: 5000,
|
||||
|
||||
// config options sent to RestClient (used for time sync). See RestClient docs.
|
||||
// restOptions: { },
|
||||
/** How often to check if the connection is alive (in ms) */
|
||||
// pingInterval: 10000,
|
||||
|
||||
// config for axios used for HTTP requests. E.g for proxy support
|
||||
// requestOptions: { }
|
||||
/**
|
||||
* How long to wait (in ms) for a pong (heartbeat reply) before assuming the
|
||||
* connection is dead
|
||||
*/
|
||||
// pongTimeout: 1000,
|
||||
|
||||
/** Delay in milliseconds before respawning the connection */
|
||||
// reconnectTimeout: 500,
|
||||
|
||||
// override which URL to use for websocket connections
|
||||
// wsUrl: 'wss://stream.bytick.com/realtime'
|
||||
|
||||
/**
|
||||
* Allows you to provide a custom "signMessage" function, e.g. to use node's
|
||||
* much faster createHmac method
|
||||
*
|
||||
* Look at examples/fasterHmacSign.ts for a demonstration:
|
||||
*/
|
||||
// customSignMessageFn: (message: string, secret: string) => Promise<string>;
|
||||
};
|
||||
|
||||
const ws = new WebsocketClient(wsConfig);
|
||||
|
||||
// (before v5) subscribe to multiple topics at once
|
||||
ws.subscribe(['position', 'execution', 'trade']);
|
||||
|
||||
// (before v5) and/or subscribe to individual topics on demand
|
||||
ws.subscribe('kline.BTCUSD.1m');
|
||||
|
||||
// (v5) subscribe to multiple topics at once
|
||||
ws.subscribeV5(['orderbook.50.BTCUSDT', 'orderbook.50.ETHUSDT'], 'linear');
|
||||
|
||||
// (v5) and/or subscribe to individual topics on demand
|
||||
// Or one at a time
|
||||
ws.subscribeV5('kline.5.BTCUSDT', 'linear');
|
||||
ws.subscribeV5('kline.5.ETHUSDT', 'linear');
|
||||
|
||||
// Private/public topics can be used in the same WS client instance, even for
|
||||
// different API groups (linear, options, spot, etc)
|
||||
ws.subscribeV5('position', 'linear');
|
||||
ws.subscribeV5('publicTrade.BTC', 'option');
|
||||
|
||||
/**
|
||||
* The Websocket Client will automatically manage all connectivity & authentication for you.
|
||||
*
|
||||
* If a network issue occurs, it will automatically:
|
||||
* - detect it,
|
||||
* - remove the dead connection,
|
||||
* - replace it with a new one,
|
||||
* - resubscribe to everything you were subscribed to.
|
||||
*
|
||||
* When this happens, you will see the "reconnected" event.
|
||||
*/
|
||||
|
||||
// Listen to events coming from websockets. This is the primary data source
|
||||
ws.on('update', (data) => {
|
||||
console.log('update', data);
|
||||
console.log('data received', JSON.stringify(data, null, 2));
|
||||
});
|
||||
|
||||
// Optional: Listen to websocket connection open event (automatic after subscribing to one or more topics)
|
||||
// Optional: Listen to websocket connection open event
|
||||
// (automatic after subscribing to one or more topics)
|
||||
ws.on('open', ({ wsKey, event }) => {
|
||||
console.log('connection open for websocket with ID: ' + wsKey);
|
||||
console.log('connection open for websocket with ID: ', wsKey);
|
||||
});
|
||||
|
||||
// Optional: Listen to responses to websocket queries (e.g. the response after subscribing to a topic)
|
||||
// Optional: Listen to responses to websocket queries
|
||||
// (e.g. the response after subscribing to a topic)
|
||||
ws.on('response', (response) => {
|
||||
console.log('response', response);
|
||||
});
|
||||
|
||||
// Optional: Listen to connection close event. Unexpected connection closes are automatically reconnected.
|
||||
// Optional: Listen to connection close event.
|
||||
// Unexpected connection closes are automatically reconnected.
|
||||
ws.on('close', () => {
|
||||
console.log('connection closed');
|
||||
});
|
||||
|
||||
// Optional: Listen to raw error events. Recommended.
|
||||
ws.on('error', (err) => {
|
||||
console.error('error', err);
|
||||
// Listen to raw error events. Recommended.
|
||||
ws.on('exception', (err) => {
|
||||
console.error('exception', err);
|
||||
});
|
||||
|
||||
ws.on('reconnect', ({ wsKey }) => {
|
||||
console.log('ws automatically reconnecting.... ', wsKey);
|
||||
});
|
||||
|
||||
ws.on('reconnected', (data) => {
|
||||
console.log('ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
```
|
||||
|
||||
See [websocket-client.ts](./src/websocket-client.ts) for further information.
|
||||
## Websocket API - Sending orders via WebSockets
|
||||
|
||||
Bybit supports sending, amending and cancelling orders over a WebSocket connection. The [WebsocketClient](./src/WebsocketClient.ts) fully supports Bybit's WebSocket API via the `sendWSAPIRequest(...)` method.
|
||||
|
||||
Links for reference:
|
||||
- [Bybit WebSocket API Documentation](https://bybit-exchange.github.io/docs/v5/websocket/trade/guideline)
|
||||
- [WebSocket API Example Node.js/TypeScript/JavaScript](./examples/ws-api-promises.ts).
|
||||
|
||||
Note: as of January 2025, the demo trading environment does not support the WebSocket API.
|
||||
|
||||
There are two ways to use the WS API, depending on individual preference:
|
||||
- event-driven:
|
||||
- send requests via `client.sendWSAPIRequest(wsKey, operation, params)`, fire and forget
|
||||
- handle async replies via event handlers on `client.on('exception', cb)` and `client.on('response', cb)`
|
||||
- See example for more details: [examples/ws-api-events.ts](./examples/ws-api-events.ts)
|
||||
- promise-driven:
|
||||
- send requests via `const result = await client.sendWSAPIRequest(wsKey, operation, params)`, which returns a promise
|
||||
- await each call
|
||||
- use try/catch blocks to handle promise rejections
|
||||
- See example for more details: [examples/ws-api-promises.ts](./examples/ws-api-promises.ts)
|
||||
|
||||
The below example demonstrates the promise-driven approach, which behaves similar to a REST API. The WebSocket API even accepts the same parameters as the corresponding REST API endpoints, so this approach should be compatible with existing REST implementations. Connectivity, authentication, and processing requests wrapped in promises - these are all handled automatically by the WebsocketClient without additional configuration.
|
||||
|
||||
```javascript
|
||||
const { WS_KEY_MAP, WebsocketClient } = require('bybit-api');
|
||||
|
||||
// or
|
||||
// import { WS_KEY_MAP, WebsocketClient } from 'bybit-api';
|
||||
|
||||
// Create an instance of the WebsocketClient.
|
||||
// This will automatically handle connectivity and authentication for you.
|
||||
const wsClient = new WebsocketClient(
|
||||
{
|
||||
key: 'yourApiKeyHere',
|
||||
secret: 'yourApiSecretHere',
|
||||
|
||||
// Whether to use the testnet environment.
|
||||
// Create testnet API keys here: https://testnet.bybit.com/app/user/api-management
|
||||
// testnet: true,
|
||||
|
||||
// Whether to use the livenet demo trading environment
|
||||
// Note: As of Jan 2025, demo trading only supports consuming events, it does
|
||||
// NOT support the WS API.
|
||||
// demoTrading: false,
|
||||
}
|
||||
);
|
||||
|
||||
// This example is wrapped in an async function, so "await" can be used
|
||||
async function main() {
|
||||
/**
|
||||
* Optional. Can be used to prepare a connection before sending
|
||||
* commands (e.g. as part of your startup process).
|
||||
*
|
||||
* This is not necessary and will happen automatically when
|
||||
* sending a command, if you aren't connected/authenticated yet.
|
||||
*/
|
||||
// await wsClient.connectWSAPI();
|
||||
|
||||
try {
|
||||
console.log('Step 1: Create an order');
|
||||
|
||||
// The type for `wsAPISubmitOrderResult` is automatically
|
||||
// resolved to `WSAPIResponse<OrderResultV5, "order.create">`
|
||||
const wsAPISubmitOrderResult = await wsClient.sendWSAPIRequest(
|
||||
WS_KEY_MAP.v5PrivateTrade,
|
||||
'order.create',
|
||||
{
|
||||
symbol: 'BTCUSDT',
|
||||
side: 'Buy',
|
||||
orderType: 'Limit',
|
||||
price: '50000',
|
||||
qty: '1',
|
||||
category: 'linear',
|
||||
},
|
||||
);
|
||||
|
||||
console.log(
|
||||
`Step 1: Order result (order ID: "${wsAPISubmitOrderResult.data.orderId}"): `,
|
||||
wsAPISubmitOrderResult,
|
||||
);
|
||||
} catch (e) {
|
||||
console.error('Step 1: Order submit exception: ', e);
|
||||
}
|
||||
}
|
||||
|
||||
// Start executing the example workflow
|
||||
main();
|
||||
|
||||
```
|
||||
|
||||
See the [examples/ws-api-promises.ts](./examples/ws-api-promises.ts) example for a more detailed explanation.
|
||||
|
||||
---
|
||||
|
||||
### Balancing load across multiple connections
|
||||
|
||||
The WebsocketClient will automatically prepare one connection per API group, for all topics in that API group. Any topics that you subscribe to on that WebSocket client will automatically be added to the same connection.
|
||||
|
||||
To spread your subscribed topics over multiple connections, e.g. to reduce the throughput of an individual connectionk, you can make one instance of the WebsocketClient per connection group.
|
||||
|
||||
```typescript
|
||||
const wsClientGroup1 = new WebsocketClient();
|
||||
const wsClientGroup2 = new WebsocketClient();
|
||||
|
||||
// Attach event listeners to each WS Client
|
||||
// Divide your desired topics into separate groups
|
||||
```
|
||||
|
||||
Important: do not subscribe to the same topics on both clients or you will receive duplicate messages (once per WS client).
|
||||
|
||||
---
|
||||
|
||||
@@ -365,18 +512,18 @@ See [websocket-client.ts](./src/websocket-client.ts) for further information.
|
||||
|
||||
### Customise logging
|
||||
|
||||
Pass a custom logger (or mutate the imported DefaultLogger class) which supports the log methods `silly`, `debug`, `notice`, `info`, `warning` and `error`, or override methods from the default logger as desired, as in the example below:
|
||||
Pass a custom logger (or mutate the imported DefaultLogger class) which supports the log methods `trace`, `info` and `error`, or override methods from the default logger as desired, as in the example below:
|
||||
|
||||
```javascript
|
||||
const { WebsocketClient, DefaultLogger } = require('bybit-api');
|
||||
|
||||
// Disable all logging on the silly level
|
||||
// Enable all logging on the trace level (disabled by default)
|
||||
const customLogger = {
|
||||
...DefaultLogger,
|
||||
silly: () => {},
|
||||
trace: (...params) => console.log('trace', ...params),
|
||||
};
|
||||
|
||||
const ws = new WebsocketClient({ key: 'xxx', secret: 'yyy' }, customLogger);
|
||||
const wsClient = new WebsocketClient({ key: 'xxx', secret: 'yyy' }, customLogger);
|
||||
```
|
||||
|
||||
### Debug HTTP requests
|
||||
@@ -391,16 +538,13 @@ This is the "modern" way, allowing the package to be directly imported into fron
|
||||
|
||||
1. Install these dependencies
|
||||
```sh
|
||||
npm install crypto-browserify stream-browserify
|
||||
npm install stream-browserify
|
||||
```
|
||||
2. Add this to your `tsconfig.json`
|
||||
```json
|
||||
{
|
||||
"compilerOptions": {
|
||||
"paths": {
|
||||
"crypto": [
|
||||
"./node_modules/crypto-browserify"
|
||||
],
|
||||
"stream": [
|
||||
"./node_modules/stream-browserify"
|
||||
]
|
||||
@@ -437,23 +581,8 @@ Have my projects helped you? Share the love, there are many ways you can show yo
|
||||
- Or buy me all the coffee:
|
||||
- ETH(ERC20): `0xA3Bda8BecaB4DCdA539Dc16F9C54a592553Be06C` <!-- metamask -->
|
||||
|
||||
<!---
|
||||
old ones:
|
||||
- BTC: `1C6GWZL1XW3jrjpPTS863XtZiXL1aTK7Jk`
|
||||
- BTC(SegWit): `bc1ql64wr9z3khp2gy7dqlmqw7cp6h0lcusz0zjtls`
|
||||
- ETH(ERC20): `0xe0bbbc805e0e83341fadc210d6202f4022e50992`
|
||||
- USDT(TRC20): `TA18VUywcNEM9ahh3TTWF3sFpt9rkLnnQa
|
||||
-->
|
||||
<!-- template_contributions_end -->
|
||||
|
||||
#### pixtron
|
||||
|
||||
An early generation of this library was started by @pixtron. If this library helps you to trade better on bybit, feel free to donate a coffee to @pixtron:
|
||||
|
||||
- BTC `1Fh1158pXXudfM6ZrPJJMR7Y5SgZUz4EdF`
|
||||
- ETH `0x21aEdeC53ab7593b77C9558942f0c9E78131e8d7`
|
||||
- LTC `LNdHSVtG6UWsriMYLJR3qLdfVNKwJ6GSLF`
|
||||
|
||||
### Contributions & Pull Requests
|
||||
|
||||
Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.
|
||||
|
||||
19
examples/apidoc/V5/Earn/get-product-info.js
Normal file
19
examples/apidoc/V5/Earn/get-product-info.js
Normal file
@@ -0,0 +1,19 @@
|
||||
const { RestClientV5 } = require('bybit-api');
|
||||
|
||||
const client = new RestClientV5({
|
||||
testnet: true,
|
||||
key: 'apikey',
|
||||
secret: 'apisecret',
|
||||
});
|
||||
|
||||
client
|
||||
.getEarnProduct({
|
||||
category: 'FlexibleSaving',
|
||||
coin: 'BTC',
|
||||
})
|
||||
.then((response) => {
|
||||
console.log(response);
|
||||
})
|
||||
.catch((error) => {
|
||||
console.error(error);
|
||||
});
|
||||
19
examples/apidoc/V5/Earn/get-stake-redeem-order-history.js
Normal file
19
examples/apidoc/V5/Earn/get-stake-redeem-order-history.js
Normal file
@@ -0,0 +1,19 @@
|
||||
const { RestClientV5 } = require('bybit-api');
|
||||
|
||||
const client = new RestClientV5({
|
||||
testnet: true,
|
||||
key: 'apikey',
|
||||
secret: 'apisecret',
|
||||
});
|
||||
|
||||
client
|
||||
.getEarnOrderHistory({
|
||||
category: 'FlexibleSaving',
|
||||
orderId: '0572b030-6a0b-423f-88c4-b6ce31c0c82d',
|
||||
})
|
||||
.then((response) => {
|
||||
console.log(response);
|
||||
})
|
||||
.catch((error) => {
|
||||
console.error(error);
|
||||
});
|
||||
19
examples/apidoc/V5/Earn/get-staked-position.js
Normal file
19
examples/apidoc/V5/Earn/get-staked-position.js
Normal file
@@ -0,0 +1,19 @@
|
||||
const { RestClientV5 } = require('bybit-api');
|
||||
|
||||
const client = new RestClientV5({
|
||||
testnet: true,
|
||||
key: 'apikey',
|
||||
secret: 'apisecret',
|
||||
});
|
||||
|
||||
client
|
||||
.getEarnPosition({
|
||||
category: 'FlexibleSaving',
|
||||
coin: 'USDT',
|
||||
})
|
||||
.then((response) => {
|
||||
console.log(response);
|
||||
})
|
||||
.catch((error) => {
|
||||
console.error(error);
|
||||
});
|
||||
24
examples/apidoc/V5/Earn/stake-redeem.js
Normal file
24
examples/apidoc/V5/Earn/stake-redeem.js
Normal file
@@ -0,0 +1,24 @@
|
||||
const { RestClientV5 } = require('bybit-api');
|
||||
|
||||
const client = new RestClientV5({
|
||||
testnet: true,
|
||||
key: 'apikey',
|
||||
secret: 'apisecret',
|
||||
});
|
||||
|
||||
client
|
||||
.submitStakeRedeem({
|
||||
category: 'FlexibleSaving',
|
||||
orderType: 'Stake',
|
||||
accountType: 'FUND',
|
||||
amount: '0.35',
|
||||
coin: 'BTC',
|
||||
productId: '430',
|
||||
orderLinkId: 'btc-earn-001',
|
||||
})
|
||||
.then((response) => {
|
||||
console.log(response);
|
||||
})
|
||||
.catch((error) => {
|
||||
console.error(error);
|
||||
});
|
||||
@@ -26,17 +26,17 @@ const restClient = new RestClientV5({
|
||||
demoTrading: true,
|
||||
});
|
||||
|
||||
// Optional, uncomment the "silly" override to log a lot more info about what the WS client is doing
|
||||
// Optional, uncomment the "trace" override to log a lot more info about what the WS client is doing
|
||||
const customLogger = {
|
||||
...DefaultLogger,
|
||||
// silly: (...params) => console.log('trace', ...params),
|
||||
// trace: (...params) => console.log('trace', ...params),
|
||||
};
|
||||
|
||||
const wsClient = new WebsocketClient(
|
||||
{
|
||||
key: key,
|
||||
secret: secret,
|
||||
market: 'v5',
|
||||
|
||||
/**
|
||||
* Set this to true to enable demo trading for the private account data WS
|
||||
* Topics: order,execution,position,wallet,greeks
|
||||
@@ -91,7 +91,7 @@ function setWsClientEventListeners(
|
||||
websocketClient.on('reconnected', (data) => {
|
||||
console.log(new Date(), accountRef, 'ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
websocketClient.on('error', (data) => {
|
||||
websocketClient.on('exception', (data) => {
|
||||
console.error(new Date(), accountRef, 'ws exception: ', data);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
import { ContractClient } from '../../src/index';
|
||||
|
||||
// or
|
||||
// import { ContractClient } from 'bybit-api';
|
||||
|
||||
const key = process.env.API_KEY_COM;
|
||||
const secret = process.env.API_SECRET_COM;
|
||||
|
||||
const client = new ContractClient({
|
||||
key,
|
||||
secret,
|
||||
strict_param_validation: true,
|
||||
});
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
const getPositions = await client.getPositions({
|
||||
settleCoin: 'USDT',
|
||||
});
|
||||
console.log('getPositions:', getPositions);
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
@@ -1,21 +0,0 @@
|
||||
/**
|
||||
* This is the pure javascript version of the `rest-contract-public.ts` sample
|
||||
*/
|
||||
|
||||
// To use a local build (testing with the repo directly), make sure to `npm run build` first from the repo root
|
||||
// const { ContractClient } = require('../dist');
|
||||
|
||||
// or, use the version installed with npm
|
||||
const { ContractClient } = require('bybit-api');
|
||||
|
||||
(async () => {
|
||||
const client = new ContractClient();
|
||||
|
||||
try {
|
||||
const orderbookResult = await client.getOrderBook('BTCUSDT', 'linear');
|
||||
console.log('orderbook result: ', orderbookResult);
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
|
||||
})();
|
||||
@@ -1,20 +0,0 @@
|
||||
/**
|
||||
* This is the TypeScript version of the `rest-contract-public.js` sample.
|
||||
*/
|
||||
|
||||
// For testing with the repo directly, import from the src folder
|
||||
import { ContractClient } from '../../src';
|
||||
|
||||
// or, use the version installed with npm
|
||||
// import { ContractClient } from 'bybit-api';
|
||||
|
||||
(async () => {
|
||||
const client = new ContractClient();
|
||||
|
||||
try {
|
||||
const orderbookResult = await client.getOrderBook('BTCUSDT', 'linear');
|
||||
console.log('orderbook result: ', orderbookResult);
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
@@ -1,25 +0,0 @@
|
||||
import { CopyTradingClient } from '../../src/index';
|
||||
|
||||
// or
|
||||
// import { CopyTradingClient } from 'bybit-api';
|
||||
|
||||
const key = process.env.API_KEY_COM;
|
||||
const secret = process.env.API_SECRET_COM;
|
||||
|
||||
const client = new CopyTradingClient({
|
||||
key,
|
||||
secret,
|
||||
strict_param_validation: true,
|
||||
});
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
const res = await client.closeOrder({
|
||||
symbol: 'BTCUSDT',
|
||||
parentOrderId: '419190fe-016c-469a-810e-936bef2f1234',
|
||||
});
|
||||
console.log('res:', res);
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
@@ -1,23 +0,0 @@
|
||||
import { LinearClient } from '../../src/index';
|
||||
|
||||
// or
|
||||
// import { LinearClient } from 'bybit-api';
|
||||
|
||||
const client = new LinearClient();
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
// console.log('getSymbols: ', await client.getSymbols());
|
||||
// console.log('getOrderBook: ', await client.getOrderBook(symbol));
|
||||
console.log(
|
||||
'getKline: ',
|
||||
await client.getKline({
|
||||
symbol: 'ETHUSDT',
|
||||
interval: 'D',
|
||||
from: 1,
|
||||
}),
|
||||
);
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
@@ -1,33 +0,0 @@
|
||||
import { ContractClient } from '../../src/index';
|
||||
|
||||
// or
|
||||
// import { ContractClient } from 'bybit-api';
|
||||
|
||||
const key = process.env.API_KEY_COM;
|
||||
const secret = process.env.API_SECRET_COM;
|
||||
|
||||
const client = new ContractClient({
|
||||
key,
|
||||
secret,
|
||||
strict_param_validation: true,
|
||||
});
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
/**
|
||||
* You can make raw HTTP requests without the per-endpoint abstraction.
|
||||
*
|
||||
* The REST ContractClient uses bybit's v3 signature mechanism,
|
||||
* so it can be used for raw calls to any v3-supporting endpoints (incl the V5 APIs).
|
||||
* e.g. if an endpoint is missing and you desperately need it (but please raise an issue or PR if you're missing an endpoint)
|
||||
*/
|
||||
const rawCall = await client.getPrivate('/v5/order/realtime', {
|
||||
category: 'linear',
|
||||
symbol: 'BTCUSDT',
|
||||
});
|
||||
|
||||
console.log('rawCall:', rawCall);
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
@@ -1,18 +0,0 @@
|
||||
import { SpotClientV3 } from '../../src/index';
|
||||
|
||||
// or
|
||||
// import { SpotClientV3 } from 'bybit-api';
|
||||
|
||||
const client = new SpotClientV3();
|
||||
|
||||
const symbol = 'BTCUSDT';
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
// console.log('getSymbols: ', await client.getSymbols());
|
||||
// console.log('getOrderBook: ', await client.getOrderBook(symbol));
|
||||
console.log('getOrderBook: ', await client.getOrderBook(symbol));
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
@@ -1,42 +0,0 @@
|
||||
import { SpotClientV3 } from '../../src/index';
|
||||
|
||||
// or
|
||||
// import { SpotClientV3 } from 'bybit-api';
|
||||
|
||||
const symbol = 'BTCUSDT';
|
||||
const key = process.env.API_KEY_COM;
|
||||
const secret = process.env.API_SECRET_COM;
|
||||
|
||||
const client = new SpotClientV3({
|
||||
key,
|
||||
secret,
|
||||
strict_param_validation: true,
|
||||
});
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
const orderId = undefined;
|
||||
const ordersPerPage = undefined;
|
||||
|
||||
const orders = await client.getOpenOrders(symbol);
|
||||
console.log('orders 1:', orders);
|
||||
|
||||
const normalOrders = await client.getOpenOrders(
|
||||
symbol,
|
||||
orderId,
|
||||
ordersPerPage,
|
||||
0,
|
||||
);
|
||||
console.log('normal orders:', normalOrders);
|
||||
|
||||
const tpSlOrders = await client.getOpenOrders(
|
||||
symbol,
|
||||
orderId,
|
||||
ordersPerPage,
|
||||
1,
|
||||
);
|
||||
console.log('tpSlOrders:', tpSlOrders);
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
@@ -1,44 +0,0 @@
|
||||
import { UnifiedMarginClient } from '../../src/index';
|
||||
|
||||
// or
|
||||
// import { UnifiedMarginClient } from 'bybit-api';
|
||||
|
||||
const key = process.env.API_KEY_COM;
|
||||
const secret = process.env.API_SECRET_COM;
|
||||
|
||||
const client = new UnifiedMarginClient({
|
||||
key,
|
||||
secret,
|
||||
strict_param_validation: true,
|
||||
});
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
// page 1
|
||||
const historicOrders1 = await client.getHistoricOrders({
|
||||
category: 'linear',
|
||||
limit: 1,
|
||||
// cursor,
|
||||
});
|
||||
console.log('page 1:', JSON.stringify(historicOrders1, null, 2));
|
||||
|
||||
// page 2
|
||||
const historicOrders2 = await client.getHistoricOrders({
|
||||
category: 'linear',
|
||||
limit: 1,
|
||||
cursor: historicOrders1.result.nextPageCursor,
|
||||
});
|
||||
console.log('page 2:', JSON.stringify(historicOrders2, null, 2));
|
||||
|
||||
const historicOrdersBoth = await client.getHistoricOrders({
|
||||
category: 'linear',
|
||||
limit: 2,
|
||||
});
|
||||
console.log(
|
||||
'both to compare:',
|
||||
JSON.stringify(historicOrdersBoth, null, 2),
|
||||
);
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
@@ -1,36 +0,0 @@
|
||||
import { UnifiedMarginClient } from '../../src/index';
|
||||
|
||||
// or
|
||||
// import { UnifiedMarginClient } from 'bybit-api';
|
||||
|
||||
const client = new UnifiedMarginClient({
|
||||
strict_param_validation: true,
|
||||
});
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
// page 1
|
||||
const historicOrders1 = await client.getInstrumentInfo({
|
||||
category: 'linear',
|
||||
limit: '2',
|
||||
});
|
||||
console.log('page 1:', JSON.stringify(historicOrders1, null, 2));
|
||||
|
||||
// page 2
|
||||
const historicOrders2 = await client.getInstrumentInfo({
|
||||
category: 'linear',
|
||||
limit: '2',
|
||||
cursor: historicOrders1.result.nextPageCursor,
|
||||
});
|
||||
console.log('page 2:', JSON.stringify(historicOrders2, null, 2));
|
||||
|
||||
// page 1 & 2 in one request (for comparison)
|
||||
const historicOrdersBoth = await client.getInstrumentInfo({
|
||||
category: 'linear',
|
||||
limit: '4',
|
||||
});
|
||||
console.log('both pages', JSON.stringify(historicOrdersBoth, null, 2));
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
@@ -1,61 +0,0 @@
|
||||
/* eslint-disable no-unused-vars */
|
||||
/* eslint-disable @typescript-eslint/no-unused-vars */
|
||||
/* eslint-disable @typescript-eslint/no-empty-function */
|
||||
import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from '../../src';
|
||||
|
||||
// or
|
||||
// import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from 'bybit-api';
|
||||
|
||||
const logger = {
|
||||
...DefaultLogger,
|
||||
silly: (...params) => {
|
||||
// console.log(params);
|
||||
},
|
||||
};
|
||||
|
||||
const key = process.env.API_KEY;
|
||||
const secret = process.env.API_SECRET;
|
||||
|
||||
/**
|
||||
* Copy trading api docs say that private topics should connect to: wss://stream.bybit.com/realtime_private
|
||||
*
|
||||
* Within this SDK, only the market `linear` uses this endpoint for private topics:
|
||||
*/
|
||||
const market = 'linear';
|
||||
|
||||
const wsClient = new WebsocketClient(
|
||||
{
|
||||
key: key,
|
||||
secret: secret,
|
||||
market: market,
|
||||
},
|
||||
logger,
|
||||
);
|
||||
|
||||
wsClient.on('update', (data) => {
|
||||
console.log('raw message received ', JSON.stringify(data, null, 2));
|
||||
});
|
||||
|
||||
wsClient.on('open', (data) => {
|
||||
console.log('connection opened open:', data.wsKey);
|
||||
});
|
||||
wsClient.on('response', (data) => {
|
||||
console.log('ws response: ', JSON.stringify(data, null, 2));
|
||||
});
|
||||
wsClient.on('reconnect', ({ wsKey }) => {
|
||||
console.log('ws automatically reconnecting.... ', wsKey);
|
||||
});
|
||||
wsClient.on('reconnected', (data) => {
|
||||
console.log('ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
wsClient.on('error', (data) => {
|
||||
console.error('ws exception: ', data);
|
||||
});
|
||||
|
||||
// copy trading topics from api docs: https://bybit-exchange.github.io/docs/copy-trade/ws-private/position
|
||||
wsClient.subscribe([
|
||||
'copyTradePosition',
|
||||
'copyTradeOrder',
|
||||
'copyTradeExecution',
|
||||
'copyTradeWallet',
|
||||
]);
|
||||
@@ -1,69 +0,0 @@
|
||||
/* eslint-disable no-unused-vars */
|
||||
/* eslint-disable @typescript-eslint/no-unused-vars */
|
||||
/* eslint-disable @typescript-eslint/no-empty-function */
|
||||
import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from '../../src';
|
||||
|
||||
// or
|
||||
// import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from 'bybit-api';
|
||||
|
||||
const logger = {
|
||||
...DefaultLogger,
|
||||
silly: () => {},
|
||||
};
|
||||
|
||||
const key = process.env.API_KEY;
|
||||
const secret = process.env.API_SECRET;
|
||||
|
||||
// USDT Perps:
|
||||
// const market = 'linear';
|
||||
// Inverse Perp
|
||||
// const market = 'inverse';
|
||||
// const market = 'spotv3';
|
||||
// Contract v3
|
||||
const market = 'contractUSDT';
|
||||
// const market = 'contractInverse';
|
||||
|
||||
const wsClient = new WebsocketClient(
|
||||
{
|
||||
key: key,
|
||||
secret: secret,
|
||||
market: market,
|
||||
// testnet: true,
|
||||
restOptions: {
|
||||
// enable_time_sync: true,
|
||||
},
|
||||
},
|
||||
logger,
|
||||
);
|
||||
|
||||
wsClient.on('update', (data) => {
|
||||
console.log('raw message received ', JSON.stringify(data, null, 2));
|
||||
});
|
||||
|
||||
wsClient.on('open', (data) => {
|
||||
console.log('connection opened open:', data.wsKey);
|
||||
});
|
||||
wsClient.on('response', (data) => {
|
||||
console.log('ws response: ', JSON.stringify(data, null, 2));
|
||||
});
|
||||
wsClient.on('reconnect', ({ wsKey }) => {
|
||||
console.log('ws automatically reconnecting.... ', wsKey);
|
||||
});
|
||||
wsClient.on('reconnected', (data) => {
|
||||
console.log('ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
wsClient.on('error', (data) => {
|
||||
console.error('ws exception: ', data);
|
||||
});
|
||||
|
||||
// subscribe to private endpoints
|
||||
// check the api docs in your api category to see the available topics
|
||||
// wsClient.subscribe(['position', 'execution', 'order', 'wallet']);
|
||||
|
||||
// Contract v3
|
||||
wsClient.subscribe([
|
||||
'user.position.contractAccount',
|
||||
'user.execution.contractAccount',
|
||||
'user.order.contractAccount',
|
||||
'user.wallet.contractAccount',
|
||||
]);
|
||||
@@ -1,172 +0,0 @@
|
||||
import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from '../../src';
|
||||
|
||||
// or
|
||||
// import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from 'bybit-api';
|
||||
|
||||
const logger = {
|
||||
...DefaultLogger,
|
||||
silly: (...params) => console.log('silly', ...params),
|
||||
};
|
||||
|
||||
const wsClient = new WebsocketClient(
|
||||
{
|
||||
// key: key,
|
||||
// secret: secret,
|
||||
// market: 'linear',
|
||||
// market: 'inverse',
|
||||
// market: 'spot',
|
||||
// market: 'spotv3',
|
||||
// market: 'usdcOption',
|
||||
// market: 'usdcPerp',
|
||||
// market: 'unifiedPerp',
|
||||
// market: 'unifiedOption',
|
||||
market: 'contractUSDT',
|
||||
},
|
||||
logger,
|
||||
);
|
||||
|
||||
wsClient.on('update', (data) => {
|
||||
console.log('raw message received ', JSON.stringify(data));
|
||||
// console.log('raw message received ', JSON.stringify(data, null, 2));
|
||||
});
|
||||
|
||||
wsClient.on('open', (data) => {
|
||||
console.log('connection opened open:', data.wsKey);
|
||||
|
||||
// if (data.wsKey === WS_KEY_MAP.spotPublic) {
|
||||
// // Spot public, but not recommended - use spotv3 client instead
|
||||
// // The old spot websockets dont automatically resubscribe if they disconnect
|
||||
// // wsClient.subscribePublicSpotTrades('BTCUSDT');
|
||||
// // wsClient.subscribePublicSpotTradingPair('BTCUSDT');
|
||||
// // wsClient.subscribePublicSpotV1Kline('BTCUSDT', '1m');
|
||||
// // wsClient.subscribePublicSpotOrderbook('BTCUSDT', 'full');
|
||||
// }
|
||||
});
|
||||
wsClient.on('response', (data) => {
|
||||
console.log('log response: ', JSON.stringify(data, null, 2));
|
||||
});
|
||||
wsClient.on('reconnect', ({ wsKey }) => {
|
||||
console.log('ws automatically reconnecting.... ', wsKey);
|
||||
});
|
||||
wsClient.on('reconnected', (data) => {
|
||||
console.log('ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
// wsClient.on('error', (data) => {
|
||||
// console.error('ws exception: ', data);
|
||||
// });
|
||||
|
||||
// Inverse
|
||||
// wsClient.subscribe('trade');
|
||||
|
||||
// Linear
|
||||
// wsClient.subscribe('trade.BTCUSDT');
|
||||
|
||||
// Spot V3
|
||||
// wsClient.subscribe('trade.BTCUSDT');
|
||||
// Or an array of topics
|
||||
// wsClient.subscribe([
|
||||
// 'orderbook.40.BTCUSDT',
|
||||
// 'orderbook.40.BTCUSDC',
|
||||
// 'orderbook.40.USDCUSDT',
|
||||
// 'orderbook.40.BTCDAI',
|
||||
// 'orderbook.40.DAIUSDT',
|
||||
// 'orderbook.40.ETHUSDT',
|
||||
// 'orderbook.40.ETHUSDC',
|
||||
// 'orderbook.40.ETHDAI',
|
||||
// 'orderbook.40.XRPUSDT',
|
||||
// 'orderbook.40.XRPUSDC',
|
||||
// 'orderbook.40.EOSUSDT',
|
||||
// 'orderbook.40.EOSUSDC',
|
||||
// 'orderbook.40.DOTUSDT',
|
||||
// 'orderbook.40.DOTUSDC',
|
||||
// 'orderbook.40.XLMUSDT',
|
||||
// 'orderbook.40.XLMUSDC',
|
||||
// 'orderbook.40.LTCUSDT',
|
||||
// 'orderbook.40.LTCUSDC',
|
||||
// 'orderbook.40.DOGEUSDT',
|
||||
// 'orderbook.40.DOGEUSDC',
|
||||
// 'orderbook.40.BITUSDT',
|
||||
// 'orderbook.40.BITUSDC',
|
||||
// 'orderbook.40.BITDAI',
|
||||
// 'orderbook.40.CHZUSDT',
|
||||
// 'orderbook.40.CHZUSDC',
|
||||
// 'orderbook.40.MANAUSDT',
|
||||
// 'orderbook.40.MANAUSDC',
|
||||
// 'orderbook.40.LINKUSDT',
|
||||
// 'orderbook.40.LINKUSDC',
|
||||
// 'orderbook.40.ICPUSDT',
|
||||
// 'orderbook.40.ICPUSDC',
|
||||
// 'orderbook.40.ADAUSDT',
|
||||
// 'orderbook.40.ADAUSDC',
|
||||
// 'orderbook.40.SOLUSDC',
|
||||
// 'orderbook.40.SOLUSDT',
|
||||
// 'orderbook.40.MATICUSDC',
|
||||
// 'orderbook.40.MATICUSDT',
|
||||
// 'orderbook.40.SANDUSDC',
|
||||
// 'orderbook.40.SANDUSDT',
|
||||
// 'orderbook.40.LUNCUSDC',
|
||||
// 'orderbook.40.LUNCUSDT',
|
||||
// 'orderbook.40.SLGUSDC',
|
||||
// 'orderbook.40.SLGUSDT',
|
||||
// 'orderbook.40.AVAXUSDC',
|
||||
// 'orderbook.40.AVAXUSDT',
|
||||
// 'orderbook.40.OPUSDC',
|
||||
// 'orderbook.40.OPUSDT',
|
||||
// 'orderbook.40.OKSEUSDC',
|
||||
// 'orderbook.40.OKSEUSDT',
|
||||
// 'orderbook.40.APEXUSDC',
|
||||
// 'orderbook.40.APEXUSDT',
|
||||
// 'orderbook.40.TRXUSDC',
|
||||
// 'orderbook.40.TRXUSDT',
|
||||
// 'orderbook.40.GMTUSDC',
|
||||
// 'orderbook.40.GMTUSDT',
|
||||
// 'orderbook.40.SHIBUSDC',
|
||||
// 'orderbook.40.SHIBUSDT',
|
||||
// 'orderbook.40.LDOUSDC',
|
||||
// 'orderbook.40.LDOUSDT',
|
||||
// 'orderbook.40.APEUSDC',
|
||||
// 'orderbook.40.APEUSDT',
|
||||
// 'orderbook.40.FILUSDC',
|
||||
// 'orderbook.40.FILUSDT',
|
||||
// ]);
|
||||
|
||||
// usdc options
|
||||
// wsClient.subscribe([
|
||||
// `recenttrades.BTC`,
|
||||
// `recenttrades.ETH`,
|
||||
// `recenttrades.SOL`,
|
||||
// ]);
|
||||
|
||||
// usdc perps (note: the syntax is different for the unified perp market)
|
||||
// (market: 'usdcPerp')
|
||||
// wsClient.subscribe('trade.BTCUSDC');
|
||||
// wsClient.subscribe('instrument_info.100ms.BTCPERP');
|
||||
|
||||
// unified perps
|
||||
// wsClient.subscribe('publicTrade.BTCUSDT');
|
||||
// wsClient.subscribe('publicTrade.BTCPERP');
|
||||
|
||||
// For spot v1 (the old, deprecated client), request public connection first then send required topics on 'open'
|
||||
// Not necessary for spot v3
|
||||
// wsClient.connectPublic();
|
||||
|
||||
// To unsubscribe from topics (after a 5 second delay, in this example):
|
||||
// setTimeout(() => {
|
||||
// console.log('unsubscribing');
|
||||
// wsClient.unsubscribe('trade.BTCUSDT');
|
||||
// }, 5 * 1000);
|
||||
|
||||
// Topics are tracked per websocket type
|
||||
// Get a list of subscribed topics (e.g. for public v3 spot topics) (after a 5 second delay)
|
||||
setTimeout(() => {
|
||||
const publicSpotTopics = wsClient
|
||||
.getWsStore()
|
||||
.getTopics(WS_KEY_MAP.spotV3Public);
|
||||
|
||||
console.log('public spot topics: ', publicSpotTopics);
|
||||
|
||||
const privateSpotTopics = wsClient
|
||||
.getWsStore()
|
||||
.getTopics(WS_KEY_MAP.spotV3Private);
|
||||
console.log('private spot topics: ', privateSpotTopics);
|
||||
}, 5 * 1000);
|
||||
183
examples/fasterHmacSign.ts
Normal file
183
examples/fasterHmacSign.ts
Normal file
@@ -0,0 +1,183 @@
|
||||
import { createHmac } from 'crypto';
|
||||
import { DefaultLogger, RestClientV5, WebsocketClient } from '../src/index';
|
||||
|
||||
// or
|
||||
// import { createHmac } from 'crypto';
|
||||
// import { DefaultLogger, RestClientV5, WebsocketClient } from 'bybit-api';
|
||||
|
||||
/**
|
||||
* Injecting a custom signMessage function.
|
||||
*
|
||||
* As of version 4.0.0 of the bybit-api Node.js/TypeScript/JavaScript
|
||||
* SDK for Bybit, the SDK uses the Web Crypto API for signing requests.
|
||||
* While it is compatible with Node and Browser environments, it is
|
||||
* slightly slower than using Node's native crypto module (only
|
||||
* available in backend Node environments).
|
||||
*
|
||||
* For latency sensitive users, you can inject the previous node crypto sign
|
||||
* method (or your own even faster-implementation), if this change affects you.
|
||||
*
|
||||
* This example demonstrates how to inject a custom sign function, to achieve
|
||||
* the same peformance as seen before the Web Crypto API was introduced.
|
||||
*
|
||||
* For context on standard usage, the "signMessage" function is used:
|
||||
* - During every single API call
|
||||
* - After opening a new private WebSocket connection
|
||||
*
|
||||
*/
|
||||
|
||||
const key = process.env.API_KEY_COM;
|
||||
const secret = process.env.API_SECRET_COM;
|
||||
|
||||
const restClient = new RestClientV5({
|
||||
key: key,
|
||||
secret: secret,
|
||||
parseAPIRateLimits: true,
|
||||
/**
|
||||
* Set this to true to enable demo trading:
|
||||
*/
|
||||
demoTrading: true,
|
||||
/**
|
||||
* Overkill in almost every case, but if you need any optimisation available,
|
||||
* you can inject a faster sign mechanism such as node's native createHmac:
|
||||
*/
|
||||
customSignMessageFn: async (message, secret) => {
|
||||
return createHmac('sha256', secret).update(message).digest('hex');
|
||||
},
|
||||
});
|
||||
|
||||
// Optional, uncomment the "trace" override to log a lot more info about what the WS client is doing
|
||||
const customLogger = {
|
||||
...DefaultLogger,
|
||||
// trace: (...params) => console.log('trace', ...params),
|
||||
};
|
||||
|
||||
const wsClient = new WebsocketClient(
|
||||
{
|
||||
key: key,
|
||||
secret: secret,
|
||||
/**
|
||||
* Set this to true to enable demo trading for the private account data WS
|
||||
* Topics: order,execution,position,wallet,greeks
|
||||
*/
|
||||
demoTrading: true,
|
||||
/**
|
||||
* Overkill in almost every case, but if you need any optimisation available,
|
||||
* you can inject a faster sign mechanism such as node's native createHmac:
|
||||
*/
|
||||
customSignMessageFn: async (message, secret) => {
|
||||
return createHmac('sha256', secret).update(message).digest('hex');
|
||||
},
|
||||
},
|
||||
customLogger,
|
||||
);
|
||||
|
||||
function setWsClientEventListeners(
|
||||
websocketClient: WebsocketClient,
|
||||
accountRef: string,
|
||||
): Promise<void> {
|
||||
return new Promise((resolve) => {
|
||||
websocketClient.on('update', (data) => {
|
||||
console.log(new Date(), accountRef, 'data ', JSON.stringify(data));
|
||||
// console.log('raw message received ', JSON.stringify(data, null, 2));
|
||||
});
|
||||
|
||||
websocketClient.on('open', (data) => {
|
||||
console.log(
|
||||
new Date(),
|
||||
accountRef,
|
||||
'connection opened open:',
|
||||
data.wsKey,
|
||||
);
|
||||
});
|
||||
websocketClient.on('response', (data) => {
|
||||
console.log(
|
||||
new Date(),
|
||||
accountRef,
|
||||
'log response: ',
|
||||
JSON.stringify(data, null, 2),
|
||||
);
|
||||
|
||||
if (typeof data.req_id === 'string') {
|
||||
const topics = data.req_id.split(',');
|
||||
if (topics.length) {
|
||||
console.log(new Date(), accountRef, 'Subscribed to topics: ', topics);
|
||||
return resolve();
|
||||
}
|
||||
}
|
||||
});
|
||||
websocketClient.on('reconnect', ({ wsKey }) => {
|
||||
console.log(
|
||||
new Date(),
|
||||
accountRef,
|
||||
'ws automatically reconnecting.... ',
|
||||
wsKey,
|
||||
);
|
||||
});
|
||||
websocketClient.on('reconnected', (data) => {
|
||||
console.log(new Date(), accountRef, 'ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
websocketClient.on('exception', (data) => {
|
||||
console.error(new Date(), accountRef, 'ws exception: ', data);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
const onSubscribed = setWsClientEventListeners(wsClient, 'demoAcc');
|
||||
|
||||
wsClient.subscribeV5(['position', 'execution', 'wallet'], 'linear');
|
||||
|
||||
// Simple promise to ensure we're subscribed before trying anything else
|
||||
await onSubscribed;
|
||||
|
||||
// Start trading
|
||||
const balResponse1 = await restClient.getWalletBalance({
|
||||
accountType: 'UNIFIED',
|
||||
});
|
||||
console.log('balResponse1: ', JSON.stringify(balResponse1, null, 2));
|
||||
|
||||
const demoFunds = await restClient.requestDemoTradingFunds();
|
||||
console.log('requested demo funds: ', demoFunds);
|
||||
|
||||
const balResponse2 = await restClient.getWalletBalance({
|
||||
accountType: 'UNIFIED',
|
||||
});
|
||||
console.log('balResponse2: ', JSON.stringify(balResponse2, null, 2));
|
||||
|
||||
/** Simple examples for private REST API calls with bybit's V5 REST APIs */
|
||||
const response = await restClient.getPositionInfo({
|
||||
category: 'linear',
|
||||
symbol: 'BTCUSDT',
|
||||
});
|
||||
|
||||
console.log('response:', response);
|
||||
|
||||
// Trade USDT linear perps
|
||||
const buyOrderResult = await restClient.submitOrder({
|
||||
category: 'linear',
|
||||
symbol: 'BTCUSDT',
|
||||
orderType: 'Market',
|
||||
qty: '1',
|
||||
side: 'Buy',
|
||||
});
|
||||
console.log('buyOrderResult:', buyOrderResult);
|
||||
|
||||
const sellOrderResult = await restClient.submitOrder({
|
||||
category: 'linear',
|
||||
symbol: 'BTCUSDT',
|
||||
orderType: 'Market',
|
||||
qty: '1',
|
||||
side: 'Sell',
|
||||
});
|
||||
console.log('sellOrderResult:', sellOrderResult);
|
||||
|
||||
const balResponse3 = await restClient.getWalletBalance({
|
||||
accountType: 'UNIFIED',
|
||||
});
|
||||
console.log('balResponse2: ', JSON.stringify(balResponse3, null, 2));
|
||||
} catch (e) {
|
||||
console.error('request failed: ', e);
|
||||
}
|
||||
})();
|
||||
152
examples/ws-api-events.ts
Normal file
152
examples/ws-api-events.ts
Normal file
@@ -0,0 +1,152 @@
|
||||
import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from '../src';
|
||||
|
||||
// or
|
||||
// import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from 'bybit-api';
|
||||
|
||||
const logger = {
|
||||
...DefaultLogger,
|
||||
// For a more detailed view of the WebsocketClient, enable the `trace` level by uncommenting the below line:
|
||||
// trace: (...params) => console.log('trace', ...params),
|
||||
};
|
||||
|
||||
const key = process.env.API_KEY;
|
||||
const secret = process.env.API_SECRET;
|
||||
|
||||
const wsClient = new WebsocketClient(
|
||||
{
|
||||
key: key,
|
||||
secret: secret,
|
||||
// testnet: true, // Whether to use the testnet environment: https://testnet.bybit.com/app/user/api-management
|
||||
// demoTrading: false, // note: As of Jan 2025, demo trading does NOT support the WS API
|
||||
},
|
||||
logger, // Optional: inject a custom logger
|
||||
);
|
||||
|
||||
/**
|
||||
* General event handlers for monitoring the WebsocketClient
|
||||
*/
|
||||
wsClient.on('update', (data) => {
|
||||
console.log('raw message received ', JSON.stringify(data));
|
||||
});
|
||||
wsClient.on('open', (data) => {
|
||||
console.log('ws connected', data.wsKey);
|
||||
});
|
||||
wsClient.on('reconnect', ({ wsKey }) => {
|
||||
console.log('ws automatically reconnecting.... ', wsKey);
|
||||
});
|
||||
wsClient.on('reconnected', (data) => {
|
||||
console.log('ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
wsClient.on('authenticated', (data) => {
|
||||
console.log('ws has authenticated ', data?.wsKey);
|
||||
});
|
||||
|
||||
async function main() {
|
||||
/**
|
||||
*
|
||||
* This SDK's WebSocket API integration is event-driven at its core. You can treat the sentWSAPIRquest(...) method as
|
||||
* a fire-and-forget method, to submit commands (create/amend/cancel order) via a WebSocket Connection.
|
||||
*
|
||||
* Replies to commands will show in the `response` event from the WebsocketClient's EventEmitter. Exceptions, however,
|
||||
* will show in the `error` event from the WebsocketClient's EventEmitter.
|
||||
*
|
||||
* - Fire-and-forget a command.
|
||||
* - Handle command results in the `response` event handler asynchronously as desired.
|
||||
* - Handle any exceptions in a catch block.
|
||||
*
|
||||
* This is a more "raw" workflow in how WebSockets behave. For a more convenient & REST-like approach, using the
|
||||
* promise-driven interface is recommended. See the `ws-api-promises.ts` example for a demonstration you can compare.
|
||||
*
|
||||
* Note: even without using promises, you should still tie on a .catch handler to each sendWSAPIRequest call, to prevent
|
||||
* any unnecessary "unhandled promise rejection" exceptions.
|
||||
*
|
||||
*/
|
||||
|
||||
// To make it easier to watch, wait a few seconds before sending the amend order
|
||||
const AMEND_AFTER_SECONDS = 3;
|
||||
|
||||
// Then wait a few more before sending the cancel order
|
||||
const CANCEL_AFTER_SECONDS = 5;
|
||||
|
||||
// Exceptions including rejected commands will show here (as well as the catch handler used below)
|
||||
wsClient.on('exception', (data) => {
|
||||
console.error('ws exception: ', data);
|
||||
});
|
||||
|
||||
// Replies to commands will show here
|
||||
wsClient.on('response', (data) => {
|
||||
console.log('received reply to command: ', JSON.stringify(data, null, 2));
|
||||
});
|
||||
|
||||
/**
|
||||
*
|
||||
* If you haven't connected yet, the WebsocketClient will automatically connect and authenticate you as soon as you send
|
||||
* your first command. That connection will then be reused for every command you send, unless the connection drops - then
|
||||
* it will automatically be replaced with a healthy connection.
|
||||
*
|
||||
* This "not connected yet" scenario can add an initial delay to your first command. If you want to prepare a connection
|
||||
* in advance, you can ask the WebsocketClient to prepare it before you start submitting commands. This is optional.
|
||||
*
|
||||
* Repeated note: even without using promises, you should still tie on a .catch handler to each sendWSAPIRequest call, to prevent
|
||||
* any unnecessary "unhandled promise rejection" exceptions.
|
||||
*
|
||||
*/
|
||||
|
||||
// Optional, see above. Can be used to prepare a connection before sending commands
|
||||
await wsClient.connectWSAPI();
|
||||
|
||||
console.log('Step 1: Create an order');
|
||||
|
||||
// Fire and forget the create.order command
|
||||
// Even without using promises, you should still "catch" exceptions (although no need to await anything you send)
|
||||
wsClient
|
||||
.sendWSAPIRequest(WS_KEY_MAP.v5PrivateTrade, 'order.create', {
|
||||
symbol: 'BTCUSDT',
|
||||
side: 'Buy',
|
||||
orderType: 'Limit',
|
||||
price: '50000',
|
||||
qty: '1',
|
||||
category: 'linear',
|
||||
})
|
||||
.catch((e) => console.error('Step 1: Order submit exception: ', e));
|
||||
|
||||
console.log('Step 1: Create order sent...');
|
||||
|
||||
//
|
||||
setTimeout(() => {
|
||||
console.log('Step 2: Amend an order');
|
||||
|
||||
// Fire and forget the order.amend command
|
||||
// For simplicity, the orderId is hardcoded here (and will probably not work)
|
||||
wsClient
|
||||
.sendWSAPIRequest(WS_KEY_MAP.v5PrivateTrade, 'order.amend', {
|
||||
symbol: 'BTCUSDT',
|
||||
category: 'linear',
|
||||
orderId: '1234567',
|
||||
price: '55000',
|
||||
})
|
||||
.catch((e) => console.error('Step 2: Amend order exception: ', e));
|
||||
|
||||
console.log('Step 2: Amend order sent...');
|
||||
}, AMEND_AFTER_SECONDS * 1000);
|
||||
|
||||
//
|
||||
setTimeout(() => {
|
||||
console.log('Step 3: Cancel an order');
|
||||
|
||||
// Fire and forget the order.cancel command
|
||||
// For simplicity, the orderId is hardcoded here (and will probably not work)
|
||||
wsClient
|
||||
.sendWSAPIRequest(WS_KEY_MAP.v5PrivateTrade, 'order.cancel', {
|
||||
category: 'linear',
|
||||
symbol: 'BTCUSDT',
|
||||
orderId: '1234567',
|
||||
})
|
||||
.catch((e) => console.error('Step 3: Cancel order exception: ', e));
|
||||
|
||||
console.log('Step 3: Cancel order sent...');
|
||||
}, CANCEL_AFTER_SECONDS * 1000);
|
||||
}
|
||||
|
||||
// Start executing the example workflow
|
||||
main();
|
||||
176
examples/ws-api-promises.ts
Normal file
176
examples/ws-api-promises.ts
Normal file
@@ -0,0 +1,176 @@
|
||||
import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from '../src';
|
||||
|
||||
// or
|
||||
// import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from 'bybit-api';
|
||||
|
||||
const logger = {
|
||||
...DefaultLogger,
|
||||
// For a more detailed view of the WebsocketClient, enable the `trace` level by uncommenting the below line:
|
||||
// trace: (...params) => console.log('trace', ...params),
|
||||
};
|
||||
|
||||
const key = process.env.API_KEY;
|
||||
const secret = process.env.API_SECRET;
|
||||
|
||||
const wsClient = new WebsocketClient(
|
||||
{
|
||||
key: key,
|
||||
secret: secret,
|
||||
// testnet: true, // Whether to use the testnet environment: https://testnet.bybit.com/app/user/api-management
|
||||
// demoTrading: false, // note: As of Jan 2025, demo trading does NOT support the WS API
|
||||
},
|
||||
logger, // Optional: inject a custom logger
|
||||
);
|
||||
|
||||
/**
|
||||
* General event handlers for monitoring the WebsocketClient
|
||||
*/
|
||||
wsClient.on('update', (data) => {
|
||||
console.log('raw message received ', JSON.stringify(data));
|
||||
});
|
||||
wsClient.on('open', (data) => {
|
||||
console.log('ws connected', data.wsKey);
|
||||
});
|
||||
wsClient.on('reconnect', ({ wsKey }) => {
|
||||
console.log('ws automatically reconnecting.... ', wsKey);
|
||||
});
|
||||
wsClient.on('reconnected', (data) => {
|
||||
console.log('ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
wsClient.on('authenticated', (data) => {
|
||||
console.log('ws has authenticated ', data?.wsKey);
|
||||
});
|
||||
wsClient.on('exception', (data) => {
|
||||
console.error('ws exception: ', data);
|
||||
});
|
||||
|
||||
async function main() {
|
||||
/**
|
||||
*
|
||||
* This SDK's WebSocket API integration can connect WS API responses to the request that caused them. Each call
|
||||
* to the `sendWSAPIRequest(...)` method returns a promise.
|
||||
*
|
||||
* This promise will resolve when the matching response is detected, and reject if an exception for that request
|
||||
* is detected. This allows using Bybit's Websocket API in the same way that a REST API normally works.
|
||||
*
|
||||
* Send a command and immediately await the result. Handle any exceptions in a catch block.
|
||||
*
|
||||
* TypeScript users can benefit from smart type flowing for increased type safety & convenience:
|
||||
* - Request parameters are fully typed, depending on the operation in the second parameter to the call. E.g.
|
||||
* the `order.create` operation will automatically require the params to match the `OrderParamsV5` interface.
|
||||
*
|
||||
* - Response parameters are fully typed, depending on the operation in the second parameter. E.g the `order.create`
|
||||
* operation will automatically map the returned value to `WSAPIResponse<OrderResultV5, "order.create">`.
|
||||
*
|
||||
*/
|
||||
|
||||
// To make it easier to watch, wait a few seconds before sending the amend order
|
||||
const AMEND_AFTER_SECONDS = 5;
|
||||
|
||||
// Then wait a few more before sending the cancel order
|
||||
const CANCEL_AFTER_SECONDS = 10;
|
||||
|
||||
/**
|
||||
*
|
||||
* If you haven't connected yet, the WebsocketClient will automatically connect and authenticate you as soon as you send
|
||||
* your first command. That connection will then be reused for every command you send, unless the connection drops - then
|
||||
* it will automatically be replaced with a healthy connection.
|
||||
*
|
||||
* This "not connected yet" scenario can add an initial delay to your first command. If you want to prepare a connection
|
||||
* in advance, you can ask the WebsocketClient to prepare it before you start submitting commands. This is optional.
|
||||
*
|
||||
*/
|
||||
|
||||
// Optional, see above. Can be used to prepare a connection before sending commands
|
||||
await wsClient.connectWSAPI();
|
||||
|
||||
/**
|
||||
* Create a new order
|
||||
*/
|
||||
|
||||
let orderId: string | undefined;
|
||||
|
||||
try {
|
||||
console.log('Step 1: Create an order');
|
||||
|
||||
// The type for `wsAPISubmitOrderResult` is automatically resolved to `WSAPIResponse<OrderResultV5, "order.create">`
|
||||
const wsAPISubmitOrderResult = await wsClient.sendWSAPIRequest(
|
||||
WS_KEY_MAP.v5PrivateTrade,
|
||||
'order.create',
|
||||
{
|
||||
symbol: 'BTCUSDT',
|
||||
side: 'Buy',
|
||||
orderType: 'Limit',
|
||||
price: '50000',
|
||||
qty: '1',
|
||||
category: 'linear',
|
||||
},
|
||||
);
|
||||
|
||||
// Save the orderId for the next call
|
||||
orderId = wsAPISubmitOrderResult.data.orderId;
|
||||
|
||||
console.log(
|
||||
`Step 1: Order result (order ID: "${orderId}"): `,
|
||||
wsAPISubmitOrderResult,
|
||||
);
|
||||
} catch (e) {
|
||||
console.error('Step 1: Order submit exception: ', e);
|
||||
return;
|
||||
}
|
||||
|
||||
setTimeout(async () => {
|
||||
try {
|
||||
console.log('Step 2: Amend an order');
|
||||
|
||||
// The type for `wsAPIAmendOrderResult` is automatically resolved to `WSAPIResponse<OrderResultV5, "order.amend">`
|
||||
const wsAPIAmendOrderResult = await wsClient.sendWSAPIRequest(
|
||||
WS_KEY_MAP.v5PrivateTrade,
|
||||
'order.amend',
|
||||
{
|
||||
symbol: 'BTCUSDT',
|
||||
category: 'linear',
|
||||
orderId,
|
||||
price: '55000',
|
||||
},
|
||||
);
|
||||
|
||||
// Save the orderId for the next call
|
||||
orderId = wsAPIAmendOrderResult.data.orderId;
|
||||
|
||||
console.log(
|
||||
`Step 2: Amend result (order ID: "${orderId}"): `,
|
||||
wsAPIAmendOrderResult,
|
||||
);
|
||||
} catch (e) {
|
||||
console.error('Step 2: Amend order exception: ', e);
|
||||
return;
|
||||
}
|
||||
}, AMEND_AFTER_SECONDS * 1000);
|
||||
|
||||
setTimeout(async () => {
|
||||
try {
|
||||
console.log('Step 3: Cancel an order');
|
||||
|
||||
// The type for `wsAPICancelOrderResult` is automatically resolved to `WSAPIResponse<OrderResultV5, "order.cancel">`
|
||||
const wsAPICancelOrderResult = await wsClient.sendWSAPIRequest(
|
||||
WS_KEY_MAP.v5PrivateTrade,
|
||||
'order.cancel',
|
||||
{
|
||||
category: 'linear',
|
||||
symbol: 'BTCUSDT',
|
||||
orderId,
|
||||
},
|
||||
);
|
||||
|
||||
console.log('Step 3: Cancel result:', wsAPICancelOrderResult);
|
||||
} catch (e) {
|
||||
console.error('Step 3: Cancel order exception: ', e);
|
||||
}
|
||||
|
||||
process.exit(-1);
|
||||
}, CANCEL_AFTER_SECONDS * 1000);
|
||||
}
|
||||
|
||||
// Start executing the example workflow
|
||||
main();
|
||||
@@ -4,10 +4,10 @@ import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from '../src';
|
||||
// or
|
||||
// import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from 'bybit-api';
|
||||
|
||||
// Create & inject a custom logger to disable the silly logging level (empty function)
|
||||
// Create & inject a custom logger to enable the trace logging level (empty function)
|
||||
const logger = {
|
||||
...DefaultLogger,
|
||||
silly: () => {},
|
||||
// trace: (...params) => console.log('trace', ...params),
|
||||
};
|
||||
|
||||
const key = process.env.API_KEY;
|
||||
@@ -26,10 +26,10 @@ const wsClient = new WebsocketClient(
|
||||
{
|
||||
key: key,
|
||||
secret: secret,
|
||||
market: 'v5',
|
||||
testnet: true,
|
||||
// testnet: false,
|
||||
// demoTrading: false, // set testnet to false, if you plan on using demo trading
|
||||
},
|
||||
logger
|
||||
logger,
|
||||
);
|
||||
|
||||
wsClient.on('update', (data) => {
|
||||
@@ -49,7 +49,7 @@ wsClient.on('reconnect', ({ wsKey }) => {
|
||||
wsClient.on('reconnected', (data) => {
|
||||
console.log('ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
// wsClient.on('error', (data) => {
|
||||
// wsClient.on('exception', (data) => {
|
||||
// console.error('ws exception: ', data);
|
||||
// });
|
||||
|
||||
|
||||
92
examples/ws-public-allLiquidations.ts
Normal file
92
examples/ws-public-allLiquidations.ts
Normal file
@@ -0,0 +1,92 @@
|
||||
import { RestClientV5, WebsocketClient, isWsAllLiquidationEvent } from '../src';
|
||||
|
||||
// or
|
||||
// import {
|
||||
// RestClientV5,
|
||||
// WebsocketClient,
|
||||
// isWsAllLiquidationEvent,
|
||||
// } from 'bybit-api';
|
||||
|
||||
function onAllLiquidationEvent(event) {
|
||||
console.log(
|
||||
new Date(),
|
||||
'allLiquidationEvent',
|
||||
JSON.stringify(event, null, 2),
|
||||
);
|
||||
}
|
||||
|
||||
const wsClient = new WebsocketClient({});
|
||||
|
||||
wsClient.on('update', (data) => {
|
||||
if (isWsAllLiquidationEvent(data)) {
|
||||
return onAllLiquidationEvent(data);
|
||||
}
|
||||
|
||||
console.log('raw unahndled message received ', JSON.stringify(data));
|
||||
});
|
||||
|
||||
wsClient.on('open', (data) => {
|
||||
console.log('connection opened open:', data.wsKey);
|
||||
});
|
||||
wsClient.on('response', (data) => {
|
||||
console.log('log response: ', JSON.stringify(data, null, 2));
|
||||
});
|
||||
wsClient.on('reconnect', ({ wsKey }) => {
|
||||
console.log('ws automatically reconnecting.... ', wsKey);
|
||||
});
|
||||
wsClient.on('reconnected', (data) => {
|
||||
console.log('ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
|
||||
wsClient.on('exception', (data) => {
|
||||
console.error('ws exception: ', data);
|
||||
});
|
||||
|
||||
/**
|
||||
*
|
||||
* If you want to receive data for all available symbols, this websocket topic
|
||||
* requires you to subscribe to each symbol individually.
|
||||
*
|
||||
* This can be easily automated by fetching a list of symbols via the REST client,
|
||||
* generating a list of topics (one per symbol), before simply passing an
|
||||
* array of topics to the websocket client per product group (linear & inverse perps).
|
||||
*
|
||||
*/
|
||||
async function start() {
|
||||
const restClientV5 = new RestClientV5();
|
||||
|
||||
const allSymbolsV5ResultLinear = await restClientV5.getTickers({
|
||||
category: 'linear',
|
||||
});
|
||||
const allSymbolsV5ResultInverse = await restClientV5.getTickers({
|
||||
category: 'inverse',
|
||||
});
|
||||
|
||||
const allLinearSymbols = allSymbolsV5ResultLinear.result.list.map(
|
||||
(ticker) => ticker.symbol,
|
||||
);
|
||||
const allInverseSymbols = allSymbolsV5ResultInverse.result.list.map(
|
||||
(ticker) => ticker.symbol,
|
||||
);
|
||||
|
||||
console.log('all v5 linear symbols: ', JSON.stringify(allLinearSymbols));
|
||||
console.log('all v5 inverse symbols: ', JSON.stringify(allInverseSymbols));
|
||||
|
||||
const TOPIC_NAME = 'allLiquidation';
|
||||
|
||||
// Make an array of topics ready for submission
|
||||
const allLinearTopics = allLinearSymbols.map(
|
||||
(symbol) => `${TOPIC_NAME}.${symbol}`,
|
||||
);
|
||||
const inverseTopics = allInverseSymbols.map(
|
||||
(symbol) => `${TOPIC_NAME}.${symbol}`,
|
||||
);
|
||||
|
||||
// subscribe to all linear symbols
|
||||
wsClient.subscribeV5(allLinearTopics, 'linear');
|
||||
|
||||
// subscribe to all inverse symbols
|
||||
wsClient.subscribeV5(inverseTopics, 'inverse');
|
||||
}
|
||||
|
||||
start().catch((e) => console.error('exception in main logic: ', e));
|
||||
@@ -5,7 +5,7 @@ import { DefaultLogger, WS_KEY_MAP, WebsocketClient } from '../src';
|
||||
|
||||
const logger = {
|
||||
...DefaultLogger,
|
||||
silly: (...params) => console.log('silly', ...params),
|
||||
trace: (...params) => console.log('trace', ...params),
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -17,13 +17,8 @@ const logger = {
|
||||
* - Heartbeats/ping/pong/reconnects are all handled automatically.
|
||||
* If a connection drops, the client will clean it up, respawn a fresh connection and resubscribe for you.
|
||||
*/
|
||||
const wsClient = new WebsocketClient(
|
||||
{
|
||||
market: 'v5',
|
||||
// demoTrading: true,
|
||||
},
|
||||
logger,
|
||||
);
|
||||
|
||||
const wsClient = new WebsocketClient({}, logger);
|
||||
|
||||
wsClient.on('update', (data) => {
|
||||
console.log('raw message received ', JSON.stringify(data));
|
||||
@@ -41,9 +36,10 @@ wsClient.on('reconnect', ({ wsKey }) => {
|
||||
wsClient.on('reconnected', (data) => {
|
||||
console.log('ws has reconnected ', data?.wsKey);
|
||||
});
|
||||
// wsClient.on('error', (data) => {
|
||||
// console.error('ws exception: ', data);
|
||||
// });
|
||||
|
||||
wsClient.on('exception', (data) => {
|
||||
console.error('ws exception: ', data);
|
||||
});
|
||||
|
||||
/**
|
||||
* For public V5 topics, use the subscribeV5 method and include the API category this topic is for.
|
||||
@@ -69,6 +65,17 @@ wsClient.on('reconnected', (data) => {
|
||||
// Option v5
|
||||
// wsClient.subscribeV5('publicTrade.BTC', 'option');
|
||||
|
||||
const topics = ['kline.5.XRPUSDT', 'kline.5.BTCUSDT', 'kline.5.ETHUSDT'];
|
||||
|
||||
// Use the subscribeV5() call for most subscribe calls with v5 websockets
|
||||
wsClient.subscribeV5(topics, 'spot');
|
||||
|
||||
// Alternatively, you can also use objects in the wsClient.subscribe() call
|
||||
// wsClient.subscribe({
|
||||
// topic: 'orderook.50.BTCUSDT',
|
||||
// category: 'spot',
|
||||
// });
|
||||
|
||||
/**
|
||||
* For private V5 topics, just call the same subscribeV5() method on the ws client or use the original subscribe() method.
|
||||
*
|
||||
@@ -80,10 +87,6 @@ wsClient.on('reconnected', (data) => {
|
||||
// wsClient.subscribeV5('execution', 'linear');
|
||||
// wsClient.subscribeV5(['order', 'wallet', 'greek'], 'linear');
|
||||
|
||||
const topics = ['kline.5.XRPUSDT', 'kline.5.BTCUSDT', 'kline.5.ETHUSDT'];
|
||||
|
||||
wsClient.subscribeV5(topics, 'spot');
|
||||
|
||||
// To unsubscribe from topics (after a 5 second delay, in this example):
|
||||
setTimeout(() => {
|
||||
console.log('unsubscribing');
|
||||
|
||||
@@ -1,12 +1,13 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES6",
|
||||
"module": "commonjs"
|
||||
"target": "ES6",
|
||||
"module": "commonjs"
|
||||
},
|
||||
"exclude": [
|
||||
"node_modules",
|
||||
"**/node_modules/*",
|
||||
"coverage",
|
||||
"doc"
|
||||
"node_modules",
|
||||
"**/node_modules/*",
|
||||
"coverage",
|
||||
"doc",
|
||||
"examples/ignored/*"
|
||||
]
|
||||
}
|
||||
68
package-lock.json
generated
68
package-lock.json
generated
@@ -1,21 +1,21 @@
|
||||
{
|
||||
"name": "bybit-api",
|
||||
"version": "3.11.0",
|
||||
"version": "4.0.0",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "bybit-api",
|
||||
"version": "3.11.0",
|
||||
"version": "4.0.0",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"axios": "^1.6.6",
|
||||
"axios": "^1.7.9",
|
||||
"isomorphic-ws": "^4.0.1",
|
||||
"ws": "^7.4.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.11",
|
||||
"@types/node": "^20.11.6",
|
||||
"@types/node": "^22.10.7",
|
||||
"@typescript-eslint/eslint-plugin": "^7.1.0",
|
||||
"@typescript-eslint/parser": "^7.1.0",
|
||||
"eslint": "^8.29.0",
|
||||
@@ -25,7 +25,7 @@
|
||||
"jest": "^29.7.0",
|
||||
"ts-jest": "^29.1.2",
|
||||
"ts-node": "^10.9.2",
|
||||
"typescript": "^5.3.3"
|
||||
"typescript": "^5.7.3"
|
||||
},
|
||||
"funding": {
|
||||
"type": "individual",
|
||||
@@ -1695,12 +1695,13 @@
|
||||
"optional": true
|
||||
},
|
||||
"node_modules/@types/node": {
|
||||
"version": "20.11.6",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.11.6.tgz",
|
||||
"integrity": "sha512-+EOokTnksGVgip2PbYbr3xnR7kZigh4LbybAfBAw5BpnQ+FqBYUsvCEjYd70IXKlbohQ64mzEYmMtlWUY8q//Q==",
|
||||
"version": "22.10.7",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.7.tgz",
|
||||
"integrity": "sha512-V09KvXxFiutGp6B7XkpaDXlNadZxrzajcY50EuoLIpQ6WWYCSvf19lVIazzfIzQvhUN2HjX12spLojTnhuKlGg==",
|
||||
"devOptional": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"undici-types": "~5.26.4"
|
||||
"undici-types": "~6.20.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@types/stack-utils": {
|
||||
@@ -2293,9 +2294,10 @@
|
||||
"integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k="
|
||||
},
|
||||
"node_modules/axios": {
|
||||
"version": "1.7.7",
|
||||
"resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz",
|
||||
"integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==",
|
||||
"version": "1.7.9",
|
||||
"resolved": "https://registry.npmjs.org/axios/-/axios-1.7.9.tgz",
|
||||
"integrity": "sha512-LhLcE7Hbiryz8oMDdDptSrWowmB4Bl6RCt6sIJKpRB4XtVf0iEgewX3au/pJqm+Py1kCASkb/FFKjxQaLtxJvw==",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"follow-redirects": "^1.15.6",
|
||||
"form-data": "^4.0.0",
|
||||
@@ -6574,10 +6576,11 @@
|
||||
}
|
||||
},
|
||||
"node_modules/typescript": {
|
||||
"version": "5.3.3",
|
||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz",
|
||||
"integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==",
|
||||
"version": "5.7.3",
|
||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.3.tgz",
|
||||
"integrity": "sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==",
|
||||
"devOptional": true,
|
||||
"license": "Apache-2.0",
|
||||
"bin": {
|
||||
"tsc": "bin/tsc",
|
||||
"tsserver": "bin/tsserver"
|
||||
@@ -6587,10 +6590,11 @@
|
||||
}
|
||||
},
|
||||
"node_modules/undici-types": {
|
||||
"version": "5.26.5",
|
||||
"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
|
||||
"integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
|
||||
"devOptional": true
|
||||
"version": "6.20.0",
|
||||
"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.20.0.tgz",
|
||||
"integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==",
|
||||
"devOptional": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/update-browserslist-db": {
|
||||
"version": "1.1.0",
|
||||
@@ -8331,12 +8335,12 @@
|
||||
"optional": true
|
||||
},
|
||||
"@types/node": {
|
||||
"version": "20.11.6",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-20.11.6.tgz",
|
||||
"integrity": "sha512-+EOokTnksGVgip2PbYbr3xnR7kZigh4LbybAfBAw5BpnQ+FqBYUsvCEjYd70IXKlbohQ64mzEYmMtlWUY8q//Q==",
|
||||
"version": "22.10.7",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.7.tgz",
|
||||
"integrity": "sha512-V09KvXxFiutGp6B7XkpaDXlNadZxrzajcY50EuoLIpQ6WWYCSvf19lVIazzfIzQvhUN2HjX12spLojTnhuKlGg==",
|
||||
"devOptional": true,
|
||||
"requires": {
|
||||
"undici-types": "~5.26.4"
|
||||
"undici-types": "~6.20.0"
|
||||
}
|
||||
},
|
||||
"@types/stack-utils": {
|
||||
@@ -8782,9 +8786,9 @@
|
||||
"integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k="
|
||||
},
|
||||
"axios": {
|
||||
"version": "1.7.7",
|
||||
"resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz",
|
||||
"integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==",
|
||||
"version": "1.7.9",
|
||||
"resolved": "https://registry.npmjs.org/axios/-/axios-1.7.9.tgz",
|
||||
"integrity": "sha512-LhLcE7Hbiryz8oMDdDptSrWowmB4Bl6RCt6sIJKpRB4XtVf0iEgewX3au/pJqm+Py1kCASkb/FFKjxQaLtxJvw==",
|
||||
"requires": {
|
||||
"follow-redirects": "^1.15.6",
|
||||
"form-data": "^4.0.0",
|
||||
@@ -11926,15 +11930,15 @@
|
||||
"dev": true
|
||||
},
|
||||
"typescript": {
|
||||
"version": "5.3.3",
|
||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz",
|
||||
"integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==",
|
||||
"version": "5.7.3",
|
||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.3.tgz",
|
||||
"integrity": "sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==",
|
||||
"devOptional": true
|
||||
},
|
||||
"undici-types": {
|
||||
"version": "5.26.5",
|
||||
"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
|
||||
"integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
|
||||
"version": "6.20.0",
|
||||
"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.20.0.tgz",
|
||||
"integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==",
|
||||
"devOptional": true
|
||||
},
|
||||
"update-browserslist-db": {
|
||||
|
||||
12
package.json
12
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "bybit-api",
|
||||
"version": "3.11.0",
|
||||
"version": "4.0.0",
|
||||
"description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
|
||||
"main": "lib/index.js",
|
||||
"types": "lib/index.d.ts",
|
||||
@@ -20,17 +20,15 @@
|
||||
"betapublish": "npm publish --tag beta"
|
||||
},
|
||||
"author": "Tiago Siebler (https://github.com/tiagosiebler)",
|
||||
"contributors": [
|
||||
"Stefan Aebischer <os@pixtron.ch> (https://pixtron.ch)"
|
||||
],
|
||||
"contributors": [],
|
||||
"dependencies": {
|
||||
"axios": "^1.6.6",
|
||||
"axios": "^1.7.9",
|
||||
"isomorphic-ws": "^4.0.1",
|
||||
"ws": "^7.4.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.11",
|
||||
"@types/node": "^20.11.6",
|
||||
"@types/node": "^22.10.7",
|
||||
"@typescript-eslint/eslint-plugin": "^7.1.0",
|
||||
"@typescript-eslint/parser": "^7.1.0",
|
||||
"eslint": "^8.29.0",
|
||||
@@ -40,7 +38,7 @@
|
||||
"jest": "^29.7.0",
|
||||
"ts-jest": "^29.1.2",
|
||||
"ts-node": "^10.9.2",
|
||||
"typescript": "^5.3.3"
|
||||
"typescript": "^5.7.3"
|
||||
},
|
||||
"optionalDependencies": {
|
||||
"source-map-loader": "^2.0.0",
|
||||
|
||||
@@ -1,314 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import {
|
||||
APIKeyInfoV3,
|
||||
APIResponseV3WithTime,
|
||||
APIResponseWithTime,
|
||||
AccountCoinBalanceResponseV3,
|
||||
AccountCoinBalancesRequestV3,
|
||||
AccountCoinBalancesResponseV3,
|
||||
AssetInfoRequestV3,
|
||||
AssetInfoResponseV3,
|
||||
CoinInfoQueryResponseV3,
|
||||
CreateSubAPIKeyRequestV3,
|
||||
CreateSubAPIKeyResponseV3,
|
||||
CreateSubMemberRequestV3,
|
||||
CreateSubMemberResponseV3,
|
||||
DepositAddressResponseV3,
|
||||
DepositRecordQueryRequestV3,
|
||||
DepositRecordQueryResponseV3,
|
||||
InternalTransferRequestV3,
|
||||
ModifyAPIKeyRequestV3,
|
||||
QueryDepositAddressRequestV3,
|
||||
QueryInternalTransferSResponseV3,
|
||||
QueryInternalTransfersRequestV3,
|
||||
QuerySubAccountDepositAddressRequestV3,
|
||||
SingleAccountCoinBalanceRequestV3,
|
||||
SubAccountTransferRequestV3,
|
||||
SubAccountTransferResponseV3,
|
||||
SubDepositRecordQueryRequestV3,
|
||||
SubMemberResponseV3,
|
||||
SupportedDepositListRequestV3,
|
||||
SupportedDepositListResponseV3,
|
||||
TransferCoinListRequestV3,
|
||||
UniversalTransferCreateResponse,
|
||||
UniversalTransferListRequestV3,
|
||||
UniversalTransferListResponseV3,
|
||||
UniversalTransferRequestV3,
|
||||
WithdrawCreateRequestV3,
|
||||
WithdrawRecordQueryRequestV3,
|
||||
WithdrawRecordsQueryResponseV3,
|
||||
} from './types';
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for Account Asset V3 APIs
|
||||
* @deprecated WARNING
|
||||
* These endpoints are being switched off gradually and are expected to be completely turned off by the end of 2024.
|
||||
* They may stop working at any point before then.
|
||||
* Please update your code as soon as possible to use the V5 APIs instead.
|
||||
*/
|
||||
export class AccountAssetClientV3 extends BaseRestClient {
|
||||
getClientType() {
|
||||
return REST_CLIENT_TYPE_ENUM.v3;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const res = await this.getServerTime();
|
||||
return Number(res.time);
|
||||
}
|
||||
|
||||
getServerTime(): Promise<
|
||||
APIResponseV3WithTime<{ timeSecond: string; timeNano: string }>
|
||||
> {
|
||||
return this.get('/v3/public/time');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Transfer Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
createInternalTransfer(
|
||||
params: InternalTransferRequestV3,
|
||||
): Promise<APIResponseWithTime<{ transferId: string }>> {
|
||||
return this.postPrivate(
|
||||
'/asset/v3/private/transfer/inter-transfer',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getInternalTransfers(
|
||||
params: QueryInternalTransfersRequestV3,
|
||||
): Promise<APIResponseWithTime<QueryInternalTransferSResponseV3>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v3/private/transfer/inter-transfer/list/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
createSubAccountTransfer(params: {
|
||||
transferId: string;
|
||||
coin: string;
|
||||
amount: string;
|
||||
subMemberId: number;
|
||||
type: 'IN' | 'OUT';
|
||||
}): Promise<APIResponseWithTime<{ transferId: string }>> {
|
||||
return this.postPrivate(
|
||||
'/asset/v3/private/transfer/sub-member-transfer',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getSubAccountTransfers(
|
||||
params?: SubAccountTransferRequestV3,
|
||||
): Promise<APIResponseWithTime<SubAccountTransferResponseV3>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v3/private/transfer/sub-member-transfer/list/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getSubAccounts(): Promise<
|
||||
APIResponseWithTime<{
|
||||
subMemberIds: string[];
|
||||
transferableSubMemberIds: string[];
|
||||
}>
|
||||
> {
|
||||
return this.getPrivate('/asset/v3/private/transfer/sub-member/list/query');
|
||||
}
|
||||
|
||||
enableUniversalTransfer(params?: {
|
||||
subMemberIds?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate(
|
||||
'/asset/v3/private/transfer/transfer-sub-member-save',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
createUniversalTransfer(
|
||||
params: UniversalTransferRequestV3,
|
||||
): Promise<APIResponseWithTime<UniversalTransferCreateResponse>> {
|
||||
return this.postPrivate(
|
||||
'/asset/v3/private/transfer/universal-transfer',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getUniversalTransfers(
|
||||
params: UniversalTransferListRequestV3,
|
||||
): Promise<APIResponseWithTime<UniversalTransferListResponseV3>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v3/private/transfer/universal-transfer/list/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getTransferableCoinList(
|
||||
params: TransferCoinListRequestV3,
|
||||
): Promise<APIResponseWithTime<{ list: string[] }>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v3/private/transfer/transfer-coin/list/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getAccountCoinBalance(
|
||||
params: SingleAccountCoinBalanceRequestV3,
|
||||
): Promise<APIResponseWithTime<AccountCoinBalanceResponseV3>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v3/private/transfer/account-coin/balance/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getAccountCoinBalances(
|
||||
params: AccountCoinBalancesRequestV3,
|
||||
): Promise<APIResponseWithTime<AccountCoinBalancesResponseV3>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v3/private/transfer/account-coins/balance/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getAssetInfo(
|
||||
params?: AssetInfoRequestV3,
|
||||
): Promise<APIResponseWithTime<AssetInfoResponseV3>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v3/private/transfer/asset-info/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Wallet & Deposit Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** Get Deposit Spec */
|
||||
getSupportedDepositList(
|
||||
params?: SupportedDepositListRequestV3,
|
||||
): Promise<APIResponseWithTime<SupportedDepositListResponseV3>> {
|
||||
return this.get(
|
||||
'/asset/v3/public/deposit/allowed-deposit-list/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getDepositRecords(
|
||||
params?: DepositRecordQueryRequestV3,
|
||||
): Promise<APIResponseWithTime<DepositRecordQueryResponseV3>> {
|
||||
return this.getPrivate('/asset/v3/private/deposit/record/query', params);
|
||||
}
|
||||
|
||||
getSubDepositRecords(
|
||||
params: SubDepositRecordQueryRequestV3,
|
||||
): Promise<APIResponseWithTime<DepositRecordQueryResponseV3>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v3/private/deposit/sub-member-record/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getWithdrawRecords(
|
||||
params?: WithdrawRecordQueryRequestV3,
|
||||
): Promise<APIResponseWithTime<WithdrawRecordsQueryResponseV3>> {
|
||||
return this.getPrivate('/asset/v3/private/withdraw/record/query', params);
|
||||
}
|
||||
|
||||
getCoinInformation(
|
||||
coin?: string,
|
||||
): Promise<APIResponseWithTime<CoinInfoQueryResponseV3>> {
|
||||
return this.getPrivate('/asset/v3/private/coin-info/query', { coin });
|
||||
}
|
||||
|
||||
submitWithdrawal(
|
||||
params: WithdrawCreateRequestV3,
|
||||
): Promise<APIResponseWithTime<{ id: string }>> {
|
||||
return this.postPrivate('/asset/v3/private/withdraw/create', params);
|
||||
}
|
||||
|
||||
cancelWithdrawal(
|
||||
withdrawalId: number,
|
||||
): Promise<APIResponseWithTime<{ status: 1 | 0 }>> {
|
||||
return this.postPrivate('/asset/v3/private/withdraw/create', {
|
||||
withdrawalId,
|
||||
});
|
||||
}
|
||||
|
||||
getMasterAccountDepositAddress(
|
||||
params?: QueryDepositAddressRequestV3,
|
||||
): Promise<APIResponseWithTime<DepositAddressResponseV3>> {
|
||||
return this.getPrivate('/asset/v3/private/deposit/address/query', params);
|
||||
}
|
||||
|
||||
getSubAccountDepositAddress(
|
||||
params: QuerySubAccountDepositAddressRequestV3,
|
||||
): Promise<APIResponseWithTime<DepositAddressResponseV3>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v3/private/deposit/sub-member-address/query',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
createSubMember(
|
||||
params: CreateSubMemberRequestV3,
|
||||
): Promise<APIResponseWithTime<CreateSubMemberResponseV3>> {
|
||||
return this.postPrivate('/user/v3/private/create-sub-member', params);
|
||||
}
|
||||
|
||||
createSubAPIKey(
|
||||
params: CreateSubAPIKeyRequestV3,
|
||||
): Promise<APIResponseWithTime<CreateSubAPIKeyResponseV3>> {
|
||||
return this.postPrivate('/user/v3/private/create-sub-api', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Sub UID List
|
||||
*/
|
||||
getSubMembers(): Promise<APIResponseWithTime<SubMemberResponseV3>> {
|
||||
return this.getPrivate('/user/v3/private/query-sub-members');
|
||||
}
|
||||
|
||||
/**
|
||||
* Froze Sub UID
|
||||
*/
|
||||
freezeSubMember(
|
||||
subuid: number,
|
||||
frozenStatus: 0 | 1,
|
||||
): Promise<APIResponseWithTime<{}>> {
|
||||
return this.postPrivate('/user/v3/private/frozen-sub-member', {
|
||||
subuid,
|
||||
frozen: frozenStatus,
|
||||
});
|
||||
}
|
||||
|
||||
getAPIKeyInformation(): Promise<APIResponseWithTime<APIKeyInfoV3>> {
|
||||
return this.getPrivate('/user/v3/private/query-api');
|
||||
}
|
||||
|
||||
modifyMasterAPIKey(
|
||||
params: ModifyAPIKeyRequestV3,
|
||||
): Promise<APIResponseWithTime<APIKeyInfoV3>> {
|
||||
return this.postPrivate('/user/v3/private/update-api', params);
|
||||
}
|
||||
|
||||
modifySubAPIKey(
|
||||
params: ModifyAPIKeyRequestV3,
|
||||
): Promise<APIResponseWithTime<APIKeyInfoV3>> {
|
||||
return this.postPrivate('/user/v3/private/update-sub-api', params);
|
||||
}
|
||||
|
||||
/** WARNING: BE CAREFUL! The API key used to call this interface will be invalid immediately. */
|
||||
deleteMasterAPIKey(): Promise<APIResponseWithTime<{}>> {
|
||||
return this.postPrivate('/user/v3/private/delete-api');
|
||||
}
|
||||
|
||||
/** WARNING: BE CAREFUL! The API key used to call this interface will be invalid immediately. */
|
||||
deleteSubAPIKey(): Promise<APIResponseWithTime<{}>> {
|
||||
return this.postPrivate('/user/v3/private/delete-sub-api');
|
||||
}
|
||||
}
|
||||
@@ -1,153 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import {
|
||||
APIResponseWithTime,
|
||||
AccountAssetInformationRequest,
|
||||
DepositRecordsRequest,
|
||||
EnableUniversalTransferRequest,
|
||||
InternalTransferRequest,
|
||||
SubAccountTransferRequest,
|
||||
SupportedDepositListRequest,
|
||||
TransferQueryRequest,
|
||||
UniversalTransferRequest,
|
||||
WithdrawalRecordsRequest,
|
||||
WithdrawalRequest,
|
||||
} from './types';
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for Account Asset APIs
|
||||
*
|
||||
* @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
|
||||
* will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
|
||||
* Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
|
||||
*/
|
||||
export class AccountAssetClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
return REST_CLIENT_TYPE_ENUM.accountAsset;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const res = await this.getServerTime();
|
||||
return Number(res.time_now);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Transfer Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
createInternalTransfer(
|
||||
params: InternalTransferRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('/asset/v1/private/transfer', params);
|
||||
}
|
||||
|
||||
createSubAccountTransfer(
|
||||
params: SubAccountTransferRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('/asset/v1/private/sub-member/transfer', params);
|
||||
}
|
||||
|
||||
getInternalTransfers(
|
||||
params?: TransferQueryRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('/asset/v1/private/transfer/list', params);
|
||||
}
|
||||
|
||||
getSubAccountTransfers(
|
||||
params?: TransferQueryRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v1/private/sub-member/transfer/list',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getSubAccounts(): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('/asset/v1/private/sub-member/member-ids');
|
||||
}
|
||||
|
||||
enableUniversalTransfer(
|
||||
params?: EnableUniversalTransferRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('/asset/v1/private/transferable-subs/save', params);
|
||||
}
|
||||
|
||||
createUniversalTransfer(
|
||||
params: UniversalTransferRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('/asset/v1/private/universal/transfer', params);
|
||||
}
|
||||
|
||||
getUniversalTransfers(
|
||||
params?: TransferQueryRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('/asset/v1/private/universal/transfer/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Wallet & Deposit Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getSupportedDepositList(
|
||||
params?: SupportedDepositListRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.get('/asset/v1/public/deposit/allowed-deposit-list', params);
|
||||
}
|
||||
|
||||
getDepositRecords(
|
||||
params?: DepositRecordsRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('/asset/v1/private/deposit/record/query', params);
|
||||
}
|
||||
|
||||
getWithdrawRecords(
|
||||
params?: WithdrawalRecordsRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('/asset/v1/private/withdraw/record/query', params);
|
||||
}
|
||||
|
||||
getCoinInformation(coin?: string): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('/asset/v1/private/coin-info/query', { coin });
|
||||
}
|
||||
|
||||
getAssetInformation(
|
||||
params?: AccountAssetInformationRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('/asset/v1/private/asset-info/query', params);
|
||||
}
|
||||
|
||||
submitWithdrawal(
|
||||
params: WithdrawalRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('/asset/v1/private/withdraw', params);
|
||||
}
|
||||
|
||||
cancelWithdrawal(withdrawalId: number): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('/asset/v1/private/withdraw/cancel', {
|
||||
id: withdrawalId,
|
||||
});
|
||||
}
|
||||
|
||||
getDepositAddress(coin: string): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('/asset/v1/private/deposit/address', { coin });
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime> {
|
||||
return this.get('/v2/public/time');
|
||||
}
|
||||
|
||||
getApiAnnouncements(): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('/v2/public/announcement');
|
||||
}
|
||||
}
|
||||
@@ -1,364 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import {
|
||||
APIResponseV3,
|
||||
APIResponseWithTime,
|
||||
ContractActiveOrdersRequest,
|
||||
ContractCancelOrderRequest,
|
||||
ContractClosedPNLRequest,
|
||||
ContractHistoricOrder,
|
||||
ContractHistoricOrdersRequest,
|
||||
ContractListResult,
|
||||
ContractModifyOrderRequest,
|
||||
ContractOrderRequest,
|
||||
ContractPositionsRequest,
|
||||
ContractSetAutoAddMarginRequest,
|
||||
ContractSetMarginSwitchRequest,
|
||||
ContractSetPositionModeRequest,
|
||||
ContractSetTPSLRequest,
|
||||
ContractSymbolTicker,
|
||||
ContractUserExecutionHistoryRequest,
|
||||
ContractWalletFundRecordRequest,
|
||||
PaginatedResult,
|
||||
UMCandlesRequest,
|
||||
UMCategory,
|
||||
UMFundingRateHistoryRequest,
|
||||
UMInstrumentInfoRequest,
|
||||
UMOpenInterestRequest,
|
||||
UMOptionDeliveryPriceRequest,
|
||||
UMPublicTradesRequest,
|
||||
} from './types';
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for Derivatives V3 Contract APIs
|
||||
* @deprecated WARNING
|
||||
* These endpoints are being switched off gradually and are expected to be completely turned off by the end of 2024.
|
||||
* They may stop working at any point before then.
|
||||
* Please update your code as soon as possible to use the V5 APIs instead.
|
||||
*/
|
||||
export class ContractClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
// Follows the same authentication mechanism as other v3 APIs (e.g. USDC)
|
||||
return REST_CLIENT_TYPE_ENUM.v3;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const res = await this.getServerTime();
|
||||
return Number(res.time_now);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data Endpoints : these seem exactly the same as the unified margin market data endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** Query order book info. Each side has a depth of 25 orders. */
|
||||
getOrderBook(
|
||||
symbol: string,
|
||||
category?: string,
|
||||
limit?: number,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/order-book/L2', {
|
||||
category,
|
||||
symbol,
|
||||
limit,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get candles/klines */
|
||||
getCandles(params: UMCandlesRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/kline', params);
|
||||
}
|
||||
|
||||
/** Get a symbol price/statistics ticker */
|
||||
getSymbolTicker(
|
||||
category: UMCategory | '',
|
||||
symbol?: string,
|
||||
): Promise<APIResponseV3<ContractListResult<ContractSymbolTicker>>> {
|
||||
return this.get('/derivatives/v3/public/tickers', { category, symbol });
|
||||
}
|
||||
|
||||
/** Get trading rules per symbol/contract, incl price/amount/value/leverage filters */
|
||||
getInstrumentInfo(
|
||||
params: UMInstrumentInfoRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/instruments-info', params);
|
||||
}
|
||||
|
||||
/** Query mark price kline (like getCandles() but for mark price). */
|
||||
getMarkPriceCandles(params: UMCandlesRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/mark-price-kline', params);
|
||||
}
|
||||
|
||||
/** Query Index Price Kline */
|
||||
getIndexPriceCandles(params: UMCandlesRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/index-price-kline', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* The funding rate is generated every 8 hours at 00:00 UTC, 08:00 UTC and 16:00 UTC.
|
||||
* For example, if a request is sent at 12:00 UTC, the funding rate generated earlier that day at 08:00 UTC will be sent.
|
||||
*/
|
||||
getFundingRateHistory(
|
||||
params: UMFundingRateHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get(
|
||||
'/derivatives/v3/public/funding/history-funding-rate',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Get Risk Limit */
|
||||
getRiskLimit(
|
||||
category: UMCategory,
|
||||
symbol: string,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/risk-limit/list', {
|
||||
category,
|
||||
symbol,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get option delivery price */
|
||||
getOptionDeliveryPrice(
|
||||
params: UMOptionDeliveryPriceRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/delivery-price', params);
|
||||
}
|
||||
|
||||
/** Get public trading history */
|
||||
getTrades(params: UMPublicTradesRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/recent-trade', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the total amount of unsettled contracts.
|
||||
* In other words, the total number of contracts held in open positions.
|
||||
*/
|
||||
getOpenInterest(params: UMOpenInterestRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/open-interest', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Contract Account Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** -> Order API */
|
||||
|
||||
/** Place an order */
|
||||
submitOrder(params: ContractOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/contract/v3/private/order/create', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query order history.
|
||||
*
|
||||
* As order creation/cancellation is asynchronous, the data returned from the interface may be delayed.
|
||||
* To access order information in real-time, call getActiveOrders().
|
||||
*/
|
||||
getHistoricOrders(
|
||||
params: ContractHistoricOrdersRequest,
|
||||
): Promise<APIResponseV3<PaginatedResult<ContractHistoricOrder>>> {
|
||||
return this.getPrivate('/contract/v3/private/order/list', params);
|
||||
}
|
||||
|
||||
/** Cancel order */
|
||||
cancelOrder(params: ContractCancelOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/contract/v3/private/order/cancel', params);
|
||||
}
|
||||
|
||||
/** Cancel all orders */
|
||||
cancelAllOrders(symbol: string): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/contract/v3/private/order/cancel-all', {
|
||||
symbol,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace order
|
||||
*
|
||||
* Active order parameters (such as quantity, price) and stop order parameters
|
||||
* cannot be modified in one request at the same time.
|
||||
*
|
||||
* Please request modification separately.
|
||||
*/
|
||||
modifyOrder(params: ContractModifyOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/contract/v3/private/order/replace', params);
|
||||
}
|
||||
|
||||
/** Query Open Order(s) (real-time) */
|
||||
getActiveOrders(
|
||||
params: ContractActiveOrdersRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate(
|
||||
'/contract/v3/private/order/unfilled-orders',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** -> Positions API */
|
||||
|
||||
/**
|
||||
* Query my positions real-time. Accessing personal list of positions.
|
||||
* Either symbol or settleCoin is required.
|
||||
* Users can access their position holding information through this interface, such as the number of position holdings and wallet balance.
|
||||
*/
|
||||
getPositions(params?: ContractPositionsRequest): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/contract/v3/private/position/list', params);
|
||||
}
|
||||
|
||||
/** Set auto add margin, or Auto-Margin Replenishment. */
|
||||
setAutoAddMargin(
|
||||
params: ContractSetAutoAddMarginRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/position/set-auto-add-margin',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Switch cross margin mode/isolated margin mode */
|
||||
setMarginSwitch(
|
||||
params: ContractSetMarginSwitchRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/position/switch-isolated',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Supports switching between One-Way Mode and Hedge Mode at the coin level. */
|
||||
setPositionMode(
|
||||
params: ContractSetPositionModeRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/position/switch-mode',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Switch mode between Full or Partial
|
||||
*/
|
||||
setTPSLMode(
|
||||
symbol: string,
|
||||
tpSlMode: 'Full' | 'Partial',
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/contract/v3/private/position/switch-tpsl-mode', {
|
||||
symbol,
|
||||
tpSlMode,
|
||||
});
|
||||
}
|
||||
|
||||
/** Leverage setting. */
|
||||
setLeverage(
|
||||
symbol: string,
|
||||
buyLeverage: string,
|
||||
sellLeverage: string,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/contract/v3/private/position/set-leverage', {
|
||||
symbol,
|
||||
buyLeverage,
|
||||
sellLeverage,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Set take profit, stop loss, and trailing stop for your open position.
|
||||
* If using partial mode, TP/SL/TS orders will not close your entire position.
|
||||
*/
|
||||
setTPSL(params: ContractSetTPSLRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/position/trading-stop',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Set risk limit */
|
||||
setRiskLimit(
|
||||
symbol: string,
|
||||
riskId: number,
|
||||
/** 0-one-way, 1-buy side, 2-sell side */
|
||||
positionIdx: 0 | 1 | 2,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/contract/v3/private/position/set-risk-limit', {
|
||||
symbol,
|
||||
riskId,
|
||||
positionIdx,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user's trading records.
|
||||
* The results are ordered in descending order (the first item is the latest). Returns records up to 2 years old.
|
||||
*/
|
||||
getUserExecutionHistory(
|
||||
params: ContractUserExecutionHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/contract/v3/private/execution/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user's closed profit and loss records.
|
||||
* The results are ordered in descending order (the first item is the latest).
|
||||
*/
|
||||
getClosedProfitAndLoss(
|
||||
params: ContractClosedPNLRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/contract/v3/private/position/closed-pnl', params);
|
||||
}
|
||||
|
||||
/** Get the information of open interest limit. */
|
||||
getOpenInterestLimitInfo(symbol: string): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/contract/v3/private/position/limit-info', {
|
||||
symbol,
|
||||
});
|
||||
}
|
||||
|
||||
/** -> Account API */
|
||||
|
||||
/** Query wallet balance */
|
||||
getBalances(coin?: string): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/contract/v3/private/account/wallet/balance', {
|
||||
coin,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get user trading fee rate */
|
||||
getTradingFeeRate(symbol?: string): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/contract/v3/private/account/fee-rate', {
|
||||
symbol,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get wallet fund records.
|
||||
* This endpoint also shows exchanges from the Asset Exchange,
|
||||
* where the types for the exchange are ExchangeOrderWithdraw and ExchangeOrderDeposit.
|
||||
*
|
||||
* This endpoint returns incomplete information for transfers involving the derivatives wallet.
|
||||
* Use the account asset API for creating and querying internal transfers.
|
||||
*/
|
||||
getWalletFundRecords(
|
||||
params?: ContractWalletFundRecordRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate(
|
||||
'/contract/v3/private/account/wallet/fund-records',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime> {
|
||||
return this.get('/v2/public/time');
|
||||
}
|
||||
}
|
||||
@@ -1,162 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import {
|
||||
APIResponseV3,
|
||||
APIResponseWithTime,
|
||||
CopyTradingCancelOrderRequest,
|
||||
CopyTradingCloseOrderRequest,
|
||||
CopyTradingOrderListRequest,
|
||||
CopyTradingOrderRequest,
|
||||
CopyTradingTradingStopRequest,
|
||||
CopyTradingTransferRequest,
|
||||
} from './types';
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for USDC Perpetual APIs
|
||||
* @deprecated WARNING
|
||||
* These endpoints are being switched off gradually and are expected to be completely turned off by the end of 2024.
|
||||
* They may stop working at any point before then.
|
||||
* Please update your code as soon as possible to use the V5 APIs instead.
|
||||
*/
|
||||
export class CopyTradingClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
// Follows the same authentication mechanism as USDC APIs
|
||||
return REST_CLIENT_TYPE_ENUM.v3;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const res = await this.getServerTime();
|
||||
return Number(res.time_now);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getSymbols(): Promise<APIResponseV3<any>> {
|
||||
return this.get('/contract/v3/public/copytrading/symbol/list');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** -> Order API */
|
||||
|
||||
/** Create order */
|
||||
submitOrder(params: CopyTradingOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/copytrading/order/create',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Set Trading Stop */
|
||||
setTradingStop(
|
||||
params: CopyTradingTradingStopRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/copytrading/order/trading-stop',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Query Order List */
|
||||
getActiveOrders(
|
||||
params?: CopyTradingOrderListRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate(
|
||||
'/contract/v3/private/copytrading/order/list',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Cancel order */
|
||||
cancelOrder(
|
||||
params: CopyTradingCancelOrderRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/copytrading/order/cancel',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Close Order.
|
||||
* This endpoint's rate_limit will decrease by 10 per request;
|
||||
* ie, one request to this endpoint consumes 10 from the limit allowed per minute.
|
||||
*/
|
||||
closeOrder(
|
||||
params: CopyTradingCloseOrderRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/copytrading/order/close',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** -> Positions API */
|
||||
|
||||
/** Position List */
|
||||
getPositions(symbol?: string): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/contract/v3/private/copytrading/position/list', {
|
||||
symbol,
|
||||
});
|
||||
}
|
||||
|
||||
/** Close Position */
|
||||
closePosition(
|
||||
symbol: string,
|
||||
positionIdx: string,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/contract/v3/private/copytrading/position/close', {
|
||||
symbol,
|
||||
positionIdx,
|
||||
});
|
||||
}
|
||||
|
||||
/** Only integers can be set to set the leverage */
|
||||
setLeverage(
|
||||
symbol: string,
|
||||
buyLeverage: string,
|
||||
sellLeverage: string,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/copytrading/position/set-leverage',
|
||||
{ symbol, buyLeverage, sellLeverage },
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Wallet Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** Get Wallet Balance */
|
||||
getBalances(): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/contract/v3/private/copytrading/wallet/balance');
|
||||
}
|
||||
|
||||
/** Transfer */
|
||||
transfer(params: CopyTradingTransferRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/contract/v3/private/copytrading/wallet/transfer',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime> {
|
||||
return this.get('/v2/public/time');
|
||||
}
|
||||
}
|
||||
11
src/index.ts
11
src/index.ts
@@ -1,16 +1,5 @@
|
||||
export * from './account-asset-client';
|
||||
export * from './account-asset-client-v3';
|
||||
export * from './copy-trading-client';
|
||||
export * from './inverse-client';
|
||||
export * from './inverse-futures-client';
|
||||
export * from './linear-client';
|
||||
export * from './rest-client-v5';
|
||||
export * from './spot-client';
|
||||
export * from './spot-client-v3';
|
||||
export * from './usdc-option-client';
|
||||
export * from './usdc-perpetual-client';
|
||||
export * from './unified-margin-client';
|
||||
export * from './contract-client';
|
||||
export * from './websocket-client';
|
||||
export * from './util/logger';
|
||||
export * from './util';
|
||||
|
||||
@@ -1,341 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import {
|
||||
APIResponseWithTime,
|
||||
AssetExchangeRecordsReq,
|
||||
CoinParam,
|
||||
InverseActiveConditionalOrderRequest,
|
||||
InverseActiveOrdersRequest,
|
||||
InverseCancelConditionalOrderRequest,
|
||||
InverseCancelOrderRequest,
|
||||
InverseChangePositionMarginRequest,
|
||||
InverseConditionalOrderRequest,
|
||||
InverseGetClosedPnlRequest,
|
||||
InverseGetOrderRequest,
|
||||
InverseGetTradeRecordsRequest,
|
||||
InverseOrderRequest,
|
||||
InverseReplaceConditionalOrderRequest,
|
||||
InverseReplaceOrderRequest,
|
||||
InverseSetLeverageRequest,
|
||||
InverseSetMarginTypeRequest,
|
||||
InverseSetSlTpPositionModeRequest,
|
||||
InverseSetTradingStopRequest,
|
||||
SymbolInfo,
|
||||
SymbolIntervalFromLimitParam,
|
||||
SymbolLimitParam,
|
||||
SymbolParam,
|
||||
SymbolPeriodLimitParam,
|
||||
WalletFundRecordsReq,
|
||||
WithdrawRecordsReq,
|
||||
} from './types';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for Inverse Perpetual Futures APIs (v2)
|
||||
*
|
||||
* @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
|
||||
* will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
|
||||
* Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
|
||||
*/
|
||||
export class InverseClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
return REST_CLIENT_TYPE_ENUM.inverse;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const res = await this.getServerTime();
|
||||
return Number(res.time_now);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getOrderBook(params: SymbolParam): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/orderBook/L2', params);
|
||||
}
|
||||
|
||||
getKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/kline/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get latest information for symbol
|
||||
*/
|
||||
getTickers(
|
||||
params?: Partial<SymbolParam>,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/tickers', params);
|
||||
}
|
||||
|
||||
getTrades(params: SymbolLimitParam): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/trading-records', params);
|
||||
}
|
||||
|
||||
getSymbols(): Promise<APIResponseWithTime<SymbolInfo[]>> {
|
||||
return this.get('v2/public/symbols');
|
||||
}
|
||||
|
||||
getMarkPriceKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/mark-price-kline', params);
|
||||
}
|
||||
|
||||
getIndexPriceKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/index-price-kline', params);
|
||||
}
|
||||
|
||||
getPremiumIndexKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/premium-index-kline', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data : Advanced
|
||||
*
|
||||
*/
|
||||
|
||||
getOpenInterest(
|
||||
params: SymbolPeriodLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/open-interest', params);
|
||||
}
|
||||
|
||||
getLatestBigDeal(
|
||||
params: SymbolLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/big-deal', params);
|
||||
}
|
||||
|
||||
getLongShortRatio(
|
||||
params: SymbolPeriodLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/account-ratio', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getApiKeyInfo(): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/account/api-key');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Wallet Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getWalletBalance(
|
||||
params?: Partial<CoinParam>,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/wallet/balance', params);
|
||||
}
|
||||
|
||||
getWalletFundRecords(
|
||||
params?: WalletFundRecordsReq,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/wallet/fund/records', params);
|
||||
}
|
||||
|
||||
getWithdrawRecords(
|
||||
params?: WithdrawRecordsReq,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/wallet/withdraw/list', params);
|
||||
}
|
||||
|
||||
getAssetExchangeRecords(
|
||||
params?: AssetExchangeRecordsReq,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/exchange-order/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime<{}>> {
|
||||
return this.get('v2/public/time');
|
||||
}
|
||||
|
||||
getApiAnnouncements(): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/announcement');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* Active orders
|
||||
*/
|
||||
|
||||
placeActiveOrder(
|
||||
orderRequest: InverseOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/order/create', orderRequest);
|
||||
}
|
||||
|
||||
getActiveOrderList(
|
||||
params: InverseActiveOrdersRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/order/list', params);
|
||||
}
|
||||
|
||||
cancelActiveOrder(
|
||||
params: InverseCancelOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/order/cancel', params);
|
||||
}
|
||||
|
||||
cancelAllActiveOrders(
|
||||
params: SymbolParam,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/order/cancelAll', params);
|
||||
}
|
||||
|
||||
replaceActiveOrder(
|
||||
params: InverseReplaceOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/order/replace', params);
|
||||
}
|
||||
|
||||
queryActiveOrder(
|
||||
params: InverseGetOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/order', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Conditional orders
|
||||
*/
|
||||
|
||||
placeConditionalOrder(
|
||||
params: InverseConditionalOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/stop-order/create', params);
|
||||
}
|
||||
|
||||
/** get conditional order list. This may see delays, use queryConditionalOrder() for real-time queries */
|
||||
getConditionalOrder(
|
||||
params: InverseActiveConditionalOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/stop-order/list', params);
|
||||
}
|
||||
|
||||
cancelConditionalOrder(
|
||||
params: InverseCancelConditionalOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/stop-order/cancel', params);
|
||||
}
|
||||
|
||||
cancelAllConditionalOrders(
|
||||
params: SymbolParam,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/stop-order/cancelAll', params);
|
||||
}
|
||||
|
||||
replaceConditionalOrder(
|
||||
params: InverseReplaceConditionalOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/stop-order/replace', params);
|
||||
}
|
||||
|
||||
queryConditionalOrder(
|
||||
params: InverseGetOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/stop-order', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Position
|
||||
*/
|
||||
|
||||
getPosition(
|
||||
params?: Partial<SymbolParam>,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/position/list', params);
|
||||
}
|
||||
|
||||
changePositionMargin(
|
||||
params: InverseChangePositionMarginRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('position/change-position-margin', params);
|
||||
}
|
||||
|
||||
setTradingStop(
|
||||
params: InverseSetTradingStopRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/position/trading-stop', params);
|
||||
}
|
||||
|
||||
setUserLeverage(
|
||||
params: InverseSetLeverageRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/position/leverage/save', params);
|
||||
}
|
||||
|
||||
getTradeRecords(
|
||||
params: InverseGetTradeRecordsRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/execution/list', params);
|
||||
}
|
||||
|
||||
getClosedPnl(
|
||||
params: InverseGetClosedPnlRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/trade/closed-pnl/list', params);
|
||||
}
|
||||
|
||||
setSlTpPositionMode(
|
||||
params: InverseSetSlTpPositionModeRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/tpsl/switch-mode', params);
|
||||
}
|
||||
|
||||
setMarginType(
|
||||
params: InverseSetMarginTypeRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('v2/private/position/switch-isolated', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Funding
|
||||
*/
|
||||
|
||||
getLastFundingRate(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.get('v2/public/funding/prev-funding-rate', params);
|
||||
}
|
||||
|
||||
getMyLastFundingFee(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/funding/prev-funding', params);
|
||||
}
|
||||
|
||||
getPredictedFunding(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/funding/predicted-funding', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* LCP Info
|
||||
*/
|
||||
|
||||
getLcpInfo(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/account/lcp', params);
|
||||
}
|
||||
}
|
||||
@@ -1,407 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util/requestUtils';
|
||||
import {
|
||||
APIResponseWithTime,
|
||||
AssetExchangeRecordsReq,
|
||||
CoinParam,
|
||||
SymbolInfo,
|
||||
SymbolIntervalFromLimitParam,
|
||||
SymbolLimitParam,
|
||||
SymbolParam,
|
||||
SymbolPeriodLimitParam,
|
||||
WalletFundRecordsReq,
|
||||
WithdrawRecordsReq,
|
||||
} from './types/shared';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for Inverse Futures APIs (e.g. quarterly futures) (v2)
|
||||
*
|
||||
* @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
|
||||
* will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
|
||||
* Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
|
||||
*/
|
||||
export class InverseFuturesClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
return REST_CLIENT_TYPE_ENUM.inverseFutures;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const res = await this.getServerTime();
|
||||
return Number(res.time_now);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getOrderBook(params: SymbolParam): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/orderBook/L2', params);
|
||||
}
|
||||
|
||||
getKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/kline/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get latest information for symbol
|
||||
*/
|
||||
getTickers(
|
||||
params?: Partial<SymbolParam>,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/tickers', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Public trading records
|
||||
*/
|
||||
getTrades(params: SymbolLimitParam): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/trading-records', params);
|
||||
}
|
||||
|
||||
getSymbols(): Promise<APIResponseWithTime<SymbolInfo[]>> {
|
||||
return this.get('v2/public/symbols');
|
||||
}
|
||||
|
||||
getMarkPriceKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/mark-price-kline', params);
|
||||
}
|
||||
|
||||
getIndexPriceKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/index-price-kline', params);
|
||||
}
|
||||
|
||||
getPremiumIndexKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/premium-index-kline', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data : Advanced
|
||||
*
|
||||
*/
|
||||
|
||||
getOpenInterest(
|
||||
params: SymbolPeriodLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/open-interest', params);
|
||||
}
|
||||
|
||||
getLatestBigDeal(
|
||||
params: SymbolLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/big-deal', params);
|
||||
}
|
||||
|
||||
getLongShortRatio(
|
||||
params: SymbolPeriodLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/account-ratio', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getApiKeyInfo(): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/account/api-key');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Wallet Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getWalletBalance(
|
||||
params?: Partial<CoinParam>,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/wallet/balance', params);
|
||||
}
|
||||
|
||||
getWalletFundRecords(
|
||||
params?: WalletFundRecordsReq,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/wallet/fund/records', params);
|
||||
}
|
||||
|
||||
getWithdrawRecords(
|
||||
params?: WithdrawRecordsReq,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/wallet/withdraw/list', params);
|
||||
}
|
||||
|
||||
getAssetExchangeRecords(
|
||||
params?: AssetExchangeRecordsReq,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/exchange-order/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime<{}>> {
|
||||
return this.get('v2/public/time');
|
||||
}
|
||||
|
||||
getApiAnnouncements(): Promise<APIResponseWithTime<any>> {
|
||||
return this.get('v2/public/announcement');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* Active orders
|
||||
*/
|
||||
|
||||
placeActiveOrder(orderRequest: {
|
||||
side: string;
|
||||
symbol: string;
|
||||
order_type: string;
|
||||
qty: number;
|
||||
price?: number;
|
||||
time_in_force: string;
|
||||
take_profit?: number;
|
||||
stop_loss?: number;
|
||||
reduce_only?: boolean;
|
||||
close_on_trigger?: boolean;
|
||||
order_link_id?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/order/create', orderRequest);
|
||||
}
|
||||
|
||||
getActiveOrderList(params: {
|
||||
symbol: string;
|
||||
order_status?: string;
|
||||
direction?: string;
|
||||
limit?: number;
|
||||
cursor?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('futures/private/order/list', params);
|
||||
}
|
||||
|
||||
cancelActiveOrder(params: {
|
||||
symbol: string;
|
||||
order_id?: string;
|
||||
order_link_id?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/order/cancel', params);
|
||||
}
|
||||
|
||||
cancelAllActiveOrders(
|
||||
params: SymbolParam,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/order/cancelAll', params);
|
||||
}
|
||||
|
||||
replaceActiveOrder(params: {
|
||||
order_id?: string;
|
||||
order_link_id?: string;
|
||||
symbol: string;
|
||||
p_r_qty?: string;
|
||||
p_r_price?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/order/replace', params);
|
||||
}
|
||||
|
||||
queryActiveOrder(params: {
|
||||
order_id?: string;
|
||||
order_link_id?: string;
|
||||
symbol: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('futures/private/order', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Conditional orders
|
||||
*/
|
||||
|
||||
placeConditionalOrder(params: {
|
||||
side: string;
|
||||
symbol: string;
|
||||
order_type: string;
|
||||
qty: string;
|
||||
price?: string;
|
||||
base_price: string;
|
||||
stop_px: string;
|
||||
time_in_force: string;
|
||||
trigger_by?: string;
|
||||
close_on_trigger?: boolean;
|
||||
order_link_id?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/stop-order/create', params);
|
||||
}
|
||||
|
||||
getConditionalOrder(params: {
|
||||
symbol: string;
|
||||
stop_order_status?: string;
|
||||
direction?: string;
|
||||
limit?: number;
|
||||
cursor?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('futures/private/stop-order/list', params);
|
||||
}
|
||||
|
||||
cancelConditionalOrder(params: {
|
||||
symbol: string;
|
||||
stop_order_id?: string;
|
||||
order_link_id?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/stop-order/cancel', params);
|
||||
}
|
||||
|
||||
cancelAllConditionalOrders(
|
||||
params: SymbolParam,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/stop-order/cancelAll', params);
|
||||
}
|
||||
|
||||
replaceConditionalOrder(params: {
|
||||
stop_order_id?: string;
|
||||
order_link_id?: string;
|
||||
symbol: string;
|
||||
p_r_qty?: number;
|
||||
p_r_price?: string;
|
||||
p_r_trigger_price?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/stop-order/replace', params);
|
||||
}
|
||||
|
||||
queryConditionalOrder(params: {
|
||||
symbol: string;
|
||||
stop_order_id?: string;
|
||||
order_link_id?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('futures/private/stop-order', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Position
|
||||
*/
|
||||
|
||||
/**
|
||||
* Get position list
|
||||
*/
|
||||
getPosition(
|
||||
params?: Partial<SymbolParam>,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('futures/private/position/list', params);
|
||||
}
|
||||
|
||||
changePositionMargin(params: {
|
||||
symbol: string;
|
||||
margin: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate(
|
||||
'futures/private/position/change-position-margin',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
setTradingStop(params: {
|
||||
symbol: string;
|
||||
take_profit?: number;
|
||||
stop_loss?: number;
|
||||
trailing_stop?: number;
|
||||
tp_trigger_by?: string;
|
||||
sl_trigger_by?: string;
|
||||
new_trailing_active?: number;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/position/trading-stop', params);
|
||||
}
|
||||
|
||||
setUserLeverage(params: {
|
||||
symbol: string;
|
||||
buy_leverage: number;
|
||||
sell_leverage: number;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/position/leverage/save', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Position mode switch
|
||||
*/
|
||||
setPositionMode(params: {
|
||||
symbol: string;
|
||||
mode: number;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/position/switch-mode', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Cross/Isolated margin switch. Must set leverage value when switching.
|
||||
*/
|
||||
setMarginType(params: {
|
||||
symbol: string;
|
||||
is_isolated: boolean;
|
||||
buy_leverage: number;
|
||||
sell_leverage: number;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('futures/private/position/switch-isolated', params);
|
||||
}
|
||||
|
||||
getTradeRecords(params: {
|
||||
order_id?: string;
|
||||
symbol: string;
|
||||
start_time?: number;
|
||||
page?: number;
|
||||
limit?: number;
|
||||
order?: string;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('futures/private/execution/list', params);
|
||||
}
|
||||
|
||||
getClosedPnl(params: {
|
||||
symbol: string;
|
||||
start_time?: number;
|
||||
end_time?: number;
|
||||
exec_type?: string;
|
||||
page?: number;
|
||||
limit?: number;
|
||||
}): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('futures/private/trade/closed-pnl/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Funding
|
||||
*/
|
||||
|
||||
getLastFundingRate(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.get('v2/public/funding/prev-funding-rate', params);
|
||||
}
|
||||
|
||||
getMyLastFundingFee(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/funding/prev-funding', params);
|
||||
}
|
||||
|
||||
getPredictedFunding(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/funding/predicted-funding', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* LCP Info
|
||||
*/
|
||||
|
||||
getLcpInfo(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/account/lcp', params);
|
||||
}
|
||||
}
|
||||
@@ -1,391 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util/requestUtils';
|
||||
import {
|
||||
APIResponse,
|
||||
APIResponseWithTime,
|
||||
AssetExchangeRecordsReq,
|
||||
CoinParam,
|
||||
LinearCancelConditionalOrderRequest,
|
||||
LinearCancelOrderRequest,
|
||||
LinearConditionalOrderRequest,
|
||||
LinearGetClosedPnlRequest,
|
||||
LinearGetConditionalOrderRequest,
|
||||
LinearGetHistoryTradeRecordsRequest,
|
||||
LinearGetOrderRequest,
|
||||
LinearGetOrdersRequest,
|
||||
LinearGetTradeRecordsRequest,
|
||||
LinearOrder,
|
||||
LinearQueryConditionalOrderRequest,
|
||||
LinearReplaceConditionalOrderRequest,
|
||||
LinearReplaceOrderRequest,
|
||||
LinearSetAddReduceMarginRequest,
|
||||
LinearSetAutoAddMarginRequest,
|
||||
LinearSetMarginSwitchRequest,
|
||||
LinearSetPositionModeRequest,
|
||||
LinearSetPositionTpSlModeRequest,
|
||||
LinearSetRiskLimitRequest,
|
||||
LinearSetTradingStopRequest,
|
||||
LinearSetUserLeverageRequest,
|
||||
NewLinearOrder,
|
||||
PerpPosition,
|
||||
PerpPositionRoot,
|
||||
SymbolInfo,
|
||||
SymbolIntervalFromLimitParam,
|
||||
SymbolLimitParam,
|
||||
SymbolParam,
|
||||
SymbolPeriodLimitParam,
|
||||
WalletBalances,
|
||||
WalletFundRecordsReq,
|
||||
WithdrawRecordsReq,
|
||||
} from './types';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for linear/USD perpetual futures APIs (v2)
|
||||
*
|
||||
* @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
|
||||
* will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
|
||||
* Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
|
||||
*/
|
||||
export class LinearClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
return REST_CLIENT_TYPE_ENUM.linear;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const timeRes = await this.getServerTime();
|
||||
return Number(timeRes.time_now);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getOrderBook(params: SymbolParam): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/orderBook/L2', params);
|
||||
}
|
||||
|
||||
getKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('public/linear/kline', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get latest information for symbol
|
||||
*/
|
||||
getTickers(
|
||||
params?: Partial<SymbolParam>,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/tickers', params);
|
||||
}
|
||||
|
||||
getTrades(params: SymbolLimitParam): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('public/linear/recent-trading-records', params);
|
||||
}
|
||||
|
||||
getSymbols(): Promise<APIResponse<SymbolInfo[]>> {
|
||||
return this.get('v2/public/symbols');
|
||||
}
|
||||
|
||||
getLastFundingRate(params: SymbolParam): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('public/linear/funding/prev-funding-rate', params);
|
||||
}
|
||||
|
||||
getMarkPriceKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('public/linear/mark-price-kline', params);
|
||||
}
|
||||
|
||||
getIndexPriceKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('public/linear/index-price-kline', params);
|
||||
}
|
||||
|
||||
getPremiumIndexKline(
|
||||
params: SymbolIntervalFromLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('public/linear/premium-index-kline', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data : Advanced
|
||||
*
|
||||
*/
|
||||
|
||||
getOpenInterest(
|
||||
params: SymbolPeriodLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/open-interest', params);
|
||||
}
|
||||
|
||||
getLatestBigDeal(
|
||||
params: SymbolLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/big-deal', params);
|
||||
}
|
||||
|
||||
getLongShortRatio(
|
||||
params: SymbolPeriodLimitParam,
|
||||
): Promise<APIResponseWithTime<any[]>> {
|
||||
return this.get('v2/public/account-ratio', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getApiKeyInfo(): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/account/api-key');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Wallet Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getWalletBalance(
|
||||
params?: Partial<CoinParam>,
|
||||
): Promise<APIResponseWithTime<WalletBalances>> {
|
||||
return this.getPrivate('v2/private/wallet/balance', params);
|
||||
}
|
||||
|
||||
getWalletFundRecords(
|
||||
params?: WalletFundRecordsReq,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/wallet/fund/records', params);
|
||||
}
|
||||
|
||||
getWithdrawRecords(
|
||||
params?: WithdrawRecordsReq,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/wallet/withdraw/list', params);
|
||||
}
|
||||
|
||||
getAssetExchangeRecords(
|
||||
params?: AssetExchangeRecordsReq,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('v2/private/exchange-order/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime<{}>> {
|
||||
return this.get('v2/public/time');
|
||||
}
|
||||
|
||||
getApiAnnouncements(): Promise<APIResponseWithTime<any>> {
|
||||
return this.get('v2/public/announcement');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
placeActiveOrder(
|
||||
params: NewLinearOrder,
|
||||
): Promise<APIResponseWithTime<LinearOrder | null>> {
|
||||
return this.postPrivate('private/linear/order/create', params);
|
||||
}
|
||||
|
||||
getActiveOrderList(
|
||||
params: LinearGetOrdersRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('private/linear/order/list', params);
|
||||
}
|
||||
|
||||
cancelActiveOrder(
|
||||
params: LinearCancelOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/order/cancel', params);
|
||||
}
|
||||
|
||||
cancelAllActiveOrders(
|
||||
params: SymbolParam,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/order/cancel-all', params);
|
||||
}
|
||||
|
||||
replaceActiveOrder(
|
||||
params: LinearReplaceOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/order/replace', params);
|
||||
}
|
||||
|
||||
queryActiveOrder(
|
||||
params: LinearGetOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('private/linear/order/search', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Conditional orders
|
||||
*/
|
||||
|
||||
placeConditionalOrder(
|
||||
params: LinearConditionalOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/stop-order/create', params);
|
||||
}
|
||||
|
||||
getConditionalOrder(
|
||||
params: LinearGetConditionalOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('private/linear/stop-order/list', params);
|
||||
}
|
||||
|
||||
cancelConditionalOrder(
|
||||
params: LinearCancelConditionalOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/stop-order/cancel', params);
|
||||
}
|
||||
|
||||
cancelAllConditionalOrders(
|
||||
params: SymbolParam,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/stop-order/cancel-all', params);
|
||||
}
|
||||
|
||||
replaceConditionalOrder(
|
||||
params: LinearReplaceConditionalOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/stop-order/replace', params);
|
||||
}
|
||||
|
||||
queryConditionalOrder(
|
||||
params: LinearQueryConditionalOrderRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('private/linear/stop-order/search', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Position
|
||||
*/
|
||||
|
||||
getPosition(): Promise<APIResponseWithTime<PerpPositionRoot[]>>;
|
||||
|
||||
getPosition(
|
||||
params: Partial<SymbolParam>,
|
||||
): Promise<APIResponseWithTime<PerpPosition[]>>;
|
||||
|
||||
getPosition(
|
||||
params?: Partial<SymbolParam>,
|
||||
): Promise<APIResponseWithTime<PerpPosition[] | PerpPositionRoot[]>> {
|
||||
return this.getPrivate('private/linear/position/list', params);
|
||||
}
|
||||
|
||||
setAutoAddMargin(
|
||||
params?: LinearSetAutoAddMarginRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate(
|
||||
'private/linear/position/set-auto-add-margin',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
setMarginSwitch(
|
||||
params?: LinearSetMarginSwitchRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/position/switch-isolated', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Switch between one-way vs hedge mode. Use `linearPositionModeEnum` for the mode parameter.
|
||||
*/
|
||||
setPositionMode(
|
||||
params: LinearSetPositionModeRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/position/switch-mode', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Switch TP/SL mode between full or partial. When set to Partial, TP/SL orders may have a quantity less than the position size.
|
||||
* This is set with the setTradingStop() method. Use `positionTpSlModeEnum` for the tp_sl_mode parameter.
|
||||
*/
|
||||
setPositionTpSlMode(
|
||||
params: LinearSetPositionTpSlModeRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/tpsl/switch-mode', params);
|
||||
}
|
||||
|
||||
setAddReduceMargin(
|
||||
params?: LinearSetAddReduceMarginRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/position/add-margin', params);
|
||||
}
|
||||
|
||||
setUserLeverage(
|
||||
params: LinearSetUserLeverageRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/position/set-leverage', params);
|
||||
}
|
||||
|
||||
setTradingStop(
|
||||
params: LinearSetTradingStopRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/position/trading-stop', params);
|
||||
}
|
||||
|
||||
getTradeRecords(
|
||||
params: LinearGetTradeRecordsRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('private/linear/trade/execution/list', params);
|
||||
}
|
||||
|
||||
getHistoryTradeRecords(
|
||||
params: LinearGetHistoryTradeRecordsRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate(
|
||||
'/private/linear/trade/execution/history-list',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getClosedPnl(
|
||||
params: LinearGetClosedPnlRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('private/linear/trade/closed-pnl/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Risk Limit
|
||||
*/
|
||||
|
||||
getRiskLimitList(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('public/linear/risk-limit', params);
|
||||
}
|
||||
|
||||
setRiskLimit(
|
||||
params: LinearSetRiskLimitRequest,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.postPrivate('private/linear/position/set-risk', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Funding
|
||||
*/
|
||||
|
||||
getPredictedFundingFee(
|
||||
params: SymbolParam,
|
||||
): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('private/linear/funding/predicted-funding', params);
|
||||
}
|
||||
|
||||
getLastFundingFee(params: SymbolParam): Promise<APIResponseWithTime<any>> {
|
||||
return this.getPrivate('private/linear/funding/prev-funding', params);
|
||||
}
|
||||
}
|
||||
@@ -170,7 +170,6 @@ import {
|
||||
SpotBorrowCheckResultV5,
|
||||
SpotLeveragedTokenOrderHistoryV5,
|
||||
SpotMarginStateV5,
|
||||
SubAccountAllApiKeysResultV5,
|
||||
SubMemberV5,
|
||||
SwitchIsolatedMarginParamsV5,
|
||||
SwitchPositionModeParamsV5,
|
||||
@@ -191,8 +190,19 @@ import {
|
||||
VipCollateralCoinsV5,
|
||||
WalletBalanceV5,
|
||||
WithdrawParamsV5,
|
||||
WithdrawableAmountV5,
|
||||
WithdrawalRecordV5,
|
||||
} from './types';
|
||||
import {
|
||||
GetEarnOrderHistoryParams,
|
||||
GetEarnPositionParams,
|
||||
SubmitStakeRedeemParams,
|
||||
} from './types/request/v5-earn';
|
||||
import {
|
||||
EarnOrderHistory,
|
||||
EarnPosition,
|
||||
EarnProduct,
|
||||
} from './types/response/v5-earn';
|
||||
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
@@ -272,7 +282,7 @@ export class RestClientV5 extends BaseRestClient {
|
||||
*/
|
||||
|
||||
getClientType() {
|
||||
return REST_CLIENT_TYPE_ENUM.v3;
|
||||
return REST_CLIENT_TYPE_ENUM.v5;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
@@ -551,7 +561,9 @@ export class RestClientV5 extends BaseRestClient {
|
||||
|
||||
cancelAllOrders(
|
||||
params: CancelAllOrdersParamsV5,
|
||||
): Promise<APIResponseV3WithTime<{ list: OrderResultV5[] }>> {
|
||||
): Promise<
|
||||
APIResponseV3WithTime<{ list: OrderResultV5[]; success: string }>
|
||||
> {
|
||||
return this.postPrivate('/v5/order/cancel-all', params);
|
||||
}
|
||||
|
||||
@@ -566,6 +578,18 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.getPrivate('/v5/order/history', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query users' execution records, sorted by execTime in descending order
|
||||
*
|
||||
* Unified account covers: Spot / Linear contract / Options
|
||||
* Normal account covers: USDT perpetual / Inverse perpetual / Inverse futures
|
||||
*/
|
||||
getExecutionList(
|
||||
params: GetExecutionListParamsV5,
|
||||
): Promise<APIResponseV3WithTime<CategoryCursorListV5<ExecutionV5[]>>> {
|
||||
return this.getPrivate('/v5/execution/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* This endpoint allows you to place more than one order in a single request.
|
||||
* Covers: Option (UTA, UTA Pro) / USDT Perpetual, UDSC Perpetual, USDC Futures (UTA Pro)
|
||||
@@ -675,7 +699,7 @@ export class RestClientV5 extends BaseRestClient {
|
||||
* Only for institutional clients!
|
||||
*/
|
||||
setDisconnectCancelAllWindowV2(params: {
|
||||
product: 'OPTION' | 'SPOT' | 'DERIVATIVES';
|
||||
product?: 'OPTION' | 'SPOT' | 'DERIVATIVES';
|
||||
timeWindow: number;
|
||||
}): Promise<APIResponseV3<undefined>> {
|
||||
return this.postPrivate('/v5/order/disconnected-cancel-all', params);
|
||||
@@ -733,6 +757,7 @@ export class RestClientV5 extends BaseRestClient {
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
* This endpoint sets the take profit/stop loss (TP/SL) mode to full or partial.
|
||||
*
|
||||
* Unified account covers: Linear contract; normal account covers: USDT perpetual, inverse perpetual, inverse futures.
|
||||
@@ -761,6 +786,7 @@ export class RestClientV5 extends BaseRestClient {
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
* The risk limit will limit the maximum position value you can hold under different margin requirements.
|
||||
* If you want to hold a bigger position size, you need more margin.
|
||||
*
|
||||
@@ -811,18 +837,6 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.postPrivate('/v5/position/add-margin', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query users' execution records, sorted by execTime in descending order
|
||||
*
|
||||
* Unified account covers: Spot / Linear contract / Options
|
||||
* Normal account covers: USDT perpetual / Inverse perpetual / Inverse futures
|
||||
*/
|
||||
getExecutionList(
|
||||
params: GetExecutionListParamsV5,
|
||||
): Promise<APIResponseV3WithTime<CategoryCursorListV5<ExecutionV5[]>>> {
|
||||
return this.getPrivate('/v5/execution/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query user's closed profit and loss records. The results are sorted by createdTime in descending order.
|
||||
*
|
||||
@@ -1099,6 +1113,19 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.getPrivate('/v5/account/info');
|
||||
}
|
||||
|
||||
/**
|
||||
* Query the DCP configuration of the account's contracts (USDT perpetual, USDC perpetual and USDC Futures) / spot / options.
|
||||
*
|
||||
* Only the configured main / sub account can query information from this API. Calling this API by an account always returns empty.
|
||||
*
|
||||
* INFO
|
||||
* support linear contract (USDT, USDC Perp & USDC Futures) / Spot / Options only
|
||||
* Unified account only
|
||||
*/
|
||||
getDCPInfo(): Promise<APIResponseV3WithTime<{ dcpInfos: DCPInfoV5[] }>> {
|
||||
return this.getPrivate('/v5/account/query-dcp-info');
|
||||
}
|
||||
|
||||
/**
|
||||
* Query transaction logs in Unified account.
|
||||
*/
|
||||
@@ -1183,39 +1210,12 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.getPrivate('/v5/account/mmp-state', { baseCoin });
|
||||
}
|
||||
|
||||
/**
|
||||
* Query the DCP configuration of the account's contracts (USDT perpetual, USDC perpetual and USDC Futures) / spot / options.
|
||||
*
|
||||
* Only the configured main / sub account can query information from this API. Calling this API by an account always returns empty.
|
||||
*
|
||||
* INFO
|
||||
* support linear contract (USDT, USDC Perp & USDC Futures) / Spot / Options only
|
||||
* Unified account only
|
||||
*/
|
||||
getDCPInfo(): Promise<APIResponseV3WithTime<{ dcpInfos: DCPInfoV5[] }>> {
|
||||
return this.getPrivate('/v5/account/query-dcp-info');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
****** Asset APIs
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* Query the coin exchange records.
|
||||
*
|
||||
* CAUTION: You may experience long delays with this endpoint.
|
||||
*/
|
||||
getCoinExchangeRecords(params?: GetCoinExchangeRecordParamsV5): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
orderBody: CoinExchangeRecordV5[];
|
||||
nextPageCursor?: string;
|
||||
}>
|
||||
> {
|
||||
return this.getPrivate('/v5/asset/exchange/order-record', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query option delivery records, sorted by deliveryTime in descending order.
|
||||
*
|
||||
@@ -1240,6 +1240,46 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.getPrivate('/v5/asset/settlement-record', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query the coin exchange records.
|
||||
*
|
||||
* CAUTION: You may experience long delays with this endpoint.
|
||||
*/
|
||||
getCoinExchangeRecords(params?: GetCoinExchangeRecordParamsV5): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
orderBody: CoinExchangeRecordV5[];
|
||||
nextPageCursor?: string;
|
||||
}>
|
||||
> {
|
||||
return this.getPrivate('/v5/asset/exchange/order-record', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query coin information, including chain information, withdraw and deposit status.
|
||||
*/
|
||||
getCoinInfo(
|
||||
coin?: string,
|
||||
): Promise<APIResponseV3WithTime<{ rows: CoinInfoV5[] }>> {
|
||||
return this.getPrivate(
|
||||
'/v5/asset/coin/query-info',
|
||||
coin ? { coin } : undefined,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query the sub UIDs under a main UID
|
||||
*
|
||||
* CAUTION: Can query by the master UID's api key only
|
||||
*/
|
||||
getSubUID(): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
subMemberIds: string[];
|
||||
transferableSubMemberIds: string[];
|
||||
}>
|
||||
> {
|
||||
return this.getPrivate('/v5/asset/transfer/query-sub-member-list');
|
||||
}
|
||||
|
||||
/**
|
||||
* Query asset information.
|
||||
*
|
||||
@@ -1280,6 +1320,15 @@ export class RestClientV5 extends BaseRestClient {
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query withdrawable amount.
|
||||
*/
|
||||
getWithdrawableAmount(params: {
|
||||
coin: string;
|
||||
}): Promise<APIResponseV3<{ rows: WithdrawableAmountV5[] }>> {
|
||||
return this.getPrivate('/v5/asset/withdraw/withdrawable-amount', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query the transferable coin list between each account type.
|
||||
*/
|
||||
@@ -1327,20 +1376,6 @@ export class RestClientV5 extends BaseRestClient {
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query the sub UIDs under a main UID
|
||||
*
|
||||
* CAUTION: Can query by the master UID's api key only
|
||||
*/
|
||||
getSubUID(): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
subMemberIds: string[];
|
||||
transferableSubMemberIds: string[];
|
||||
}>
|
||||
> {
|
||||
return this.getPrivate('/v5/asset/transfer/query-sub-member-list');
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable Universal Transfer for Sub UID
|
||||
*
|
||||
@@ -1396,7 +1431,7 @@ export class RestClientV5 extends BaseRestClient {
|
||||
nextPageCursor: string;
|
||||
}>
|
||||
> {
|
||||
return this.get('/v5/asset/deposit/query-allowed-list', params);
|
||||
return this.getPrivate('/v5/asset/deposit/query-allowed-list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1497,6 +1532,7 @@ export class RestClientV5 extends BaseRestClient {
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated - duplicate function, use getSubDepositAddress() instead
|
||||
* Query the deposit address information of SUB account.
|
||||
* @deprecated Duplicate endpoint - Use getSubDepositAddress() instead
|
||||
*
|
||||
@@ -1520,18 +1556,6 @@ export class RestClientV5 extends BaseRestClient {
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Query coin information, including chain information, withdraw and deposit status.
|
||||
*/
|
||||
getCoinInfo(
|
||||
coin?: string,
|
||||
): Promise<APIResponseV3WithTime<{ rows: CoinInfoV5[] }>> {
|
||||
return this.getPrivate(
|
||||
'/v5/asset/coin/query-info',
|
||||
coin ? { coin } : undefined,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query withdrawal records.
|
||||
*/
|
||||
@@ -1541,15 +1565,6 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.getPrivate('/v5/asset/withdraw/query-record', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query withdrawable amount.
|
||||
*/
|
||||
getWithdrawableAmount(params: {
|
||||
coin: string;
|
||||
}): Promise<APIResponseV3<{ rows: WithdrawalRecordV5[] }>> {
|
||||
return this.getPrivate('/v5/asset/withdraw/withdrawable-amount', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Exchange Entity List.
|
||||
*
|
||||
@@ -1621,7 +1636,7 @@ export class RestClientV5 extends BaseRestClient {
|
||||
* Query the exchange result by sending quoteTxId.
|
||||
*/
|
||||
getConvertStatus(params: {
|
||||
quoteTxId?: string;
|
||||
quoteTxId: string;
|
||||
accountType:
|
||||
| 'eb_convert_funding'
|
||||
| 'eb_convert_uta'
|
||||
@@ -1701,15 +1716,6 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.getPrivate('/v5/user/submembers', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query all api keys information of a sub UID.
|
||||
*/
|
||||
getSubAccountAllApiKeys(
|
||||
params: GetSubAccountAllApiKeysParamsV5,
|
||||
): Promise<APIResponseV3WithTime<SubAccountAllApiKeysResultV5>> {
|
||||
return this.getPrivate('/v5/user/sub-apikeys', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Froze sub uid. Use master user's api key only.
|
||||
*
|
||||
@@ -1733,6 +1739,18 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.getPrivate('/v5/user/query-api');
|
||||
}
|
||||
|
||||
/**
|
||||
* Query all api keys information of a sub UID.
|
||||
*/
|
||||
getSubAccountAllApiKeys(params: GetSubAccountAllApiKeysParamsV5): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
result: ApiKeyInfoV5[];
|
||||
nextPageCursor: string;
|
||||
}>
|
||||
> {
|
||||
return this.getPrivate('/v5/user/sub-apikeys', params);
|
||||
}
|
||||
|
||||
getUIDWalletType(params: { memberIds: string }): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
accounts: {
|
||||
@@ -1741,7 +1759,7 @@ export class RestClientV5 extends BaseRestClient {
|
||||
}[];
|
||||
}>
|
||||
> {
|
||||
return this.getPrivate('/v5/user/query-api', params);
|
||||
return this.getPrivate('/v5/user/get-member-type', params);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1770,6 +1788,19 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.postPrivate('/v5/user/update-sub-api', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a sub UID. Before deleting the UID, please make sure there are no assets.
|
||||
*
|
||||
* TIP:
|
||||
* The API key must have one of the permissions to be allowed to call the following API endpoint.
|
||||
* - master API key: "Account Transfer", "Subaccount Transfer", "Withdrawal"
|
||||
*/
|
||||
deleteSubMember(
|
||||
params: DeleteSubMemberParamsV5,
|
||||
): Promise<APIResponseV3WithTime<{}>> {
|
||||
return this.postPrivate('/v5/user/del-submember', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the api key of master account. Use the api key pending to be delete to call the endpoint. Use master user's api key only.
|
||||
*
|
||||
@@ -1799,19 +1830,6 @@ export class RestClientV5 extends BaseRestClient {
|
||||
return this.postPrivate('/v5/user/delete-sub-api', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a sub UID. Before deleting the UID, please make sure there are no assets.
|
||||
*
|
||||
* TIP:
|
||||
* The API key must have one of the permissions to be allowed to call the following API endpoint.
|
||||
* - master API key: "Account Transfer", "Subaccount Transfer", "Withdrawal"
|
||||
*/
|
||||
deleteSubMember(
|
||||
params: DeleteSubMemberParamsV5,
|
||||
): Promise<APIResponseV3WithTime<{}>> {
|
||||
return this.postPrivate('/v5/user/del-submember', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
****** Affiliate APIs
|
||||
@@ -2538,4 +2556,73 @@ export class RestClientV5 extends BaseRestClient {
|
||||
): Promise<APIResponseV3<BrokerIssuedVoucherV5>> {
|
||||
return this.postPrivate('/v5/broker/award/distribution-record', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
****** EARN
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* Get Product Info for Earn products
|
||||
*
|
||||
* INFO: Do not need authentication
|
||||
*/
|
||||
getEarnProduct(params: { category: string; coin?: string }): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
list: EarnProduct[];
|
||||
}>
|
||||
> {
|
||||
return this.get('/v5/earn/product', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Stake or Redeem Earn products
|
||||
*
|
||||
* INFO: API key needs "Earn" permission
|
||||
*
|
||||
* NOTE: In times of high demand for loans in the market for a specific cryptocurrency,
|
||||
* the redemption of the principal may encounter delays and is expected to be processed
|
||||
* within 48 hours. Once the redemption request is initiated, it cannot be canceled,
|
||||
* and your principal will continue to earn interest until the process is completed.
|
||||
*/
|
||||
submitStakeRedeem(params: SubmitStakeRedeemParams): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
orderId: string;
|
||||
orderLinkId: string;
|
||||
}>
|
||||
> {
|
||||
return this.postPrivate('/v5/earn/place-order', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Stake/Redeem Order History
|
||||
*
|
||||
* INFO: API key needs "Earn" permission
|
||||
*
|
||||
* Note: Either orderId or orderLinkId is required. If both are passed,
|
||||
* make sure they're matched, otherwise returning empty result
|
||||
*/
|
||||
getEarnOrderHistory(params: GetEarnOrderHistoryParams): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
list: EarnOrderHistory[];
|
||||
}>
|
||||
> {
|
||||
return this.getPrivate('/v5/earn/order', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Staked Position
|
||||
*
|
||||
* INFO: API key needs "Earn" permission
|
||||
*
|
||||
* Note: Fully redeemed position is also returned in the response
|
||||
*/
|
||||
getEarnPosition(params: GetEarnPositionParams): Promise<
|
||||
APIResponseV3WithTime<{
|
||||
list: EarnPosition[];
|
||||
}>
|
||||
> {
|
||||
return this.getPrivate('/v5/earn/position', params);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,17 +1,5 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import {
|
||||
APIResponseV3,
|
||||
APIResponseWithTime,
|
||||
KlineInterval,
|
||||
NewSpotOrderV3,
|
||||
SpotBalances,
|
||||
SpotCancelOrderBatchRequest,
|
||||
SpotCrossMarginBorrowingInfoRequest,
|
||||
SpotCrossMarginRepaymentHistoryRequest,
|
||||
SpotLeveragedTokenPRHistoryRequest,
|
||||
SpotMyTradesRequest,
|
||||
SpotOrderQueryById,
|
||||
} from './types';
|
||||
import { APIResponseV3, numberInString } from './types';
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
@@ -24,8 +12,8 @@ import BaseRestClient from './util/BaseRestClient';
|
||||
*/
|
||||
export class SpotClientV3 extends BaseRestClient {
|
||||
getClientType() {
|
||||
// Follows the same authentication mechanism as other v3 APIs (e.g. USDC)
|
||||
return REST_CLIENT_TYPE_ENUM.v3;
|
||||
// Doesn't really matter here, since the only remaining endpoint does not require auth.
|
||||
return REST_CLIENT_TYPE_ENUM.v5;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
@@ -39,17 +27,11 @@ export class SpotClientV3 extends BaseRestClient {
|
||||
*
|
||||
*/
|
||||
|
||||
/** Get all symbols */
|
||||
getSymbols(): Promise<APIResponseV3<any>> {
|
||||
return this.get('/spot/v3/public/symbols');
|
||||
}
|
||||
|
||||
/** Get orderbook for symbol */
|
||||
getOrderBook(symbol: string, limit?: number): Promise<APIResponseV3<any>> {
|
||||
return this.get('/spot/v3/public/quote/depth', { symbol, limit });
|
||||
}
|
||||
|
||||
/** Get merged orderbook for symbol */
|
||||
/**
|
||||
* Get merged orderbook for symbol
|
||||
*
|
||||
* This is the only known pre-V5 endpoint to still be online.
|
||||
*/
|
||||
getMergedOrderBook(
|
||||
symbol: string,
|
||||
scale?: number,
|
||||
@@ -62,246 +44,13 @@ export class SpotClientV3 extends BaseRestClient {
|
||||
});
|
||||
}
|
||||
|
||||
/** Get public trading records (raw trades) */
|
||||
getTrades(symbol: string, limit?: number): Promise<APIResponseV3<any>> {
|
||||
return this.get('/spot/v3/public/quote/trades', { symbol, limit });
|
||||
}
|
||||
|
||||
/** Get candles/klines */
|
||||
getCandles(
|
||||
symbol: string,
|
||||
interval: KlineInterval,
|
||||
limit?: number,
|
||||
startTime?: number,
|
||||
endTime?: number,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/spot/v3/public/quote/kline', {
|
||||
symbol,
|
||||
interval,
|
||||
limit,
|
||||
startTime,
|
||||
endTime,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get latest information for symbol (24hr ticker) */
|
||||
get24hrTicker(symbol?: string): Promise<APIResponseV3<any>> {
|
||||
return this.get('/spot/v3/public/quote/ticker/24hr', { symbol });
|
||||
}
|
||||
|
||||
/** Get last traded price */
|
||||
getLastTradedPrice(symbol?: string): Promise<APIResponseV3<any>> {
|
||||
return this.get('/spot/v3/public/quote/ticker/price', { symbol });
|
||||
}
|
||||
|
||||
/** Get best bid/ask price */
|
||||
getBestBidAskPrice(symbol?: string): Promise<APIResponseV3<any>> {
|
||||
return this.get('/spot/v3/public/quote/ticker/bookTicker', { symbol });
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** -> Order API */
|
||||
|
||||
/** Create order */
|
||||
submitOrder(params: NewSpotOrderV3): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/spot/v3/private/order', params);
|
||||
}
|
||||
|
||||
/** Get active order state */
|
||||
getOrder(params: SpotOrderQueryById): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/spot/v3/private/order', params);
|
||||
}
|
||||
|
||||
/** Cancel order */
|
||||
cancelOrder(params: SpotOrderQueryById): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/spot/v3/private/cancel-order', params);
|
||||
}
|
||||
|
||||
/** Batch cancel orders */
|
||||
cancelOrderBatch(
|
||||
params: SpotCancelOrderBatchRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
const orderTypes = params.orderTypes
|
||||
? params.orderTypes.join(',')
|
||||
: undefined;
|
||||
|
||||
return this.postPrivate('/spot/v3/private/cancel-orders', {
|
||||
...params,
|
||||
orderTypes,
|
||||
});
|
||||
}
|
||||
|
||||
/** Batch cancel up to 100 orders by ID */
|
||||
cancelOrderBatchIDs(orderIds: string[]): Promise<APIResponseV3<any>> {
|
||||
const orderIdsCsv = orderIds.join(',');
|
||||
return this.postPrivate('/spot/v3/private/cancel-orders-by-ids', {
|
||||
orderIds: orderIdsCsv,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get open orders */
|
||||
getOpenOrders(
|
||||
symbol?: string,
|
||||
orderId?: string,
|
||||
limit?: number,
|
||||
orderCategory?: 0 | 1,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/spot/v3/private/open-orders', {
|
||||
symbol,
|
||||
orderId,
|
||||
limit,
|
||||
orderCategory,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get order history */
|
||||
getPastOrders(
|
||||
symbol?: string,
|
||||
orderId?: string,
|
||||
limit?: number,
|
||||
orderCategory?: 0 | 1,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/spot/v3/private/history-orders', {
|
||||
symbol,
|
||||
orderId,
|
||||
limit,
|
||||
orderCategory,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get your trade history.
|
||||
* If startTime is not specified, you can only query for records in the last 7 days.
|
||||
* If you want to query for records older than 7 days, startTime is required.
|
||||
*/
|
||||
getMyTrades(params?: SpotMyTradesRequest): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/spot/v3/private/my-trades', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Wallet Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** Get Wallet Balance */
|
||||
getBalances(): Promise<APIResponseV3<SpotBalances>> {
|
||||
return this.getPrivate('/spot/v3/private/account');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime> {
|
||||
getServerTime(): Promise<{ time_now: numberInString }> {
|
||||
return this.get('/v2/public/time');
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Leveraged Token Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** Get all asset infos */
|
||||
getLeveragedTokenAssetInfos(ltCode?: string): Promise<APIResponseV3<any>> {
|
||||
return this.get('/spot/v3/public/infos', { ltCode });
|
||||
}
|
||||
|
||||
/** Get leveraged token market info */
|
||||
getLeveragedTokenMarketInfo(ltCode: string): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/spot/v3/private/reference', { ltCode });
|
||||
}
|
||||
|
||||
/** Purchase leveraged token */
|
||||
purchaseLeveragedToken(
|
||||
ltCode: string,
|
||||
ltAmount: string,
|
||||
serialNo?: string,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/spot/v3/private/purchase', {
|
||||
ltCode,
|
||||
ltAmount,
|
||||
serialNo,
|
||||
});
|
||||
}
|
||||
|
||||
/** Redeem leveraged token */
|
||||
redeemLeveragedToken(
|
||||
ltCode: string,
|
||||
ltAmount: string,
|
||||
serialNo?: string,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/spot/v3/private/redeem', {
|
||||
ltCode,
|
||||
ltAmount,
|
||||
serialNo,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get leveraged token purchase/redemption history */
|
||||
getLeveragedTokenPRHistory(
|
||||
params?: SpotLeveragedTokenPRHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/spot/v3/private/record', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Cross Margin Trading Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** Borrow margin loan */
|
||||
borrowCrossMarginLoan(
|
||||
coin: string,
|
||||
qty: string,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/spot/v3/private/cross-margin-loan', {
|
||||
coin,
|
||||
qty,
|
||||
});
|
||||
}
|
||||
|
||||
/** Repay margin loan */
|
||||
repayCrossMarginLoan(coin: string, qty: string): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/spot/v3/private/cross-margin-repay', {
|
||||
coin,
|
||||
qty,
|
||||
});
|
||||
}
|
||||
|
||||
/** Query borrowing info */
|
||||
getCrossMarginBorrowingInfo(
|
||||
params?: SpotCrossMarginBorrowingInfoRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/spot/v3/private/cross-margin-orders', params);
|
||||
}
|
||||
|
||||
/** Query account info */
|
||||
getCrossMarginAccountInfo(): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/spot/v3/private/cross-margin-account');
|
||||
}
|
||||
|
||||
/** Query interest & quota */
|
||||
getCrossMarginInterestQuota(coin: string): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/spot/v3/private/cross-margin-loan-info', { coin });
|
||||
}
|
||||
|
||||
/** Query repayment history */
|
||||
getCrossMarginRepaymentHistory(
|
||||
params?: SpotCrossMarginRepaymentHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate(
|
||||
'/spot/v3/private/cross-margin-repay-history',
|
||||
params,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,183 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import {
|
||||
APIResponse,
|
||||
KlineInterval,
|
||||
NewSpotOrder,
|
||||
OrderSide,
|
||||
OrderTypeSpot,
|
||||
SpotBalances,
|
||||
SpotLastPrice,
|
||||
SpotOrderQueryById,
|
||||
SpotSymbolInfo,
|
||||
} from './types';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util/requestUtils';
|
||||
|
||||
/**
|
||||
* REST API client for Spot APIs (v1)
|
||||
*
|
||||
* @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
|
||||
* will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
|
||||
* Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
|
||||
*/
|
||||
export class SpotClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
return REST_CLIENT_TYPE_ENUM.spot;
|
||||
}
|
||||
|
||||
fetchServerTime(): Promise<number> {
|
||||
return this.getServerTime();
|
||||
}
|
||||
|
||||
async getServerTime(): Promise<number> {
|
||||
const res = await this.get('/spot/v1/time');
|
||||
return res.result.serverTime;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data Endpoints
|
||||
*
|
||||
**/
|
||||
|
||||
getSymbols(): Promise<APIResponse<SpotSymbolInfo[]>> {
|
||||
return this.get('/spot/v1/symbols');
|
||||
}
|
||||
|
||||
getOrderBook(symbol: string, limit?: number): Promise<APIResponse<any>> {
|
||||
return this.get('/spot/quote/v1/depth', {
|
||||
symbol,
|
||||
limit,
|
||||
});
|
||||
}
|
||||
|
||||
getMergedOrderBook(
|
||||
symbol: string,
|
||||
scale?: number,
|
||||
limit?: number,
|
||||
): Promise<APIResponse<any>> {
|
||||
return this.get('/spot/quote/v1/depth/merged', {
|
||||
symbol,
|
||||
scale,
|
||||
limit,
|
||||
});
|
||||
}
|
||||
|
||||
getTrades(symbol: string, limit?: number): Promise<APIResponse<any[]>> {
|
||||
return this.get('/spot/quote/v1/trades', {
|
||||
symbol,
|
||||
limit,
|
||||
});
|
||||
}
|
||||
|
||||
getCandles(
|
||||
symbol: string,
|
||||
interval: KlineInterval,
|
||||
limit?: number,
|
||||
startTime?: number,
|
||||
endTime?: number,
|
||||
): Promise<APIResponse<any[]>> {
|
||||
return this.get('/spot/quote/v1/kline', {
|
||||
symbol,
|
||||
interval,
|
||||
limit,
|
||||
startTime,
|
||||
endTime,
|
||||
});
|
||||
}
|
||||
|
||||
get24hrTicker(symbol?: string): Promise<APIResponse<any>> {
|
||||
return this.get('/spot/quote/v1/ticker/24hr', { symbol });
|
||||
}
|
||||
|
||||
getLastTradedPrice(): Promise<APIResponse<SpotLastPrice[]>>;
|
||||
|
||||
getLastTradedPrice(symbol: string): Promise<APIResponse<SpotLastPrice>>;
|
||||
|
||||
getLastTradedPrice(
|
||||
symbol?: string,
|
||||
): Promise<APIResponse<SpotLastPrice | SpotLastPrice[]>> {
|
||||
return this.get('/spot/quote/v1/ticker/price', { symbol });
|
||||
}
|
||||
|
||||
getBestBidAskPrice(symbol?: string): Promise<APIResponse<any>> {
|
||||
return this.get('/spot/quote/v1/ticker/book_ticker', { symbol });
|
||||
}
|
||||
|
||||
/**
|
||||
* Account Data Endpoints
|
||||
*/
|
||||
|
||||
submitOrder(params: NewSpotOrder): Promise<APIResponse<any>> {
|
||||
return this.postPrivate('/spot/v1/order', params);
|
||||
}
|
||||
|
||||
getOrder(params: SpotOrderQueryById): Promise<APIResponse<any>> {
|
||||
return this.getPrivate('/spot/v1/order', params);
|
||||
}
|
||||
|
||||
cancelOrder(params: SpotOrderQueryById): Promise<APIResponse<any>> {
|
||||
return this.deletePrivate('/spot/v1/order', params);
|
||||
}
|
||||
|
||||
cancelOrderBatch(params: {
|
||||
symbol: string;
|
||||
side?: OrderSide;
|
||||
orderTypes: OrderTypeSpot[];
|
||||
}): Promise<APIResponse<any>> {
|
||||
const orderTypes = params.orderTypes
|
||||
? params.orderTypes.join(',')
|
||||
: undefined;
|
||||
|
||||
return this.deletePrivate('/spot/order/batch-cancel', {
|
||||
...params,
|
||||
orderTypes,
|
||||
});
|
||||
}
|
||||
|
||||
getOpenOrders(
|
||||
symbol?: string,
|
||||
orderId?: string,
|
||||
limit?: number,
|
||||
): Promise<APIResponse<any>> {
|
||||
return this.getPrivate('/spot/v1/open-orders', {
|
||||
symbol,
|
||||
orderId,
|
||||
limit,
|
||||
});
|
||||
}
|
||||
|
||||
getPastOrders(
|
||||
symbol?: string,
|
||||
orderId?: string,
|
||||
limit?: number,
|
||||
): Promise<APIResponse<any>> {
|
||||
return this.getPrivate('/spot/v1/history-orders', {
|
||||
symbol,
|
||||
orderId,
|
||||
limit,
|
||||
});
|
||||
}
|
||||
|
||||
getMyTrades(
|
||||
symbol?: string,
|
||||
limit?: number,
|
||||
fromId?: number,
|
||||
toId?: number,
|
||||
): Promise<APIResponse<any>> {
|
||||
return this.getPrivate('/spot/v1/myTrades', {
|
||||
symbol,
|
||||
limit,
|
||||
fromId,
|
||||
toId,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Wallet Data Endpoints
|
||||
*/
|
||||
|
||||
getBalances(): Promise<APIResponse<SpotBalances>> {
|
||||
return this.getPrivate('/spot/v1/account');
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,5 @@
|
||||
export * from './response';
|
||||
export * from './request';
|
||||
export * from './shared';
|
||||
export * from './v5-shared';
|
||||
export * from './shared-v5';
|
||||
export * from './websockets';
|
||||
export * from './websocket.events';
|
||||
|
||||
@@ -3,7 +3,6 @@ export * from './copy-trading';
|
||||
export * from './contract';
|
||||
export * from './linear';
|
||||
export * from './inverse';
|
||||
export * from './spot';
|
||||
export * from './usdc-perp';
|
||||
export * from './usdc-options';
|
||||
export * from './usdc-shared';
|
||||
|
||||
@@ -1,89 +0,0 @@
|
||||
import { OrderSide, numberInString } from '../shared';
|
||||
|
||||
export type OrderTypeSpot = 'LIMIT' | 'MARKET' | 'LIMIT_MAKER';
|
||||
export type OrderTimeInForce = 'GTC' | 'FOK' | 'IOC';
|
||||
|
||||
export interface NewSpotOrder {
|
||||
symbol: string;
|
||||
qty: number;
|
||||
side: OrderSide;
|
||||
type: OrderTypeSpot;
|
||||
timeInForce?: OrderTimeInForce;
|
||||
price?: number;
|
||||
orderLinkId?: string;
|
||||
}
|
||||
|
||||
export interface NewSpotOrderV3 {
|
||||
symbol: string;
|
||||
orderQty: string;
|
||||
side: OrderSide;
|
||||
orderType: OrderTypeSpot;
|
||||
timeInForce?: OrderTimeInForce;
|
||||
orderPrice?: string;
|
||||
orderLinkId?: string;
|
||||
orderCategory?: 0 | 1;
|
||||
triggerPrice?: string;
|
||||
}
|
||||
|
||||
export interface SpotCancelOrderBatchRequest {
|
||||
symbol: string;
|
||||
side?: OrderSide;
|
||||
orderTypes: OrderTypeSpot[];
|
||||
orderCategory?: 0 | 1;
|
||||
}
|
||||
|
||||
export interface SpotOrderQueryById {
|
||||
orderId?: string;
|
||||
orderLinkId?: string;
|
||||
orderCategory?: 0 | 1;
|
||||
}
|
||||
|
||||
export interface SpotSymbolInfo {
|
||||
name: string;
|
||||
alias: string;
|
||||
baseCurrency: string;
|
||||
quoteCurrency: string;
|
||||
basePrecision: numberInString;
|
||||
quotePrecision: numberInString;
|
||||
minTradeQuantity: numberInString;
|
||||
minTradeAmount: numberInString;
|
||||
minPricePrecision: numberInString;
|
||||
maxTradeQuantity: numberInString;
|
||||
maxTradeAmount: numberInString;
|
||||
category: numberInString;
|
||||
}
|
||||
|
||||
export interface SpotMyTradesRequest {
|
||||
symbol?: string;
|
||||
orderId?: string;
|
||||
limit?: string;
|
||||
startTime?: number;
|
||||
endTime?: number;
|
||||
fromTradeId?: string;
|
||||
toTradeId?: string;
|
||||
}
|
||||
|
||||
export interface SpotLeveragedTokenPRHistoryRequest {
|
||||
ltCode?: string;
|
||||
orderId?: string;
|
||||
startTime?: number;
|
||||
endTime?: number;
|
||||
limit?: number;
|
||||
orderType?: 1 | 2;
|
||||
serialNo?: string;
|
||||
}
|
||||
|
||||
export interface SpotCrossMarginBorrowingInfoRequest {
|
||||
startTime?: number;
|
||||
endTime?: number;
|
||||
coin?: string;
|
||||
status?: 0 | 1 | 2;
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
export interface SpotCrossMarginRepaymentHistoryRequest {
|
||||
startTime?: number;
|
||||
endTime?: number;
|
||||
coin?: string;
|
||||
limit?: number;
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
import { AccountTypeV5, CategoryV5, TransactionTypeV5 } from '../v5-shared';
|
||||
import { AccountTypeV5, CategoryV5, TransactionTypeV5 } from '../shared-v5';
|
||||
|
||||
export interface GetWalletBalanceParamsV5 {
|
||||
accountType: AccountTypeV5;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { AccountTypeV5, CategoryV5 } from '../v5-shared';
|
||||
import { AccountTypeV5, CategoryV5 } from '../shared-v5';
|
||||
|
||||
export interface GetCoinExchangeRecordParamsV5 {
|
||||
fromCoin?: string;
|
||||
@@ -20,6 +20,8 @@ export interface GetDeliveryRecordParamsV5 {
|
||||
export interface GetSettlementRecordParamsV5 {
|
||||
category: CategoryV5;
|
||||
symbol?: string;
|
||||
startTime?: number;
|
||||
endTime?: number;
|
||||
limit?: number;
|
||||
cursor?: string;
|
||||
}
|
||||
@@ -102,6 +104,7 @@ export interface GetSubAccountDepositRecordParamsV5 {
|
||||
}
|
||||
|
||||
export interface GetInternalDepositRecordParamsV5 {
|
||||
txID?: string;
|
||||
startTime?: number;
|
||||
endTime?: number;
|
||||
coin?: string;
|
||||
@@ -111,6 +114,7 @@ export interface GetInternalDepositRecordParamsV5 {
|
||||
|
||||
export interface GetWithdrawalRecordsParamsV5 {
|
||||
withdrawID?: string;
|
||||
txID?: string;
|
||||
coin?: string;
|
||||
withdrawType?: number;
|
||||
startTime?: number;
|
||||
@@ -131,7 +135,7 @@ export interface WithdrawParamsV5 {
|
||||
feeType?: 0 | 1;
|
||||
requestId?: string;
|
||||
beneficiary?: {
|
||||
vaspEntityId: string;
|
||||
vaspEntityId?: string;
|
||||
beneficiaryName?: string;
|
||||
};
|
||||
}
|
||||
|
||||
21
src/types/request/v5-earn.ts
Normal file
21
src/types/request/v5-earn.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
export interface SubmitStakeRedeemParams {
|
||||
category: string;
|
||||
orderType: 'Stake' | 'Redeem';
|
||||
accountType: 'FUND' | 'UNIFIED';
|
||||
amount: string;
|
||||
coin: string;
|
||||
productId: string;
|
||||
orderLinkId: string;
|
||||
}
|
||||
|
||||
export interface GetEarnOrderHistoryParams {
|
||||
category: string;
|
||||
orderId?: string;
|
||||
orderLinkId?: string;
|
||||
}
|
||||
|
||||
export interface GetEarnPositionParams {
|
||||
category: string;
|
||||
productId?: string;
|
||||
coin?: string;
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
import { KlineIntervalV3 } from '../shared';
|
||||
import { CategoryV5, InstrumentStatusV5, OptionTypeV5 } from '../v5-shared';
|
||||
import { CategoryV5, InstrumentStatusV5, OptionTypeV5 } from '../shared-v5';
|
||||
|
||||
export interface GetKlineParamsV5 {
|
||||
category: 'spot' | 'linear' | 'inverse';
|
||||
@@ -108,6 +108,7 @@ export interface GetInsuranceParamsV5 {
|
||||
export interface GetRiskLimitParamsV5 {
|
||||
category?: 'linear' | 'inverse';
|
||||
symbol?: string;
|
||||
cursor?: string;
|
||||
}
|
||||
|
||||
export interface GetOptionDeliveryPriceParamsV5 {
|
||||
|
||||
@@ -5,7 +5,7 @@ import {
|
||||
OrderTypeV5,
|
||||
PositionIdx,
|
||||
TPSLModeV5,
|
||||
} from '../v5-shared';
|
||||
} from '../shared-v5';
|
||||
|
||||
export interface PositionInfoParamsV5 {
|
||||
category: CategoryV5;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { ExecTypeV5 } from '../v5-shared';
|
||||
import { ExecTypeV5 } from '../shared-v5';
|
||||
|
||||
export interface GetPreUpgradeOrderHistoryParamsV5 {
|
||||
category: 'linear' | 'inverse';
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { LTOrderTypeV5 } from '../v5-shared';
|
||||
import { LTOrderTypeV5 } from '../shared-v5';
|
||||
|
||||
export interface PurchaseSpotLeveragedTokenParamsV5 {
|
||||
ltCoin: string;
|
||||
|
||||
@@ -8,7 +8,8 @@ import {
|
||||
OrderTriggerByV5,
|
||||
OrderTypeV5,
|
||||
PositionIdx,
|
||||
} from '../v5-shared';
|
||||
StopOrderTypeV5,
|
||||
} from '../shared-v5';
|
||||
|
||||
export interface OrderParamsV5 {
|
||||
category: CategoryV5;
|
||||
@@ -53,6 +54,7 @@ export interface AmendOrderParamsV5 {
|
||||
triggerPrice?: string;
|
||||
qty?: string;
|
||||
price?: string;
|
||||
tpslMode?: 'Full' | 'Partial';
|
||||
takeProfit?: string;
|
||||
stopLoss?: string;
|
||||
tpTriggerBy?: OrderTriggerByV5;
|
||||
@@ -88,6 +90,7 @@ export interface GetAccountHistoricOrdersParamsV5 {
|
||||
category: CategoryV5;
|
||||
symbol?: string;
|
||||
baseCoin?: string;
|
||||
settleCoin?: string;
|
||||
orderId?: string;
|
||||
orderLinkId?: string;
|
||||
orderFilter?: OrderFilterV5;
|
||||
@@ -104,11 +107,13 @@ export interface CancelAllOrdersParamsV5 {
|
||||
baseCoin?: string;
|
||||
settleCoin?: string;
|
||||
orderFilter?: OrderFilterV5;
|
||||
stopOrderType?: StopOrderTypeV5;
|
||||
}
|
||||
|
||||
export interface BatchOrderParamsV5 {
|
||||
symbol: string;
|
||||
side: OrderSideV5;
|
||||
isLeverage?: 0 | 1;
|
||||
orderType: OrderTypeV5;
|
||||
qty: string;
|
||||
price?: string;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { PermissionsV5 } from '../v5-shared';
|
||||
import { PermissionsV5 } from '../shared-v5';
|
||||
|
||||
export interface CreateSubMemberParamsV5 {
|
||||
username: string;
|
||||
|
||||
@@ -4,7 +4,7 @@ import {
|
||||
CategoryV5,
|
||||
TransactionTypeV5,
|
||||
UnifiedUpdateStatusV5,
|
||||
} from '../v5-shared';
|
||||
} from '../shared-v5';
|
||||
|
||||
export interface WalletBalanceV5Coin {
|
||||
coin: string;
|
||||
@@ -14,7 +14,7 @@ export interface WalletBalanceV5Coin {
|
||||
free: string; // spot only
|
||||
locked: string; // spot only
|
||||
borrowAmount: string;
|
||||
availableToBorrow: string;
|
||||
availableToBorrow: string; // deprecated field
|
||||
availableToWithdraw: string;
|
||||
accruedInterest: string;
|
||||
totalOrderIM: string;
|
||||
@@ -23,6 +23,8 @@ export interface WalletBalanceV5Coin {
|
||||
unrealisedPnl: string;
|
||||
cumRealisedPnl: string;
|
||||
bonus: string;
|
||||
marginCollateral: boolean;
|
||||
collateralSwitch: boolean;
|
||||
}
|
||||
|
||||
export interface WalletBalanceV5 {
|
||||
@@ -54,6 +56,9 @@ export interface BorrowHistoryRecordV5 {
|
||||
hourlyBorrowRate: string;
|
||||
InterestBearingBorrowSize: string;
|
||||
costExemption: string;
|
||||
borrowAmount: string;
|
||||
unrealisedLoss: string;
|
||||
freeBorrowedAmount: string;
|
||||
}
|
||||
|
||||
export interface CollateralInfoV5 {
|
||||
@@ -110,6 +115,7 @@ export interface TransactionLogV5 {
|
||||
change: string;
|
||||
cashBalance: string;
|
||||
feeRate: string;
|
||||
bonusChange: string;
|
||||
tradeId: string;
|
||||
orderId: string;
|
||||
orderLinkId: string;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { AccountTypeV5, OrderSideV5, WithdrawalTypeV5 } from '../v5-shared';
|
||||
import { AccountTypeV5, OrderSideV5, WithdrawalTypeV5 } from '../shared-v5';
|
||||
|
||||
export interface CoinExchangeRecordV5 {
|
||||
fromCoin: string;
|
||||
@@ -66,6 +66,8 @@ export interface AccountCoinBalanceV5 {
|
||||
walletBalance: string;
|
||||
transferBalance: string;
|
||||
bonus: string;
|
||||
transferSafeAmount: string;
|
||||
ltvTransferSafeAmount: string;
|
||||
};
|
||||
}
|
||||
|
||||
@@ -113,6 +115,9 @@ export interface DepositRecordV5 {
|
||||
confirmations: string;
|
||||
txIndex: string;
|
||||
blockHash: string;
|
||||
batchReleaseLimit: string;
|
||||
depositType: string;
|
||||
fromAddress: string;
|
||||
}
|
||||
|
||||
export interface InternalDepositRecordV5 {
|
||||
@@ -123,6 +128,7 @@ export interface InternalDepositRecordV5 {
|
||||
status: 1 | 2 | 3;
|
||||
address: string;
|
||||
createdTime: string;
|
||||
txID: string;
|
||||
}
|
||||
|
||||
export interface DepositAddressChainV5 {
|
||||
@@ -130,6 +136,8 @@ export interface DepositAddressChainV5 {
|
||||
addressDeposit: string;
|
||||
tagDeposit: string;
|
||||
chain: string;
|
||||
batchReleaseLimit: string;
|
||||
contractAddress: string;
|
||||
}
|
||||
|
||||
export interface DepositAddressResultV5 {
|
||||
@@ -151,6 +159,8 @@ export interface CoinInfoV5 {
|
||||
minAccuracy: string;
|
||||
chainDeposit: string;
|
||||
chainWithdraw: string;
|
||||
withdrawPercentageFee: string;
|
||||
contractAddress: string;
|
||||
}[];
|
||||
}
|
||||
|
||||
@@ -169,6 +179,22 @@ export interface WithdrawalRecordV5 {
|
||||
updateTime: string;
|
||||
}
|
||||
|
||||
export interface WithdrawableAmountV5 {
|
||||
limitAmountUsd: string;
|
||||
withdrawableAmount: {
|
||||
SPOT: {
|
||||
coin: string;
|
||||
withdrawableAmount: string;
|
||||
availableBalance: string;
|
||||
};
|
||||
FUND: {
|
||||
coin: string;
|
||||
withdrawableAmount: string;
|
||||
availableBalance: string;
|
||||
};
|
||||
};
|
||||
}
|
||||
|
||||
export interface VaspEntityV5 {
|
||||
vaspEntityId: string;
|
||||
vaspName: string;
|
||||
@@ -220,7 +246,7 @@ export interface ConvertStatusV5 {
|
||||
fromAmount: string;
|
||||
toAmount: string;
|
||||
exchangeStatus: 'init' | 'processing' | 'success' | 'failure';
|
||||
extInfo: object;
|
||||
extInfo: { paramType: string; paramValue: string };
|
||||
convertRate: string;
|
||||
createdAt: string;
|
||||
}
|
||||
@@ -236,7 +262,7 @@ export interface ConvertHistoryRecordV5 {
|
||||
fromAmount: string;
|
||||
toAmount: string;
|
||||
exchangeStatus: 'init' | 'processing' | 'success' | 'failure';
|
||||
extInfo: object;
|
||||
extInfo: { paramType: string; paramValue: string };
|
||||
convertRate: string;
|
||||
createdAt: string;
|
||||
}
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
export interface CollateralCoinV5 {
|
||||
collateralAccuracy: number;
|
||||
currency: string;
|
||||
initialLTV: string;
|
||||
liquidationLTV: string;
|
||||
marginCallLTV: string;
|
||||
|
||||
30
src/types/response/v5-earn.ts
Normal file
30
src/types/response/v5-earn.ts
Normal file
@@ -0,0 +1,30 @@
|
||||
export interface EarnProduct {
|
||||
category: string;
|
||||
estimateApr: string;
|
||||
coin: string;
|
||||
minStakeAmount: string;
|
||||
maxStakeAmount: string;
|
||||
precision: string;
|
||||
productId: string;
|
||||
status: 'Available' | 'NotAvailable';
|
||||
}
|
||||
|
||||
export interface EarnOrderHistory {
|
||||
coin: string;
|
||||
orderValue: string;
|
||||
orderType: 'Redeem' | 'Stake';
|
||||
orderId: string;
|
||||
orderLinkId: string;
|
||||
status: 'Success' | 'Fail' | 'Pending';
|
||||
createdAt: string;
|
||||
productId: string;
|
||||
updatedAt: string;
|
||||
}
|
||||
|
||||
export interface EarnPosition {
|
||||
coin: string;
|
||||
productId: string;
|
||||
amount: string;
|
||||
totalPnl: string;
|
||||
claimableYield: string;
|
||||
}
|
||||
@@ -7,7 +7,7 @@ import {
|
||||
MarginTradingV5,
|
||||
OptionTypeV5,
|
||||
OrderSideV5,
|
||||
} from '../v5-shared';
|
||||
} from '../shared-v5';
|
||||
|
||||
/**
|
||||
* OHLCVT candle used by v5 APIs
|
||||
@@ -163,6 +163,8 @@ export interface OrderbookResponseV5 {
|
||||
a: OrderbookLevelV5[];
|
||||
ts: number;
|
||||
u: number;
|
||||
seq: number;
|
||||
cts: number;
|
||||
}
|
||||
|
||||
export interface TickerLinearInverseV5 {
|
||||
@@ -192,6 +194,7 @@ export interface TickerLinearInverseV5 {
|
||||
preOpenPrice: string;
|
||||
preQty: string;
|
||||
curPreListingPhase: string;
|
||||
basis: string;
|
||||
}
|
||||
|
||||
export interface TickerOptionV5 {
|
||||
@@ -252,6 +255,10 @@ export interface PublicTradeV5 {
|
||||
side: OrderSideV5;
|
||||
time: string;
|
||||
isBlockTrade: boolean;
|
||||
mP?: string;
|
||||
iP?: string;
|
||||
mIv?: string;
|
||||
iv?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -279,6 +286,7 @@ export interface HistoricalVolatilityV5 {
|
||||
|
||||
export interface InsuranceDataV5 {
|
||||
coin: string;
|
||||
symbols: string;
|
||||
balance: string;
|
||||
value: string;
|
||||
}
|
||||
@@ -299,6 +307,7 @@ export interface RiskLimitV5 {
|
||||
isLowestRisk: 0 | 1;
|
||||
maxLeverage: string;
|
||||
mmDeduction: string;
|
||||
nextPageCursor?: string;
|
||||
}
|
||||
|
||||
/** @deprecated use DeliveryPriceV5 instead */
|
||||
|
||||
@@ -9,7 +9,7 @@ import {
|
||||
StopOrderTypeV5,
|
||||
TPSLModeV5,
|
||||
TradeModeV5,
|
||||
} from '../v5-shared';
|
||||
} from '../shared-v5';
|
||||
|
||||
export interface PositionV5 {
|
||||
positionIdx: PositionIdx;
|
||||
@@ -29,6 +29,7 @@ export interface PositionV5 {
|
||||
bustPrice?: string;
|
||||
positionIM?: string;
|
||||
positionMM?: string;
|
||||
positionBalance?: string;
|
||||
tpslMode?: TPSLModeV5;
|
||||
takeProfit?: string;
|
||||
stopLoss?: string;
|
||||
@@ -108,6 +109,7 @@ export interface ExecutionV5 {
|
||||
underlyingPrice?: string;
|
||||
blockTradeId?: string;
|
||||
closedSize?: string;
|
||||
seq: number;
|
||||
}
|
||||
|
||||
export interface ClosedPnLV5 {
|
||||
|
||||
@@ -2,7 +2,7 @@ import {
|
||||
LTOrderStatusV5,
|
||||
LTOrderTypeV5,
|
||||
LeverageTokenStatusV5,
|
||||
} from '../v5-shared';
|
||||
} from '../shared-v5';
|
||||
|
||||
export interface LeverageTokenInfoV5 {
|
||||
ltCoin: string;
|
||||
|
||||
@@ -10,7 +10,7 @@ import {
|
||||
OrderTypeV5,
|
||||
PositionIdx,
|
||||
StopOrderTypeV5,
|
||||
} from '../v5-shared';
|
||||
} from '../shared-v5';
|
||||
|
||||
export interface OrderResultV5 {
|
||||
orderId: string;
|
||||
@@ -78,16 +78,18 @@ export interface BatchCreateOrderResultV5 {
|
||||
createAt: string;
|
||||
}
|
||||
|
||||
export interface BatchOrdersRetExtInfoV5 {
|
||||
list: {
|
||||
code: number;
|
||||
msg: string;
|
||||
}[];
|
||||
}
|
||||
|
||||
export interface BatchOrdersResponseV5<T extends unknown[]> {
|
||||
result: {
|
||||
list: T;
|
||||
};
|
||||
retExtInfo: {
|
||||
list: {
|
||||
code: number;
|
||||
msg: string;
|
||||
}[];
|
||||
};
|
||||
retExtInfo: BatchOrdersRetExtInfoV5;
|
||||
}
|
||||
|
||||
export interface BatchAmendOrderResultV5 {
|
||||
@@ -109,5 +111,7 @@ export interface SpotBorrowCheckResultV5 {
|
||||
side: OrderSideV5;
|
||||
maxTradeQty: string;
|
||||
maxTradeAmount: string;
|
||||
spotMaxTradeQty: string;
|
||||
spotMaxTradeAmount: string;
|
||||
borrowCoin: string;
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { PermissionsV5 } from '../v5-shared';
|
||||
import { PermissionsV5 } from '../shared-v5';
|
||||
|
||||
export interface CreateSubMemberResultV5 {
|
||||
uid: string;
|
||||
@@ -27,26 +27,44 @@ export interface SubMemberV5 {
|
||||
}
|
||||
export type ApiKeyType = 1 | 2;
|
||||
|
||||
export interface ApiKeyPermissionsV5 {
|
||||
ContractTrade: string[];
|
||||
Spot: string[];
|
||||
Wallet: string[];
|
||||
Options: string[];
|
||||
Derivatives: string[];
|
||||
CopyTrading: string[];
|
||||
BlockTrade: string[];
|
||||
Exchange: string[];
|
||||
NFT: string[];
|
||||
Affiliate: string[];
|
||||
}
|
||||
|
||||
export interface ApiKeyInfoV5 {
|
||||
id: string;
|
||||
note: string;
|
||||
apiKey: string;
|
||||
readOnly: 0 | 1;
|
||||
secret: string;
|
||||
permissions: PermissionsV5;
|
||||
ips?: string[];
|
||||
type: ApiKeyType;
|
||||
deadlineDay?: number;
|
||||
expiredAt?: string;
|
||||
permissions: ApiKeyPermissionsV5;
|
||||
ips: string[];
|
||||
type: 1 | 2; // 1: personal, 2: connected to third-party app
|
||||
deadlineDay: number;
|
||||
expiredAt: string;
|
||||
createdAt: string;
|
||||
unified: 0 | 1;
|
||||
uta: 0 | 1;
|
||||
/** @deprecated */
|
||||
unified: number;
|
||||
uta: 0 | 1; // 0: regular account, 1: unified trade account
|
||||
userID: number;
|
||||
inviterID: number;
|
||||
vipLevel?: string;
|
||||
mktMakerLevel?: string;
|
||||
affiliateID?: number;
|
||||
vipLevel: string;
|
||||
mktMakerLevel: string;
|
||||
affiliateID: number;
|
||||
rsaPublicKey: string;
|
||||
isMaster: boolean;
|
||||
parentUid: string;
|
||||
kycLevel: 'LEVEL_DEFAULT' | 'LEVEL_1' | 'LEVEL_2';
|
||||
kycRegion: string;
|
||||
}
|
||||
|
||||
export interface UpdateApiKeyResultV5 {
|
||||
|
||||
@@ -142,7 +142,10 @@ export type StopOrderTypeV5 =
|
||||
| 'Stop'
|
||||
| 'PartialTakeProfit'
|
||||
| 'PartialStopLoss'
|
||||
| 'tpslOrder';
|
||||
| 'tpslOrder'
|
||||
| 'OcoOrder'
|
||||
| 'MmRateClose'
|
||||
| 'BidirectionalTpslOrder';
|
||||
|
||||
/**
|
||||
* Position index. Used to identify positions in different position modes.
|
||||
@@ -1,23 +1,7 @@
|
||||
import { ContractClient } from '../contract-client';
|
||||
import { InverseClient } from '../inverse-client';
|
||||
import { LinearClient } from '../linear-client';
|
||||
import { RestClientV5 } from '../rest-client-v5';
|
||||
import { SpotClient } from '../spot-client';
|
||||
import { SpotClientV3 } from '../spot-client-v3';
|
||||
import { UnifiedMarginClient } from '../unified-margin-client';
|
||||
import { USDCOptionClient } from '../usdc-option-client';
|
||||
import { USDCPerpetualClient } from '../usdc-perpetual-client';
|
||||
|
||||
export type RESTClient =
|
||||
| InverseClient
|
||||
| LinearClient
|
||||
| SpotClient
|
||||
| SpotClientV3
|
||||
| USDCOptionClient
|
||||
| USDCPerpetualClient
|
||||
| UnifiedMarginClient
|
||||
| ContractClient
|
||||
| RestClientV5;
|
||||
export type RESTClient = SpotClientV3 | RestClientV5;
|
||||
|
||||
export type numberInString = string;
|
||||
|
||||
@@ -53,14 +37,6 @@ export type KlineIntervalV3 =
|
||||
| 'W'
|
||||
| 'M';
|
||||
|
||||
export interface APIResponse<T> {
|
||||
ret_code: number;
|
||||
ret_msg: 'OK' | string;
|
||||
ext_code: string | null;
|
||||
ext_info: string | null;
|
||||
result: T;
|
||||
}
|
||||
|
||||
export interface APIRateLimit {
|
||||
/** Remaining requests to this endpoint before the next reset */
|
||||
remainingRequests: number;
|
||||
@@ -88,12 +64,6 @@ export interface APIResponseV3<T> {
|
||||
}
|
||||
|
||||
export type APIResponseV3WithTime<T> = APIResponseV3<T> & { time: number };
|
||||
|
||||
export interface APIResponseWithTime<T = {}> extends APIResponse<T> {
|
||||
/** UTC timestamp */
|
||||
time_now: numberInString;
|
||||
}
|
||||
|
||||
/**
|
||||
* Request Parameter Types
|
||||
*/
|
||||
|
||||
3
src/types/websockets/index.ts
Normal file
3
src/types/websockets/index.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
export * from './ws-general';
|
||||
export * from './ws-events';
|
||||
export * from './ws-confirmations';
|
||||
156
src/types/websockets/ws-api.ts
Normal file
156
src/types/websockets/ws-api.ts
Normal file
@@ -0,0 +1,156 @@
|
||||
import { APIID, WS_KEY_MAP } from '../../util';
|
||||
import {
|
||||
AmendOrderParamsV5,
|
||||
BatchAmendOrderParamsV5,
|
||||
BatchCancelOrderParamsV5,
|
||||
BatchOrderParamsV5,
|
||||
CancelOrderParamsV5,
|
||||
OrderParamsV5,
|
||||
} from '../request';
|
||||
import {
|
||||
BatchAmendOrderResultV5,
|
||||
BatchCancelOrderResultV5,
|
||||
BatchCreateOrderResultV5,
|
||||
BatchOrdersRetExtInfoV5,
|
||||
OrderResultV5,
|
||||
} from '../response';
|
||||
import { WsKey } from './ws-general';
|
||||
|
||||
// When new WS API operations are added, make sure to also update WS_API_Operations[] below
|
||||
export type WSAPIOperation =
|
||||
| 'order.create'
|
||||
| 'order.amend'
|
||||
| 'order.cancel'
|
||||
| 'order.create-batch'
|
||||
| 'order.amend-batch'
|
||||
| 'order.cancel-batch';
|
||||
|
||||
export const WS_API_Operations: WSAPIOperation[] = [
|
||||
'order.create',
|
||||
'order.amend',
|
||||
'order.cancel',
|
||||
'order.create-batch',
|
||||
'order.amend-batch',
|
||||
'order.cancel-batch',
|
||||
];
|
||||
|
||||
export type WsOperation =
|
||||
| 'subscribe'
|
||||
| 'unsubscribe'
|
||||
| 'auth'
|
||||
| 'ping'
|
||||
| 'pong';
|
||||
|
||||
export interface WsRequestOperationBybit<TWSTopic extends string> {
|
||||
req_id: string;
|
||||
op: WsOperation;
|
||||
args?: (TWSTopic | string | number)[];
|
||||
}
|
||||
|
||||
export interface WSAPIRequest<
|
||||
TRequestParams = undefined,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
TWSOperation extends WSAPIOperation = any,
|
||||
> {
|
||||
reqId: string;
|
||||
op: TWSOperation;
|
||||
header: {
|
||||
'X-BAPI-TIMESTAMP': string;
|
||||
'X-BAPI-RECV-WINDOW': string;
|
||||
Referer: typeof APIID;
|
||||
};
|
||||
args: [TRequestParams];
|
||||
}
|
||||
|
||||
export interface WSAPIResponse<
|
||||
TResponseData extends object = object,
|
||||
TOperation extends WSAPIOperation = WSAPIOperation,
|
||||
> {
|
||||
wsKey: WsKey;
|
||||
/** Auto-generated */
|
||||
reqId: string;
|
||||
retCode: 0 | number;
|
||||
retMsg: 'OK' | string;
|
||||
op: TOperation;
|
||||
data: TResponseData;
|
||||
header?: {
|
||||
'X-Bapi-Limit': string;
|
||||
'X-Bapi-Limit-Status': string;
|
||||
'X-Bapi-Limit-Reset-Timestamp': string;
|
||||
Traceid: string;
|
||||
Timenow: string;
|
||||
};
|
||||
connId: string;
|
||||
}
|
||||
|
||||
export type Exact<T> = {
|
||||
// This part says: if there's any key that's not in T, it's an error
|
||||
[K: string]: never;
|
||||
} & {
|
||||
[K in keyof T]: T[K];
|
||||
};
|
||||
|
||||
/**
|
||||
* List of operations supported for this WsKey (connection)
|
||||
*/
|
||||
export interface WsAPIWsKeyTopicMap {
|
||||
[WS_KEY_MAP.v5PrivateTrade]: WSAPIOperation;
|
||||
}
|
||||
|
||||
/**
|
||||
* Request parameters expected per operation
|
||||
*/
|
||||
export interface WsAPITopicRequestParamMap {
|
||||
'order.create': OrderParamsV5;
|
||||
'order.amend': AmendOrderParamsV5;
|
||||
'order.cancel': CancelOrderParamsV5;
|
||||
|
||||
'order.create-batch': {
|
||||
category: 'option' | 'linear';
|
||||
request: BatchOrderParamsV5[];
|
||||
};
|
||||
'order.amend-batch': {
|
||||
category: 'option' | 'linear';
|
||||
request: BatchAmendOrderParamsV5[];
|
||||
};
|
||||
'order.cancel-batch': {
|
||||
category: 'option' | 'linear';
|
||||
request: BatchCancelOrderParamsV5[];
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Response structure expected for each operation
|
||||
*/
|
||||
export interface WsAPIOperationResponseMap {
|
||||
'order.create': WSAPIResponse<OrderResultV5, 'order.create'>;
|
||||
'order.amend': WSAPIResponse<OrderResultV5, 'order.amend'>;
|
||||
'order.cancel': WSAPIResponse<OrderResultV5, 'order.cancel'>;
|
||||
|
||||
'order.create-batch': WSAPIResponse<
|
||||
{ list: BatchCreateOrderResultV5[] },
|
||||
'order.create-batch'
|
||||
> & {
|
||||
retExtInfo: BatchOrdersRetExtInfoV5;
|
||||
};
|
||||
'order.amend-batch': WSAPIResponse<
|
||||
{ list: BatchAmendOrderResultV5[] },
|
||||
'order.amend-batch'
|
||||
> & {
|
||||
retExtInfo: BatchOrdersRetExtInfoV5;
|
||||
};
|
||||
'order.cancel-batch': WSAPIResponse<
|
||||
{ list: BatchCancelOrderResultV5[] },
|
||||
'order.cancel-batch'
|
||||
> & {
|
||||
retExtInfo: BatchOrdersRetExtInfoV5;
|
||||
};
|
||||
|
||||
ping: {
|
||||
retCode: 0 | number;
|
||||
retMsg: 'OK' | string;
|
||||
op: 'pong';
|
||||
data: [string];
|
||||
connId: string;
|
||||
};
|
||||
}
|
||||
17
src/types/websockets/ws-confirmations.ts
Normal file
17
src/types/websockets/ws-confirmations.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
export interface WebsocketTopicSubscriptionConfirmationEvent {
|
||||
op: 'subscribe';
|
||||
req_id: string;
|
||||
conn_id: string;
|
||||
ret_msg: string;
|
||||
success: boolean;
|
||||
}
|
||||
|
||||
export interface WebsocketSucceededTopicSubscriptionConfirmationEvent
|
||||
extends WebsocketTopicSubscriptionConfirmationEvent {
|
||||
success: true;
|
||||
}
|
||||
|
||||
export interface WebsocketFailedTopicSubscriptionConfirmationEvent
|
||||
extends WebsocketTopicSubscriptionConfirmationEvent {
|
||||
success: false;
|
||||
}
|
||||
@@ -1,3 +1,5 @@
|
||||
import WebSocket from 'isomorphic-ws';
|
||||
|
||||
import {
|
||||
CategoryV5,
|
||||
ExecTypeV5,
|
||||
@@ -17,8 +19,24 @@ import {
|
||||
StopOrderTypeV5,
|
||||
TPSLModeV5,
|
||||
TradeModeV5,
|
||||
} from './v5-shared';
|
||||
import { WsKey } from './websockets';
|
||||
} from '../shared-v5';
|
||||
|
||||
import { WsKey } from './ws-general';
|
||||
|
||||
export interface MessageEventLike {
|
||||
target: WebSocket;
|
||||
type: 'message';
|
||||
data: string;
|
||||
}
|
||||
|
||||
export function isMessageEvent(msg: unknown): msg is MessageEventLike {
|
||||
if (typeof msg !== 'object' || !msg) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const message = msg as MessageEventLike;
|
||||
return message['type'] === 'message' && typeof message['data'] === 'string';
|
||||
}
|
||||
|
||||
export interface WSPublicTopicEventV5<TTopic extends string, TType, TData> {
|
||||
id?: string;
|
||||
@@ -1,18 +1,7 @@
|
||||
import { RestClientOptions, WS_KEY_MAP } from '../util';
|
||||
import { RestClientOptions, WS_KEY_MAP } from '../../util';
|
||||
|
||||
/** For spot markets, spotV3 is recommended */
|
||||
export type APIMarket =
|
||||
| 'inverse'
|
||||
| 'linear'
|
||||
| 'spot'
|
||||
| 'spotv3'
|
||||
| 'usdcOption'
|
||||
| 'usdcPerp'
|
||||
| 'unifiedPerp'
|
||||
| 'unifiedOption'
|
||||
| 'contractUSDT'
|
||||
| 'contractInverse'
|
||||
| 'v5';
|
||||
export type APIMarket = 'v5';
|
||||
|
||||
// Same as inverse futures
|
||||
export type WsPublicInverseTopic =
|
||||
@@ -82,10 +71,23 @@ export type WsTopic = WsPublicTopics | WsPrivateTopic;
|
||||
|
||||
/** This is used to differentiate between each of the available websocket streams (as bybit has multiple websockets) */
|
||||
export type WsKey = (typeof WS_KEY_MAP)[keyof typeof WS_KEY_MAP];
|
||||
export type WsMarket = 'all';
|
||||
|
||||
export interface WSClientConfigurableOptions {
|
||||
/** Your API key */
|
||||
key?: string;
|
||||
|
||||
/** Your API secret */
|
||||
secret?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to connect to Bybit's testnet environment.
|
||||
*
|
||||
* Notes:
|
||||
*
|
||||
* - If demo trading, `testnet` should be set to false!
|
||||
* - If testing a strategy, use demo trading instead. Testnet market data is very different from real market conditions.
|
||||
*/
|
||||
testnet?: boolean;
|
||||
|
||||
/**
|
||||
@@ -96,28 +98,58 @@ export interface WSClientConfigurableOptions {
|
||||
demoTrading?: boolean;
|
||||
|
||||
/**
|
||||
* The API group this client should connect to.
|
||||
* The API group this client should connect to. The V5 market is currently used by default.
|
||||
*
|
||||
* For the V3 APIs use `v3` as the market (spot/unified margin/usdc/account asset/copy trading)
|
||||
* Only the "V5" "market" is supported here.
|
||||
*/
|
||||
market: APIMarket;
|
||||
market?: APIMarket;
|
||||
|
||||
pongTimeout?: number;
|
||||
pingInterval?: number;
|
||||
reconnectTimeout?: number;
|
||||
/** Override the recv window for authenticating over websockets (default: 5000 ms) */
|
||||
/** Define a recv window when preparing a private websocket signature. This is in milliseconds, so 5000 == 5 seconds */
|
||||
recvWindow?: number;
|
||||
|
||||
/** How often to check if the connection is alive */
|
||||
pingInterval?: number;
|
||||
|
||||
/** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
|
||||
pongTimeout?: number;
|
||||
|
||||
/** Delay in milliseconds before respawning the connection */
|
||||
reconnectTimeout?: number;
|
||||
|
||||
restOptions?: RestClientOptions;
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
requestOptions?: any;
|
||||
|
||||
wsUrl?: string;
|
||||
/** If true, fetch server time before trying to authenticate (disabled by default) */
|
||||
fetchTimeOffsetBeforeAuth?: boolean;
|
||||
|
||||
/**
|
||||
* Default: false.
|
||||
*
|
||||
* When enabled, any calls to the subscribe method will return a promise.
|
||||
* Note: internally, subscription requests are sent in batches. This may not behave as expected when
|
||||
* subscribing to a large number of topics, especially if you are not yet connected when subscribing.
|
||||
*/
|
||||
promiseSubscribeRequests?: boolean;
|
||||
|
||||
/**
|
||||
* Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
|
||||
*
|
||||
* Look in the examples folder for a demonstration on using node's createHmac instead.
|
||||
*/
|
||||
customSignMessageFn?: (message: string, secret: string) => Promise<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* WS configuration that's always defined, regardless of user configuration
|
||||
* (usually comes from defaults if there's no user-provided values)
|
||||
*/
|
||||
export interface WebsocketClientOptions extends WSClientConfigurableOptions {
|
||||
market: APIMarket;
|
||||
pongTimeout: number;
|
||||
pingInterval: number;
|
||||
reconnectTimeout: number;
|
||||
recvWindow: number;
|
||||
authPrivateConnectionsOnConnect: boolean;
|
||||
authPrivateRequests: boolean;
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
import { WebsocketTopicSubscriptionConfirmationEvent } from './topic-subscription-confirmation';
|
||||
|
||||
export interface WebsocketFailedTopicSubscriptionConfirmationEvent
|
||||
extends WebsocketTopicSubscriptionConfirmationEvent {
|
||||
success: false;
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
import { WebsocketTopicSubscriptionConfirmationEvent } from './topic-subscription-confirmation';
|
||||
|
||||
export interface WebsocketSucceededTopicSubscriptionConfirmationEvent
|
||||
extends WebsocketTopicSubscriptionConfirmationEvent {
|
||||
success: true;
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
export interface WebsocketTopicSubscriptionConfirmationEvent {
|
||||
op: 'subscribe';
|
||||
req_id: string;
|
||||
conn_id: string;
|
||||
ret_msg: string;
|
||||
success: boolean;
|
||||
}
|
||||
@@ -1,401 +0,0 @@
|
||||
/* eslint-disable max-len */
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import {
|
||||
APIResponseV3,
|
||||
APIResponseWithTime,
|
||||
InternalTransferRequest,
|
||||
UM7DayTradingHistoryRequest,
|
||||
UMActiveOrdersRequest,
|
||||
UMBatchOrder,
|
||||
UMBatchOrderCancel,
|
||||
UMBatchOrderReplace,
|
||||
UMBorrowHistoryRequest,
|
||||
UMCancelAllOrdersRequest,
|
||||
UMCancelOrderRequest,
|
||||
UMCandlesRequest,
|
||||
UMCategory,
|
||||
UMExchangeCoinsRequest,
|
||||
UMFundingRateHistoryRequest,
|
||||
UMHistoricOrder,
|
||||
UMHistoricOrdersRequest,
|
||||
UMInstrumentInfo,
|
||||
UMInstrumentInfoRequest,
|
||||
UMModifyOrderRequest,
|
||||
UMOpenInterestRequest,
|
||||
UMOptionDeliveryPriceRequest,
|
||||
UMOptionsSettlementHistoryRequest,
|
||||
UMOrderRequest,
|
||||
UMPaginatedResult,
|
||||
UMPerpSettlementHistoryRequest,
|
||||
UMPositionsRequest,
|
||||
UMPublicTradesRequest,
|
||||
UMSetTPSLRequest,
|
||||
UMTransactionLogRequest,
|
||||
} from './types';
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for Derivatives V3 unified margin APIs
|
||||
* @deprecated WARNING
|
||||
* These endpoints are being switched off gradually and are expected to be completely turned off by the end of 2024.
|
||||
* They may stop working at any point before then.
|
||||
* Please update your code as soon as possible to use the V5 APIs instead.
|
||||
*/
|
||||
export class UnifiedMarginClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
return REST_CLIENT_TYPE_ENUM.v3;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const res = await this.getServerTime();
|
||||
return Number(res.time_now);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** Query order book info. Each side has a depth of 25 orders. */
|
||||
getOrderBook(
|
||||
symbol: string,
|
||||
category: string,
|
||||
limit?: number,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/order-book/L2', {
|
||||
category,
|
||||
symbol,
|
||||
limit,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get candles/klines */
|
||||
getCandles(params: UMCandlesRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/kline', params);
|
||||
}
|
||||
|
||||
/** Get a symbol price/statistics ticker */
|
||||
getSymbolTicker(
|
||||
category: UMCategory,
|
||||
symbol?: string,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/tickers', { category, symbol });
|
||||
}
|
||||
|
||||
/** Get trading rules per symbol/contract, incl price/amount/value/leverage filters */
|
||||
getInstrumentInfo(
|
||||
params: UMInstrumentInfoRequest,
|
||||
): Promise<APIResponseV3<UMPaginatedResult<UMInstrumentInfo>>> {
|
||||
return this.get('/derivatives/v3/public/instruments-info', params);
|
||||
}
|
||||
|
||||
/** Query mark price kline (like getCandles() but for mark price). */
|
||||
getMarkPriceCandles(params: UMCandlesRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/mark-price-kline', params);
|
||||
}
|
||||
|
||||
/** Query Index Price Kline */
|
||||
getIndexPriceCandles(params: UMCandlesRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/index-price-kline', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* The funding rate is generated every 8 hours at 00:00 UTC, 08:00 UTC and 16:00 UTC.
|
||||
* For example, if a request is sent at 12:00 UTC, the funding rate generated earlier that day at 08:00 UTC will be sent.
|
||||
*/
|
||||
getFundingRateHistory(
|
||||
params: UMFundingRateHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get(
|
||||
'/derivatives/v3/public/funding/history-funding-rate',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Get Risk Limit */
|
||||
getRiskLimit(
|
||||
category: UMCategory,
|
||||
symbol: string,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/risk-limit/list', {
|
||||
category,
|
||||
symbol,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get option delivery price */
|
||||
getOptionDeliveryPrice(
|
||||
params: UMOptionDeliveryPriceRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/delivery-price', params);
|
||||
}
|
||||
|
||||
/** Get recent trades */
|
||||
getTrades(params: UMPublicTradesRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/recent-trade', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the total amount of unsettled contracts.
|
||||
* In other words, the total number of contracts held in open positions.
|
||||
*/
|
||||
getOpenInterest(params: UMOpenInterestRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/derivatives/v3/public/open-interest', params);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Unified Margin Account Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** -> Order API */
|
||||
|
||||
/** Place an order */
|
||||
submitOrder(params: UMOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/order/create', params);
|
||||
}
|
||||
|
||||
/** Active order parameters (such as quantity, price) and stop order parameters cannot be modified in one request at the same time. Please request modification separately. */
|
||||
modifyOrder(params: UMModifyOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/order/replace', params);
|
||||
}
|
||||
|
||||
/** Cancel order */
|
||||
cancelOrder(params: UMCancelOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/order/cancel', params);
|
||||
}
|
||||
|
||||
/** Query Open Orders */
|
||||
getActiveOrders(params: UMActiveOrdersRequest): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/unified/v3/private/order/unfilled-orders', params);
|
||||
}
|
||||
|
||||
/** Query order history. As order creation/cancellation is asynchronous, the data returned from the interface may be delayed. To access order information in real-time, call getActiveOrders() */
|
||||
getHistoricOrders(
|
||||
params: UMHistoricOrdersRequest,
|
||||
): Promise<APIResponseV3<UMPaginatedResult<UMHistoricOrder>>> {
|
||||
return this.getPrivate('/unified/v3/private/order/list', params);
|
||||
}
|
||||
|
||||
/**
|
||||
* This API provides the batch order mode under the unified margin account.
|
||||
* Max 10 per request
|
||||
*/
|
||||
batchSubmitOrders(
|
||||
category: UMCategory,
|
||||
orders: UMBatchOrder[],
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/order/create-batch', {
|
||||
category,
|
||||
request: orders,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* This interface can modify the open order information in batches.
|
||||
* Currently, it is not supported to modify the conditional order information.
|
||||
* Please note that only unfilled or partial filled orders can be modified.
|
||||
* If both futures and options orders are in one request, only the orders matching the category will be operated according to the category type
|
||||
*/
|
||||
batchReplaceOrders(
|
||||
category: UMCategory,
|
||||
orders: UMBatchOrderReplace[],
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/order/replace-batch', {
|
||||
category,
|
||||
request: orders,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* This API provides batch cancellation under the unified margin account.
|
||||
* Order cancellation of futures and options cannot be canceled in one request at the same time.
|
||||
* If both futures and options orders are in one request, only the orders matching the category will be operated according to the category type.
|
||||
*/
|
||||
batchCancelOrders(
|
||||
category: UMCategory,
|
||||
orders: UMBatchOrderCancel[],
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/order/cancel-batch', {
|
||||
category,
|
||||
request: orders,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* This API provides the cancellation of all open orders under the unified margin account.
|
||||
* Order cancellation of futures and options cannot be canceled in one request at the same time.
|
||||
* If both futures and options orders are in one request, only the orders matching the category will be operated according to the category type.
|
||||
*/
|
||||
cancelAllOrders(
|
||||
params: UMCancelAllOrdersRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/order/cancel-all', params);
|
||||
}
|
||||
|
||||
/** -> Positions API */
|
||||
|
||||
/**
|
||||
* Query my positions real-time. Accessing personal list of positions.
|
||||
* Users can access their position holding information through this interface, such as the number of position holdings and wallet balance.
|
||||
*/
|
||||
getPositions(params: UMPositionsRequest): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/unified/v3/private/position/list', params);
|
||||
}
|
||||
|
||||
/** Leverage setting. */
|
||||
setLeverage(
|
||||
category: UMCategory,
|
||||
symbol: string,
|
||||
buyLeverage: number,
|
||||
sellLeverage: number,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/position/set-leverage', {
|
||||
category,
|
||||
symbol,
|
||||
buyLeverage,
|
||||
sellLeverage,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Switching the TP/SL mode to the cross margin mode or selected positions.
|
||||
* When you set the TP/SL mode on the selected positions, the quantity of take-profit or stop-loss orders can be smaller than the position size. Please use Trading-Stop endpoint.
|
||||
*/
|
||||
setTPSLMode(
|
||||
category: UMCategory,
|
||||
symbol: string,
|
||||
tpSlMode: 1 | 0,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/position/tpsl/switch-mode', {
|
||||
category,
|
||||
symbol,
|
||||
tpSlMode,
|
||||
});
|
||||
}
|
||||
|
||||
/** Set risk limit */
|
||||
setRiskLimit(
|
||||
category: UMCategory,
|
||||
symbol: string,
|
||||
riskId: number,
|
||||
positionIdx: number,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/unified/v3/private/position/set-risk-limit', {
|
||||
category,
|
||||
symbol,
|
||||
riskId,
|
||||
positionIdx,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Set position TP/SL and trailing stop.
|
||||
* Pass the following parameters, then the system will create conditional orders.
|
||||
* If the position is closed, the system will cancel these orders, and adjust the position size.
|
||||
*/
|
||||
setTPSL(params: UMSetTPSLRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/unified/v3/private/position/trading-stop',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Access the user's filled history, ranked by time in descending order.
|
||||
* There might be multiple filled histories for an order.
|
||||
*/
|
||||
get7DayTradingHistory(
|
||||
params: UM7DayTradingHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/unified/v3/private/execution/list', params);
|
||||
}
|
||||
|
||||
/** Query the settlement history, ranked by time in descending order. */
|
||||
getOptionsSettlementHistory(
|
||||
params: UMOptionsSettlementHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/unified/v3/private/delivery-record', params);
|
||||
}
|
||||
|
||||
/** Query session settlement records, only for USDC perpetual */
|
||||
getUSDCPerpetualSettlementHistory(
|
||||
params: UMPerpSettlementHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/unified/v3/private/settlement-record', params);
|
||||
}
|
||||
|
||||
/** -> Account API */
|
||||
|
||||
/** Query wallet balance */
|
||||
getBalances(coin?: string): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/unified/v3/private/account/wallet/balance', {
|
||||
coin,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Upgrade to unified margin account.
|
||||
* WARNING: This is currently not reversable!
|
||||
*/
|
||||
upgradeToUnifiedMargin(): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/unified/v3/private/account/upgrade-unified-account',
|
||||
);
|
||||
}
|
||||
|
||||
/** Query trading history */
|
||||
getTransactionLog(
|
||||
params: UMTransactionLogRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate(
|
||||
'/unified/v3/private/account/transaction-log',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Fund transfer between accounts (v2) */
|
||||
transferFunds(params: InternalTransferRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/asset/v1/private/transfer', params);
|
||||
}
|
||||
|
||||
/** Exchange Coins */
|
||||
getCoinExchangeHistory(
|
||||
params?: UMExchangeCoinsRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate(
|
||||
'/asset/v2/private/exchange/exchange-order-all',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Get Borrow History */
|
||||
getBorrowHistory(
|
||||
params?: UMBorrowHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate(
|
||||
'/unified/v3/private/account/borrow-history',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Get Borrow Rate */
|
||||
getBorrowRate(currency?: string): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate('/unified/v3/private/account/borrow-rate', {
|
||||
currency,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime> {
|
||||
return this.get('/v2/public/time');
|
||||
}
|
||||
}
|
||||
@@ -1,337 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import {
|
||||
APIResponseV3,
|
||||
APIResponseWithTime,
|
||||
USDCOptionsActiveOrdersRealtimeRequest,
|
||||
USDCOptionsActiveOrdersRequest,
|
||||
USDCOptionsCancelAllOrdersRequest,
|
||||
USDCOptionsCancelOrderRequest,
|
||||
USDCOptionsContractInfoRequest,
|
||||
USDCOptionsDeliveryHistoryRequest,
|
||||
USDCOptionsDeliveryPriceRequest,
|
||||
USDCOptionsHistoricOrdersRequest,
|
||||
USDCOptionsHistoricalVolatilityRequest,
|
||||
USDCOptionsModifyMMPRequest,
|
||||
USDCOptionsModifyOrderRequest,
|
||||
USDCOptionsOrderExecutionRequest,
|
||||
USDCOptionsOrderRequest,
|
||||
USDCOptionsPositionsInfoExpiryRequest,
|
||||
USDCOptionsRecentTradesRequest,
|
||||
USDCPositionsRequest,
|
||||
USDCTransactionLogRequest,
|
||||
} from './types';
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for USDC Option APIs
|
||||
*
|
||||
* @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
|
||||
* will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
|
||||
* Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
|
||||
*/
|
||||
export class USDCOptionClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
return REST_CLIENT_TYPE_ENUM.v3;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const res = await this.getServerTime();
|
||||
return Number(res.time_now);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** Query order book info. Each side has a depth of 25 orders. */
|
||||
getOrderBook(symbol: string): Promise<APIResponseV3<any>> {
|
||||
return this.get('/option/usdc/openapi/public/v1/order-book', { symbol });
|
||||
}
|
||||
|
||||
/** Fetch trading rules (such as min/max qty). Query for all if blank. */
|
||||
getContractInfo(
|
||||
params?: USDCOptionsContractInfoRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/option/usdc/openapi/public/v1/symbols', params);
|
||||
}
|
||||
|
||||
/** Get a symbol price/statistics ticker */
|
||||
getSymbolTicker(symbol: string): Promise<APIResponseV3<any>> {
|
||||
return this.get('/option/usdc/openapi/public/v1/tick', { symbol });
|
||||
}
|
||||
|
||||
/** Get delivery information */
|
||||
getDeliveryPrice(
|
||||
params?: USDCOptionsDeliveryPriceRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/option/usdc/openapi/public/v1/delivery-price', params);
|
||||
}
|
||||
|
||||
/** Returned records are Taker Buy in default. */
|
||||
getLast500Trades(
|
||||
params: USDCOptionsRecentTradesRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get(
|
||||
'/option/usdc/openapi/public/v1/query-trade-latest',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* The data is in hourly.
|
||||
* If time field is not passed, it returns the recent 1 hour data by default.
|
||||
* It could be any timeframe by inputting startTime & endTime, but it must satisfy [endTime - startTime] <= 30 days.
|
||||
* It returns all data in 2 years when startTime & endTime are not passed.
|
||||
* Both startTime & endTime entered together or both are left blank
|
||||
*/
|
||||
getHistoricalVolatility(
|
||||
params?: USDCOptionsHistoricalVolatilityRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get(
|
||||
'/option/usdc/openapi/public/v1/query-historical-volatility',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** -> Order API */
|
||||
|
||||
/**
|
||||
* Place an order using the USDC Derivatives Account.
|
||||
* The request status can be queried in real-time.
|
||||
* The response parameters must be queried through a query or a WebSocket response.
|
||||
*/
|
||||
submitOrder(params: USDCOptionsOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/place-order',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Each request supports a max. of four orders. The reduceOnly parameter should be separate and unique for each order in the request.
|
||||
*/
|
||||
batchSubmitOrders(
|
||||
orderRequest: USDCOptionsOrderRequest[],
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/batch-place-orders',
|
||||
{ orderRequest },
|
||||
);
|
||||
}
|
||||
|
||||
/** For Options, at least one of the three parameters — price, quantity or implied volatility — must be input. */
|
||||
modifyOrder(
|
||||
params: USDCOptionsModifyOrderRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/replace-order',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Each request supports a max. of four orders. The reduceOnly parameter should be separate and unique for each order in the request. */
|
||||
batchModifyOrders(
|
||||
replaceOrderRequest: USDCOptionsModifyOrderRequest[],
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/batch-replace-orders',
|
||||
{ replaceOrderRequest },
|
||||
);
|
||||
}
|
||||
|
||||
/** Cancel order */
|
||||
cancelOrder(
|
||||
params: USDCOptionsCancelOrderRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/cancel-order',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Batch cancel orders */
|
||||
batchCancelOrders(
|
||||
cancelRequest: USDCOptionsCancelOrderRequest[],
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/batch-cancel-orders',
|
||||
{ cancelRequest },
|
||||
);
|
||||
}
|
||||
|
||||
/** This is used to cancel all active orders. The real-time response indicates whether the request is successful, depending on retCode. */
|
||||
cancelActiveOrders(
|
||||
params?: USDCOptionsCancelAllOrdersRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/cancel-all',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Query Unfilled/Partially Filled Orders(real-time), up to last 7 days of partially filled/unfilled orders */
|
||||
getActiveRealtimeOrders(
|
||||
params?: USDCOptionsActiveOrdersRealtimeRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate(
|
||||
'/option/usdc/openapi/private/v1/trade/query-active-orders',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Query Unfilled/Partially Filled Orders */
|
||||
getActiveOrders(
|
||||
params: USDCOptionsActiveOrdersRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-active-orders',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Query order history. The endpoint only supports up to 30 days of queried records */
|
||||
getHistoricOrders(
|
||||
params: USDCOptionsHistoricOrdersRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-order-history',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query trade history.
|
||||
* The endpoint only supports up to 30 days of queried records.
|
||||
* An error will be returned if startTime is more than 30 days.
|
||||
*/
|
||||
getOrderExecutionHistory(
|
||||
params: USDCOptionsOrderExecutionRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/execution-list',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** -> Account API */
|
||||
|
||||
/** The endpoint only supports up to 30 days of queried records. An error will be returned if startTime is more than 30 days. */
|
||||
getTransactionLog(
|
||||
params: USDCTransactionLogRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-transaction-log',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Wallet info for USDC account. */
|
||||
getBalances(): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-wallet-balance',
|
||||
);
|
||||
}
|
||||
|
||||
/** Asset Info */
|
||||
getAssetInfo(baseCoin?: string): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-asset-info',
|
||||
{ baseCoin },
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* If USDC derivatives account balance is greater than X, you can open PORTFOLIO_MARGIN,
|
||||
* and if it is less than Y, it will automatically close PORTFOLIO_MARGIN and change back to REGULAR_MARGIN.
|
||||
* X and Y will be adjusted according to operational requirements.
|
||||
* Rest API returns the result of checking prerequisites. You could get the real status of margin mode change by subscribing margin mode.
|
||||
*/
|
||||
setMarginMode(
|
||||
newMarginMode: 'REGULAR_MARGIN' | 'PORTFOLIO_MARGIN',
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/private/asset/account/setMarginMode',
|
||||
{ setMarginMode: newMarginMode },
|
||||
);
|
||||
}
|
||||
|
||||
/** Query margin mode for USDC account. */
|
||||
getMarginMode(): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-margin-info',
|
||||
);
|
||||
}
|
||||
|
||||
/** -> Positions API */
|
||||
|
||||
/** Query my positions */
|
||||
getPositions(params: USDCPositionsRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-position',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Query Delivery History */
|
||||
getDeliveryHistory(
|
||||
params: USDCOptionsDeliveryHistoryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-delivery-list',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Query Positions Info Upon Expiry */
|
||||
getPositionsInfoUponExpiry(
|
||||
params?: USDCOptionsPositionsInfoExpiryRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-position-exp-date',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** -> Market Maker Protection */
|
||||
|
||||
/** modifyMMP */
|
||||
modifyMMP(params: USDCOptionsModifyMMPRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/mmp-modify',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** resetMMP */
|
||||
resetMMP(currency: string): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/option/usdc/openapi/private/v1/mmp-reset', {
|
||||
currency,
|
||||
});
|
||||
}
|
||||
|
||||
/** queryMMPState */
|
||||
queryMMPState(baseCoin: string): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/option/usdc/openapi/private/v1/get-mmp-state', {
|
||||
baseCoin,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime> {
|
||||
return this.get('/v2/public/time');
|
||||
}
|
||||
}
|
||||
@@ -1,320 +0,0 @@
|
||||
/* eslint-disable max-len */
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import {
|
||||
APIResponseV3,
|
||||
APIResponseWithTime,
|
||||
SymbolLimitParam,
|
||||
SymbolPeriodLimitParam,
|
||||
USDCKlineRequest,
|
||||
USDCLast500TradesRequest,
|
||||
USDCOpenInterestRequest,
|
||||
USDCOrderFilter,
|
||||
USDCPerpActiveOrdersRequest,
|
||||
USDCPerpCancelOrderRequest,
|
||||
USDCPerpHistoricOrdersRequest,
|
||||
USDCPerpModifyOrderRequest,
|
||||
USDCPerpOrderRequest,
|
||||
USDCPositionsRequest,
|
||||
USDCSymbolDirectionLimit,
|
||||
USDCSymbolDirectionLimitCursor,
|
||||
USDCTransactionLogRequest,
|
||||
} from './types';
|
||||
import { REST_CLIENT_TYPE_ENUM } from './util';
|
||||
import BaseRestClient from './util/BaseRestClient';
|
||||
|
||||
/**
|
||||
* REST API client for USDC Perpetual APIs
|
||||
*
|
||||
* @deprecated WARNING: V1/V2 private endpoints (Rest API & Websocket Stream) for mainnet
|
||||
* will be switched off gradually from 30 Oct 2023 UTC, so they are not promised a stability.
|
||||
* Please note that you are at your own risk of using old endpoints going forward, and please move to V5 ASAP.
|
||||
*/
|
||||
export class USDCPerpetualClient extends BaseRestClient {
|
||||
getClientType() {
|
||||
// Follows the same authentication mechanism as other v3 APIs (e.g. USDC)
|
||||
return REST_CLIENT_TYPE_ENUM.v3;
|
||||
}
|
||||
|
||||
async fetchServerTime(): Promise<number> {
|
||||
const res = await this.getServerTime();
|
||||
return Number(res.time_now);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Market Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getOrderBook(symbol: string): Promise<APIResponseV3<any>> {
|
||||
return this.get('/perpetual/usdc/openapi/public/v1/order-book', { symbol });
|
||||
}
|
||||
|
||||
/** Fetch trading rules (such as min/max qty). Query for all if blank. */
|
||||
getContractInfo(
|
||||
params?: USDCSymbolDirectionLimit,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/perpetual/usdc/openapi/public/v1/symbols', params);
|
||||
}
|
||||
|
||||
/** Get a symbol price/statistics ticker */
|
||||
getSymbolTicker(symbol: string): Promise<APIResponseV3<any>> {
|
||||
return this.get('/perpetual/usdc/openapi/public/v1/tick', { symbol });
|
||||
}
|
||||
|
||||
getCandles(params: USDCKlineRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get('/perpetual/usdc/openapi/public/v1/kline/list', params);
|
||||
}
|
||||
|
||||
getMarkPrice(params: USDCKlineRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get(
|
||||
'/perpetual/usdc/openapi/public/v1/mark-price-kline',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getIndexPrice(params: USDCKlineRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get(
|
||||
'/perpetual/usdc/openapi/public/v1/index-price-kline',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getIndexPremium(params: USDCKlineRequest): Promise<APIResponseV3<any>> {
|
||||
return this.get(
|
||||
'/perpetual/usdc/openapi/public/v1/premium-index-kline',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
getOpenInterest(
|
||||
params: USDCOpenInterestRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/perpetual/usdc/openapi/public/v1/open-interest', params);
|
||||
}
|
||||
|
||||
getLargeOrders(
|
||||
params: SymbolLimitParam<string>,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/perpetual/usdc/openapi/public/v1/big-deal', params);
|
||||
}
|
||||
|
||||
getLongShortRatio(
|
||||
params: SymbolPeriodLimitParam<string>,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get('/perpetual/usdc/openapi/public/v1/account-ratio', params);
|
||||
}
|
||||
|
||||
getLast500Trades(
|
||||
params: USDCLast500TradesRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.get(
|
||||
'/option/usdc/openapi/public/v1/query-trade-latest',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Account Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
/** -> Order API */
|
||||
|
||||
/**
|
||||
* Place an order using the USDC Derivatives Account.
|
||||
* The request status can be queried in real-time.
|
||||
* The response parameters must be queried through a query or a WebSocket response.
|
||||
*/
|
||||
submitOrder(params: USDCPerpOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/perpetual/usdc/openapi/private/v1/place-order',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Active order parameters (such as quantity, price) and stop order parameters cannot be modified in one request at the same time.
|
||||
* Please request modification separately.
|
||||
*/
|
||||
modifyOrder(params: USDCPerpModifyOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/perpetual/usdc/openapi/private/v1/replace-order',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Cancel order */
|
||||
cancelOrder(params: USDCPerpCancelOrderRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/perpetual/usdc/openapi/private/v1/cancel-order',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Cancel all active orders. The real-time response indicates whether the request is successful, depending on retCode. */
|
||||
cancelActiveOrders(
|
||||
symbol: string,
|
||||
orderFilter: USDCOrderFilter,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate('/perpetual/usdc/openapi/private/v1/cancel-all', {
|
||||
symbol,
|
||||
orderFilter,
|
||||
});
|
||||
}
|
||||
|
||||
/** Query Unfilled/Partially Filled Orders */
|
||||
getActiveOrders(
|
||||
params: USDCPerpActiveOrdersRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-active-orders',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Query order history. The endpoint only supports up to 30 days of queried records */
|
||||
getHistoricOrders(
|
||||
params: USDCPerpHistoricOrdersRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-order-history',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Query trade history. The endpoint only supports up to 30 days of queried records. An error will be returned if startTime is more than 30 days. */
|
||||
getOrderExecutionHistory(
|
||||
params: USDCPerpActiveOrdersRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/execution-list',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** -> Account API */
|
||||
|
||||
/** The endpoint only supports up to 30 days of queried records. An error will be returned if startTime is more than 30 days. */
|
||||
getTransactionLog(
|
||||
params: USDCTransactionLogRequest,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-transaction-log',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Wallet info for USDC account. */
|
||||
getBalances(): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-wallet-balance',
|
||||
);
|
||||
}
|
||||
|
||||
/** Asset Info */
|
||||
getAssetInfo(baseCoin?: string): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-asset-info',
|
||||
{ baseCoin },
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* If USDC derivatives account balance is greater than X, you can open PORTFOLIO_MARGIN,
|
||||
* and if it is less than Y, it will automatically close PORTFOLIO_MARGIN and change back to REGULAR_MARGIN.
|
||||
* X and Y will be adjusted according to operational requirements.
|
||||
* Rest API returns the result of checking prerequisites. You could get the real status of margin mode change by subscribing margin mode.
|
||||
*/
|
||||
setMarginMode(
|
||||
newMarginMode: 'REGULAR_MARGIN' | 'PORTFOLIO_MARGIN',
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/private/asset/account/setMarginMode',
|
||||
{ setMarginMode: newMarginMode },
|
||||
);
|
||||
}
|
||||
|
||||
/** Query margin mode for USDC account. */
|
||||
getMarginMode(): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-margin-info',
|
||||
);
|
||||
}
|
||||
|
||||
/** -> Positions API */
|
||||
|
||||
/** Query my positions */
|
||||
getPositions(params: USDCPositionsRequest): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/query-position',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** Only for REGULAR_MARGIN */
|
||||
setLeverage(symbol: string, leverage: string): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/perpetual/usdc/openapi/private/v1/position/leverage/save',
|
||||
{ symbol, leverage },
|
||||
);
|
||||
}
|
||||
|
||||
/** Query Settlement History */
|
||||
getSettlementHistory(
|
||||
params?: USDCSymbolDirectionLimitCursor,
|
||||
): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/option/usdc/openapi/private/v1/session-settlement',
|
||||
params,
|
||||
);
|
||||
}
|
||||
|
||||
/** -> Risk Limit API */
|
||||
|
||||
/** Query risk limit */
|
||||
getRiskLimit(symbol: string): Promise<APIResponseV3<any>> {
|
||||
return this.getPrivate(
|
||||
'/perpetual/usdc/openapi/public/v1/risk-limit/list',
|
||||
{
|
||||
symbol,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
/** Set risk limit */
|
||||
setRiskLimit(symbol: string, riskId: number): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/perpetual/usdc/openapi/private/v1/position/set-risk-limit',
|
||||
{ symbol, riskId },
|
||||
);
|
||||
}
|
||||
|
||||
/** -> Funding API */
|
||||
|
||||
/** Funding settlement occurs every 8 hours at 00:00 UTC, 08:00 UTC and 16:00 UTC. The current interval's fund fee settlement is based on the previous interval's fund rate. For example, at 16:00, the settlement is based on the fund rate generated at 8:00. The fund rate generated at 16:00 will be used at 0:00 the next day. */
|
||||
getLastFundingRate(symbol: string): Promise<APIResponseV3<any>> {
|
||||
return this.get('/perpetual/usdc/openapi/public/v1/prev-funding-rate', {
|
||||
symbol,
|
||||
});
|
||||
}
|
||||
|
||||
/** Get predicted funding rate and my predicted funding fee */
|
||||
getPredictedFundingRate(symbol: string): Promise<APIResponseV3<any>> {
|
||||
return this.postPrivate(
|
||||
'/perpetual/usdc/openapi/private/v1/predicted-funding',
|
||||
{ symbol },
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* API Data Endpoints
|
||||
*
|
||||
*/
|
||||
|
||||
getServerTime(): Promise<APIResponseWithTime> {
|
||||
return this.get('/v2/public/time');
|
||||
}
|
||||
}
|
||||
@@ -4,14 +4,13 @@ import https from 'https';
|
||||
|
||||
import {
|
||||
APIID,
|
||||
REST_CLIENT_TYPE_ENUM,
|
||||
RestClientOptions,
|
||||
RestClientType,
|
||||
getRestBaseUrl,
|
||||
parseRateLimitHeaders,
|
||||
serializeParams,
|
||||
} from './requestUtils';
|
||||
import { signMessage } from './node-support';
|
||||
import { SignAlgorithm, SignEncodeMethod, signMessage } from './webCryptoAPI';
|
||||
|
||||
const ENABLE_HTTP_TRACE =
|
||||
typeof process === 'object' &&
|
||||
@@ -51,8 +50,6 @@ interface SignedRequestContext {
|
||||
timestamp?: number;
|
||||
api_key?: string;
|
||||
recv_window?: number;
|
||||
// spot v1 is diff from the rest...
|
||||
recvWindow?: number;
|
||||
}
|
||||
|
||||
interface SignedRequest<T> {
|
||||
@@ -73,7 +70,7 @@ interface UnsignedRequest<T> {
|
||||
recvWindow?: number;
|
||||
}
|
||||
|
||||
type SignMethod = 'v2auth' | 'v5auth';
|
||||
type SignMethod = 'v5auth';
|
||||
|
||||
export default abstract class BaseRestClient {
|
||||
private timeOffset: number | null = null;
|
||||
@@ -165,10 +162,6 @@ export default abstract class BaseRestClient {
|
||||
}
|
||||
}
|
||||
|
||||
private isSpotV1Client() {
|
||||
return this.clientType === REST_CLIENT_TYPE_ENUM.spot;
|
||||
}
|
||||
|
||||
get(endpoint: string, params?: any) {
|
||||
return this._call('GET', endpoint, params, true);
|
||||
}
|
||||
@@ -264,58 +257,36 @@ export default abstract class BaseRestClient {
|
||||
};
|
||||
}
|
||||
|
||||
// USDC endpoints, unified margin and a few others use a different way of authenticating requests (headers instead of params)
|
||||
if (this.clientType === REST_CLIENT_TYPE_ENUM.v3) {
|
||||
const signResult = await this.prepareSignParams(
|
||||
method,
|
||||
'v5auth',
|
||||
params,
|
||||
isPublicApi,
|
||||
);
|
||||
|
||||
const headers: AxiosRequestConfig['headers'] = {
|
||||
'X-BAPI-SIGN-TYPE': 2,
|
||||
'X-BAPI-API-KEY': this.key,
|
||||
'X-BAPI-TIMESTAMP': signResult.timestamp,
|
||||
'X-BAPI-SIGN': signResult.sign,
|
||||
'X-BAPI-RECV-WINDOW': signResult.recvWindow,
|
||||
...options.headers,
|
||||
};
|
||||
|
||||
if (method === 'GET') {
|
||||
return {
|
||||
...options,
|
||||
headers,
|
||||
url: signResult.serializedParams
|
||||
? options.url + '?' + signResult.serializedParams
|
||||
: options.url,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
...options,
|
||||
headers,
|
||||
data: signResult.originalParams,
|
||||
};
|
||||
}
|
||||
|
||||
const signResult = await this.prepareSignParams(
|
||||
method,
|
||||
'v2auth',
|
||||
'v5auth',
|
||||
params,
|
||||
isPublicApi,
|
||||
);
|
||||
|
||||
if (method === 'GET' || this.isSpotV1Client()) {
|
||||
const headers: AxiosRequestConfig['headers'] = {
|
||||
'X-BAPI-SIGN-TYPE': 2,
|
||||
'X-BAPI-API-KEY': this.key,
|
||||
'X-BAPI-TIMESTAMP': signResult.timestamp,
|
||||
'X-BAPI-SIGN': signResult.sign,
|
||||
'X-BAPI-RECV-WINDOW': signResult.recvWindow,
|
||||
...options.headers,
|
||||
};
|
||||
|
||||
if (method === 'GET') {
|
||||
return {
|
||||
...options,
|
||||
params: signResult.paramsWithSign,
|
||||
headers,
|
||||
url: signResult.serializedParams
|
||||
? options.url + '?' + signResult.serializedParams
|
||||
: options.url,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
...options,
|
||||
data: signResult.paramsWithSign,
|
||||
headers,
|
||||
data: signResult.originalParams,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -397,6 +368,18 @@ export default abstract class BaseRestClient {
|
||||
};
|
||||
}
|
||||
|
||||
private async signMessage(
|
||||
paramsStr: string,
|
||||
secret: string,
|
||||
method: SignEncodeMethod,
|
||||
algorithm: SignAlgorithm,
|
||||
): Promise<string> {
|
||||
if (typeof this.options.customSignMessageFn === 'function') {
|
||||
return this.options.customSignMessageFn(paramsStr, secret);
|
||||
}
|
||||
return await signMessage(paramsStr, secret, method, algorithm);
|
||||
}
|
||||
|
||||
/**
|
||||
* @private sign request and set recv window
|
||||
*/
|
||||
@@ -444,7 +427,13 @@ export default abstract class BaseRestClient {
|
||||
|
||||
const paramsStr = timestamp + key + recvWindow + signRequestParams;
|
||||
|
||||
res.sign = await signMessage(paramsStr, this.secret);
|
||||
res.sign = await this.signMessage(
|
||||
paramsStr,
|
||||
this.secret,
|
||||
'hex',
|
||||
'SHA-256',
|
||||
);
|
||||
|
||||
res.serializedParams = signRequestParams;
|
||||
|
||||
// console.log('sign req: ', {
|
||||
@@ -454,39 +443,6 @@ export default abstract class BaseRestClient {
|
||||
return res;
|
||||
}
|
||||
|
||||
// spot/v2 derivatives
|
||||
if (signMethod === 'v2auth') {
|
||||
res.originalParams.api_key = key;
|
||||
res.originalParams.timestamp = timestamp;
|
||||
|
||||
// Optional, set to 5000 by default. Increase if timestamp/recv_window errors are seen.
|
||||
if (recvWindow) {
|
||||
if (this.isSpotV1Client()) {
|
||||
res.originalParams.recvWindow = recvWindow;
|
||||
} else {
|
||||
res.originalParams.recv_window = recvWindow;
|
||||
}
|
||||
}
|
||||
const sortProperties = true;
|
||||
const encodeValues = false;
|
||||
|
||||
res.serializedParams = serializeParams(
|
||||
res.originalParams,
|
||||
strictParamValidation,
|
||||
sortProperties,
|
||||
encodeValues,
|
||||
);
|
||||
res.sign = await signMessage(res.serializedParams, this.secret);
|
||||
|
||||
// @ts-ignore
|
||||
res.paramsWithSign = {
|
||||
...res.originalParams,
|
||||
sign: res.sign,
|
||||
};
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
|
||||
1333
src/util/BaseWSClient.ts
Normal file
1333
src/util/BaseWSClient.ts
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,160 +0,0 @@
|
||||
import WebSocket from 'isomorphic-ws';
|
||||
import { WsKey } from '../types';
|
||||
|
||||
import { DefaultLogger } from './logger';
|
||||
|
||||
export enum WsConnectionStateEnum {
|
||||
INITIAL = 0,
|
||||
CONNECTING = 1,
|
||||
CONNECTED = 2,
|
||||
CLOSING = 3,
|
||||
RECONNECTING = 4,
|
||||
// ERROR = 5,
|
||||
}
|
||||
/** A "topic" is always a string */
|
||||
type WsTopic = string;
|
||||
|
||||
/**
|
||||
* A "Set" is used to ensure we only subscribe to a topic once (tracking a list of unique topics we're expected to be connected to)
|
||||
* Note: Accurate duplicate tracking only works for plaintext topics.
|
||||
* E.g. JSON objects may not be seen as duplicates if keys are in different orders. If that's needed, check the FTX implementation.
|
||||
*/
|
||||
type WsTopicList = Set<WsTopic>;
|
||||
|
||||
interface WsStoredState {
|
||||
/** The currently active websocket connection */
|
||||
ws?: WebSocket;
|
||||
/** The current lifecycle state of the connection (enum) */
|
||||
connectionState?: WsConnectionStateEnum;
|
||||
/** A timer that will send an upstream heartbeat (ping) when it expires */
|
||||
activePingTimer?: ReturnType<typeof setTimeout> | undefined;
|
||||
/** A timer tracking that an upstream heartbeat was sent, expecting a reply before it expires */
|
||||
activePongTimer?: ReturnType<typeof setTimeout> | undefined;
|
||||
/** If a reconnection is in progress, this will have the timer for the delayed reconnect */
|
||||
activeReconnectTimer?: ReturnType<typeof setTimeout> | undefined;
|
||||
/**
|
||||
* All the topics we are expected to be subscribed to (and we automatically resubscribe to if the connection drops)
|
||||
*/
|
||||
subscribedTopics: WsTopicList;
|
||||
}
|
||||
|
||||
export default class WsStore {
|
||||
private wsState: Record<string, WsStoredState>;
|
||||
|
||||
private logger: typeof DefaultLogger;
|
||||
|
||||
constructor(logger: typeof DefaultLogger) {
|
||||
this.logger = logger || DefaultLogger;
|
||||
this.wsState = {};
|
||||
}
|
||||
|
||||
/** Get WS stored state for key, optionally create if missing */
|
||||
get(key: WsKey, createIfMissing?: true): WsStoredState;
|
||||
|
||||
get(key: WsKey, createIfMissing?: false): WsStoredState | undefined;
|
||||
|
||||
get(key: WsKey, createIfMissing?: boolean): WsStoredState | undefined {
|
||||
if (this.wsState[key]) {
|
||||
return this.wsState[key];
|
||||
}
|
||||
|
||||
if (createIfMissing) {
|
||||
return this.create(key);
|
||||
}
|
||||
}
|
||||
|
||||
getKeys(): WsKey[] {
|
||||
return Object.keys(this.wsState) as WsKey[];
|
||||
}
|
||||
|
||||
create(key: WsKey): WsStoredState | undefined {
|
||||
if (this.hasExistingActiveConnection(key)) {
|
||||
this.logger.warning(
|
||||
'WsStore setConnection() overwriting existing open connection: ',
|
||||
this.getWs(key),
|
||||
);
|
||||
}
|
||||
this.wsState[key] = {
|
||||
subscribedTopics: new Set(),
|
||||
connectionState: WsConnectionStateEnum.INITIAL,
|
||||
};
|
||||
return this.get(key);
|
||||
}
|
||||
|
||||
delete(key: WsKey) {
|
||||
if (this.hasExistingActiveConnection(key)) {
|
||||
const ws = this.getWs(key);
|
||||
this.logger.warning(
|
||||
'WsStore deleting state for connection still open: ',
|
||||
ws,
|
||||
);
|
||||
ws?.close();
|
||||
}
|
||||
delete this.wsState[key];
|
||||
}
|
||||
|
||||
/* connection websocket */
|
||||
|
||||
hasExistingActiveConnection(key: WsKey) {
|
||||
return this.get(key) && this.isWsOpen(key);
|
||||
}
|
||||
|
||||
getWs(key: WsKey): WebSocket | undefined {
|
||||
return this.get(key)?.ws;
|
||||
}
|
||||
|
||||
setWs(key: WsKey, wsConnection: WebSocket): WebSocket {
|
||||
if (this.isWsOpen(key)) {
|
||||
this.logger.warning(
|
||||
'WsStore setConnection() overwriting existing open connection: ',
|
||||
this.getWs(key),
|
||||
);
|
||||
}
|
||||
this.get(key, true)!.ws = wsConnection;
|
||||
return wsConnection;
|
||||
}
|
||||
|
||||
/* connection state */
|
||||
|
||||
isWsOpen(key: WsKey): boolean {
|
||||
const existingConnection = this.getWs(key);
|
||||
return (
|
||||
!!existingConnection &&
|
||||
existingConnection.readyState === existingConnection.OPEN
|
||||
);
|
||||
}
|
||||
|
||||
getConnectionState(key: WsKey): WsConnectionStateEnum {
|
||||
return this.get(key, true)!.connectionState!;
|
||||
}
|
||||
|
||||
setConnectionState(key: WsKey, state: WsConnectionStateEnum) {
|
||||
this.get(key, true)!.connectionState = state;
|
||||
}
|
||||
|
||||
isConnectionState(key: WsKey, state: WsConnectionStateEnum): boolean {
|
||||
return this.getConnectionState(key) === state;
|
||||
}
|
||||
|
||||
/* subscribed topics */
|
||||
|
||||
getTopics(key: WsKey): WsTopicList {
|
||||
return this.get(key, true).subscribedTopics;
|
||||
}
|
||||
|
||||
getTopicsByKey(): Record<string, WsTopicList> {
|
||||
const result = {};
|
||||
for (const refKey in this.wsState) {
|
||||
result[refKey] = this.getTopics(refKey as WsKey);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
addTopic(key: WsKey, topic: WsTopic) {
|
||||
return this.getTopics(key).add(topic);
|
||||
}
|
||||
|
||||
deleteTopic(key: WsKey, topic: WsTopic) {
|
||||
return this.getTopics(key).delete(topic);
|
||||
}
|
||||
}
|
||||
@@ -1,29 +0,0 @@
|
||||
export async function signMessage(
|
||||
message: string,
|
||||
secret: string,
|
||||
): Promise<string> {
|
||||
const encoder = new TextEncoder();
|
||||
// eslint-disable-next-line no-undef
|
||||
const key = await window.crypto.subtle.importKey(
|
||||
'raw',
|
||||
encoder.encode(secret),
|
||||
{ name: 'HMAC', hash: { name: 'SHA-256' } },
|
||||
false,
|
||||
['sign'],
|
||||
);
|
||||
|
||||
// eslint-disable-next-line no-undef
|
||||
const signature = await window.crypto.subtle.sign(
|
||||
'HMAC',
|
||||
key,
|
||||
encoder.encode(message),
|
||||
);
|
||||
|
||||
return Array.prototype.map
|
||||
.call(
|
||||
new Uint8Array(signature),
|
||||
(x: { toString: (arg0: number) => string }) =>
|
||||
('00' + x.toString(16)).slice(-2),
|
||||
)
|
||||
.join('');
|
||||
}
|
||||
@@ -2,5 +2,4 @@ export * from './BaseRestClient';
|
||||
export * from './logger';
|
||||
export * from './requestUtils';
|
||||
export * from './typeGuards';
|
||||
export * from './websocket-util';
|
||||
export * from './WsStore';
|
||||
export * from './websockets';
|
||||
|
||||
@@ -4,22 +4,13 @@
|
||||
export type LogParams = null | any;
|
||||
|
||||
export const DefaultLogger = {
|
||||
/** Ping/pong events and other raw messages that might be noisy */
|
||||
silly: (...params: LogParams): void => {
|
||||
// console.log(params);
|
||||
},
|
||||
debug: (...params: LogParams): void => {
|
||||
console.log(params);
|
||||
},
|
||||
notice: (...params: LogParams): void => {
|
||||
console.log(params);
|
||||
/** Ping/pong events and other raw messages that might be noisy. Enable this while troubleshooting. */
|
||||
trace: (..._params: LogParams): void => {
|
||||
// console.log(_params);
|
||||
},
|
||||
info: (...params: LogParams): void => {
|
||||
console.info(params);
|
||||
},
|
||||
warning: (...params: LogParams): void => {
|
||||
console.error(params);
|
||||
},
|
||||
error: (...params: LogParams): void => {
|
||||
console.error(params);
|
||||
},
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
import { createHmac } from 'crypto';
|
||||
|
||||
/** This is async because the browser version uses a promise (browser-support) */
|
||||
export async function signMessage(
|
||||
message: string,
|
||||
secret: string,
|
||||
): Promise<string> {
|
||||
return createHmac('sha256', secret).update(message).digest('hex');
|
||||
}
|
||||
@@ -1,7 +1,5 @@
|
||||
import { AxiosResponse } from 'axios';
|
||||
import { APIRateLimit } from '../types';
|
||||
import { WebsocketSucceededTopicSubscriptionConfirmationEvent } from '../types/ws-events/succeeded-topic-subscription-confirmation';
|
||||
import { WebsocketTopicSubscriptionConfirmationEvent } from '../types/ws-events/topic-subscription-confirmation';
|
||||
|
||||
export interface RestClientOptions {
|
||||
/** Your API key */
|
||||
@@ -74,6 +72,13 @@ export interface RestClientOptions {
|
||||
|
||||
/** Default: false. Enable to throw error if rate limit parser fails */
|
||||
throwOnFailedRateLimitParse?: boolean;
|
||||
|
||||
/**
|
||||
* Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
|
||||
*
|
||||
* Look in the examples folder for a demonstration on using node's createHmac instead.
|
||||
*/
|
||||
customSignMessageFn?: (message: string, secret: string) => Promise<string>;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -178,44 +183,13 @@ export function isWsPong(msg: any): boolean {
|
||||
);
|
||||
}
|
||||
|
||||
export function isTopicSubscriptionConfirmation(
|
||||
msg: unknown,
|
||||
): msg is WebsocketTopicSubscriptionConfirmationEvent {
|
||||
if (typeof msg !== 'object') {
|
||||
return false;
|
||||
}
|
||||
if (!msg) {
|
||||
return false;
|
||||
}
|
||||
if (typeof msg['op'] !== 'string') {
|
||||
return false;
|
||||
}
|
||||
if (msg['op'] !== 'subscribe') {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
export function isTopicSubscriptionSuccess(
|
||||
msg: unknown,
|
||||
): msg is WebsocketSucceededTopicSubscriptionConfirmationEvent {
|
||||
if (!isTopicSubscriptionConfirmation(msg)) return false;
|
||||
return msg.success === true;
|
||||
}
|
||||
|
||||
export const APIID = 'bybitapinode';
|
||||
|
||||
/**
|
||||
* Used to switch how authentication/requests work under the hood (primarily for SPOT since it's different there)
|
||||
*/
|
||||
export const REST_CLIENT_TYPE_ENUM = {
|
||||
accountAsset: 'accountAsset',
|
||||
inverse: 'inverse',
|
||||
inverseFutures: 'inverseFutures',
|
||||
linear: 'linear',
|
||||
spot: 'spot',
|
||||
v3: 'v3',
|
||||
v5: 'v5',
|
||||
} as const;
|
||||
|
||||
export type RestClientType =
|
||||
|
||||
@@ -2,12 +2,40 @@
|
||||
* Use type guards to narrow down types with minimal efforts.
|
||||
*/
|
||||
|
||||
import {
|
||||
WebsocketSucceededTopicSubscriptionConfirmationEvent,
|
||||
WebsocketTopicSubscriptionConfirmationEvent,
|
||||
} from '../types';
|
||||
import { WSAPIResponse, WS_API_Operations } from '../types/websockets/ws-api';
|
||||
import {
|
||||
WSAccountOrderEventV5,
|
||||
WSExecutionEventV5,
|
||||
WSOrderbookEventV5,
|
||||
WSPositionEventV5,
|
||||
} from '../types/websocket.events';
|
||||
} from '../types/websockets/ws-events';
|
||||
|
||||
export interface BybitEventV5<TData = unknown> {
|
||||
topic: string;
|
||||
type: string;
|
||||
ts: number;
|
||||
data: TData;
|
||||
wsKey: string;
|
||||
}
|
||||
|
||||
export function isWsEventV5<TEventData = unknown>(
|
||||
event: unknown,
|
||||
): event is BybitEventV5<TEventData> {
|
||||
if (
|
||||
typeof event !== 'object' ||
|
||||
!event ||
|
||||
typeof event['topic'] !== 'string' ||
|
||||
typeof event['type'] !== 'string'
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Type guard to detect a V5 orderbook event (delta & snapshots)
|
||||
@@ -92,3 +120,61 @@ export function isWsExecutionEventV5(
|
||||
|
||||
return event['topic'] === 'execution';
|
||||
}
|
||||
|
||||
export function neverGuard(x: never, msg: string): Error {
|
||||
return new Error(`Unhandled value exception "${x}", ${msg}`);
|
||||
}
|
||||
|
||||
export function isWSAPIResponse(
|
||||
msg: unknown,
|
||||
): msg is Omit<WSAPIResponse, 'wsKey'> {
|
||||
if (typeof msg !== 'object' || !msg) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (typeof msg['op'] !== 'string') {
|
||||
return false;
|
||||
}
|
||||
|
||||
return (WS_API_Operations as string[]).includes(msg['op']);
|
||||
}
|
||||
|
||||
export function isTopicSubscriptionSuccess(
|
||||
msg: unknown,
|
||||
): msg is WebsocketSucceededTopicSubscriptionConfirmationEvent {
|
||||
if (!isTopicSubscriptionConfirmation(msg)) return false;
|
||||
return msg.success === true;
|
||||
}
|
||||
|
||||
export function isTopicSubscriptionConfirmation(
|
||||
msg: unknown,
|
||||
): msg is WebsocketTopicSubscriptionConfirmationEvent {
|
||||
if (typeof msg !== 'object') {
|
||||
return false;
|
||||
}
|
||||
if (!msg) {
|
||||
return false;
|
||||
}
|
||||
if (typeof msg['op'] !== 'string') {
|
||||
return false;
|
||||
}
|
||||
if (msg['op'] !== 'subscribe') {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
export function isWsAllLiquidationEvent(
|
||||
event: unknown,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
): event is BybitEventV5<any[]> {
|
||||
if (!isWsEventV5(event)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (event['topic'].startsWith('allLiquidation')) {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
84
src/util/webCryptoAPI.ts
Normal file
84
src/util/webCryptoAPI.ts
Normal file
@@ -0,0 +1,84 @@
|
||||
import { neverGuard } from './typeGuards';
|
||||
|
||||
function bufferToB64(buffer: ArrayBuffer): string {
|
||||
let binary = '';
|
||||
const bytes = new Uint8Array(buffer);
|
||||
const len = bytes.byteLength;
|
||||
for (let i = 0; i < len; i++) {
|
||||
binary += String.fromCharCode(bytes[i]);
|
||||
}
|
||||
return globalThis.btoa(binary);
|
||||
}
|
||||
|
||||
export type SignEncodeMethod = 'hex' | 'base64';
|
||||
export type SignAlgorithm = 'SHA-256' | 'SHA-512';
|
||||
|
||||
/**
|
||||
* Similar to node crypto's `createHash()` function
|
||||
*/
|
||||
export async function hashMessage(
|
||||
message: string,
|
||||
method: SignEncodeMethod,
|
||||
algorithm: SignAlgorithm,
|
||||
): Promise<string> {
|
||||
const encoder = new TextEncoder();
|
||||
|
||||
const buffer = await globalThis.crypto.subtle.digest(
|
||||
algorithm,
|
||||
encoder.encode(message),
|
||||
);
|
||||
|
||||
switch (method) {
|
||||
case 'hex': {
|
||||
return Array.from(new Uint8Array(buffer))
|
||||
.map((byte) => byte.toString(16).padStart(2, '0'))
|
||||
.join('');
|
||||
}
|
||||
case 'base64': {
|
||||
return bufferToB64(buffer);
|
||||
}
|
||||
default: {
|
||||
throw neverGuard(method, `Unhandled sign method: "${method}"`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sign a message, with a secret, using the Web Crypto API
|
||||
*/
|
||||
export async function signMessage(
|
||||
message: string,
|
||||
secret: string,
|
||||
method: SignEncodeMethod,
|
||||
algorithm: SignAlgorithm,
|
||||
): Promise<string> {
|
||||
const encoder = new TextEncoder();
|
||||
|
||||
const key = await globalThis.crypto.subtle.importKey(
|
||||
'raw',
|
||||
encoder.encode(secret),
|
||||
{ name: 'HMAC', hash: algorithm },
|
||||
false,
|
||||
['sign'],
|
||||
);
|
||||
|
||||
const buffer = await globalThis.crypto.subtle.sign(
|
||||
'HMAC',
|
||||
key,
|
||||
encoder.encode(message),
|
||||
);
|
||||
|
||||
switch (method) {
|
||||
case 'hex': {
|
||||
return Array.from(new Uint8Array(buffer))
|
||||
.map((byte) => byte.toString(16).padStart(2, '0'))
|
||||
.join('');
|
||||
}
|
||||
case 'base64': {
|
||||
return bufferToB64(buffer);
|
||||
}
|
||||
default: {
|
||||
throw neverGuard(method, `Unhandled sign method: "${method}"`);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,571 +0,0 @@
|
||||
import WebSocket from 'isomorphic-ws';
|
||||
|
||||
import { APIMarket, CategoryV5, WebsocketClientOptions, WsKey } from '../types';
|
||||
import { DefaultLogger } from './logger';
|
||||
|
||||
interface NetworkMapV3 {
|
||||
livenet: string;
|
||||
livenet2?: string;
|
||||
testnet: string;
|
||||
testnet2?: string;
|
||||
}
|
||||
|
||||
type PublicPrivateNetwork = 'public' | 'private';
|
||||
|
||||
/**
|
||||
* The following WS keys are logical.
|
||||
*
|
||||
* They're not directly used as a market. They usually have one private endpoint but many public ones,
|
||||
* so they need a bit of extra handling for seamless messaging between endpoints.
|
||||
*
|
||||
* For the unified keys, the "split" happens using the symbol. Symbols suffixed with USDT are obviously USDT topics.
|
||||
* For the v5 endpoints, the subscribe/unsubscribe call must specify the category the subscription should route to.
|
||||
*/
|
||||
type PublicOnlyWsKeys =
|
||||
| 'unifiedPerpUSDT'
|
||||
| 'unifiedPerpUSDC'
|
||||
| 'v5SpotPublic'
|
||||
| 'v5LinearPublic'
|
||||
| 'v5InversePublic'
|
||||
| 'v5OptionPublic';
|
||||
|
||||
export const WS_BASE_URL_MAP: Record<
|
||||
APIMarket,
|
||||
Record<PublicPrivateNetwork, NetworkMapV3>
|
||||
> &
|
||||
Record<PublicOnlyWsKeys, Record<'public', NetworkMapV3>> = {
|
||||
inverse: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/realtime',
|
||||
testnet: 'wss://stream-testnet.bybit.com/realtime',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/realtime',
|
||||
testnet: 'wss://stream-testnet.bybit.com/realtime',
|
||||
},
|
||||
},
|
||||
linear: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/realtime_public',
|
||||
livenet2: 'wss://stream.bytick.com/realtime_public',
|
||||
testnet: 'wss://stream-testnet.bybit.com/realtime_public',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/realtime_private',
|
||||
livenet2: 'wss://stream.bytick.com/realtime_private',
|
||||
testnet: 'wss://stream-testnet.bybit.com/realtime_private',
|
||||
},
|
||||
},
|
||||
spot: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/spot/quote/ws/v1',
|
||||
livenet2: 'wss://stream.bybit.com/spot/quote/ws/v2',
|
||||
testnet: 'wss://stream-testnet.bybit.com/spot/quote/ws/v1',
|
||||
testnet2: 'wss://stream-testnet.bybit.com/spot/quote/ws/v2',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/spot/ws',
|
||||
testnet: 'wss://stream-testnet.bybit.com/spot/ws',
|
||||
},
|
||||
},
|
||||
spotv3: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/spot/public/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/spot/public/v3',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/spot/private/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/spot/private/v3',
|
||||
},
|
||||
},
|
||||
usdcOption: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/trade/option/usdc/public/v1',
|
||||
livenet2: 'wss://stream.bytick.com/trade/option/usdc/public/v1',
|
||||
testnet: 'wss://stream-testnet.bybit.com/trade/option/usdc/public/v1',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/trade/option/usdc/private/v1',
|
||||
livenet2: 'wss://stream.bytick.com/trade/option/usdc/private/v1',
|
||||
testnet: 'wss://stream-testnet.bybit.com/trade/option/usdc/private/v1',
|
||||
},
|
||||
},
|
||||
usdcPerp: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/perpetual/ws/v1/realtime_public',
|
||||
livenet2: 'wss://stream.bytick.com/perpetual/ws/v1/realtime_public',
|
||||
testnet: 'wss://stream-testnet.bybit.com/perpetual/ws/v1/realtime_public',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/trade/option/usdc/private/v1',
|
||||
livenet2: 'wss://stream.bytick.com/trade/option/usdc/private/v1',
|
||||
testnet: 'wss://stream-testnet.bybit.com/trade/option/usdc/private/v1',
|
||||
},
|
||||
},
|
||||
unifiedOption: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/option/usdc/public/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/option/usdc/public/v3',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/unified/private/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/unified/private/v3',
|
||||
},
|
||||
},
|
||||
unifiedPerp: {
|
||||
public: {
|
||||
livenet: 'useBaseSpecificEndpoint',
|
||||
testnet: 'useBaseSpecificEndpoint',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/unified/private/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/unified/private/v3',
|
||||
},
|
||||
},
|
||||
unifiedPerpUSDT: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/contract/usdt/public/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/contract/usdt/public/v3',
|
||||
},
|
||||
},
|
||||
unifiedPerpUSDC: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/contract/usdc/public/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/contract/usdc/public/v3',
|
||||
},
|
||||
},
|
||||
contractUSDT: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/contract/usdt/public/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/contract/usdt/public/v3',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/contract/private/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/contract/private/v3',
|
||||
},
|
||||
},
|
||||
contractInverse: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/contract/inverse/public/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/contract/inverse/public/v3',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/contract/private/v3',
|
||||
testnet: 'wss://stream-testnet.bybit.com/contract/private/v3',
|
||||
},
|
||||
},
|
||||
v5: {
|
||||
public: {
|
||||
livenet: 'public topics are routed internally via the public wskeys',
|
||||
testnet: 'public topics are routed internally via the public wskeys',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/v5/private',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/private',
|
||||
},
|
||||
},
|
||||
v5SpotPublic: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/v5/public/spot',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/public/spot',
|
||||
},
|
||||
},
|
||||
v5LinearPublic: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/v5/public/linear',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/public/linear',
|
||||
},
|
||||
},
|
||||
v5InversePublic: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/v5/public/inverse',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/public/inverse',
|
||||
},
|
||||
},
|
||||
v5OptionPublic: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/v5/public/option',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/public/option',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export const WS_KEY_MAP = {
|
||||
inverse: 'inverse',
|
||||
linearPrivate: 'linearPrivate',
|
||||
linearPublic: 'linearPublic',
|
||||
spotPrivate: 'spotPrivate',
|
||||
spotPublic: 'spotPublic',
|
||||
spotV3Private: 'spotV3Private',
|
||||
spotV3Public: 'spotV3Public',
|
||||
usdcOptionPrivate: 'usdcOptionPrivate',
|
||||
usdcOptionPublic: 'usdcOptionPublic',
|
||||
usdcPerpPrivate: 'usdcPerpPrivate',
|
||||
usdcPerpPublic: 'usdcPerpPublic',
|
||||
unifiedPrivate: 'unifiedPrivate',
|
||||
unifiedOptionPublic: 'unifiedOptionPublic',
|
||||
unifiedPerpUSDTPublic: 'unifiedPerpUSDTPublic',
|
||||
unifiedPerpUSDCPublic: 'unifiedPerpUSDCPublic',
|
||||
contractUSDTPublic: 'contractUSDTPublic',
|
||||
contractUSDTPrivate: 'contractUSDTPrivate',
|
||||
contractInversePublic: 'contractInversePublic',
|
||||
contractInversePrivate: 'contractInversePrivate',
|
||||
v5SpotPublic: 'v5SpotPublic',
|
||||
v5LinearPublic: 'v5LinearPublic',
|
||||
v5InversePublic: 'v5InversePublic',
|
||||
v5OptionPublic: 'v5OptionPublic',
|
||||
v5Private: 'v5Private',
|
||||
} as const;
|
||||
|
||||
export const WS_AUTH_ON_CONNECT_KEYS: WsKey[] = [
|
||||
WS_KEY_MAP.spotV3Private,
|
||||
WS_KEY_MAP.usdcOptionPrivate,
|
||||
WS_KEY_MAP.usdcPerpPrivate,
|
||||
WS_KEY_MAP.unifiedPrivate,
|
||||
WS_KEY_MAP.contractUSDTPrivate,
|
||||
WS_KEY_MAP.contractInversePrivate,
|
||||
WS_KEY_MAP.v5Private,
|
||||
];
|
||||
|
||||
export const PUBLIC_WS_KEYS = [
|
||||
WS_KEY_MAP.linearPublic,
|
||||
WS_KEY_MAP.spotPublic,
|
||||
WS_KEY_MAP.spotV3Public,
|
||||
WS_KEY_MAP.usdcOptionPublic,
|
||||
WS_KEY_MAP.usdcPerpPublic,
|
||||
WS_KEY_MAP.unifiedOptionPublic,
|
||||
WS_KEY_MAP.unifiedPerpUSDTPublic,
|
||||
WS_KEY_MAP.unifiedPerpUSDCPublic,
|
||||
WS_KEY_MAP.contractUSDTPublic,
|
||||
WS_KEY_MAP.contractInversePublic,
|
||||
WS_KEY_MAP.v5SpotPublic,
|
||||
WS_KEY_MAP.v5LinearPublic,
|
||||
WS_KEY_MAP.v5InversePublic,
|
||||
WS_KEY_MAP.v5OptionPublic,
|
||||
] as string[];
|
||||
|
||||
/** Used to automatically determine if a sub request should be to the public or private ws (when there's two) */
|
||||
const PRIVATE_TOPICS = [
|
||||
'stop_order',
|
||||
'outboundAccountInfo',
|
||||
'executionReport',
|
||||
'ticketInfo',
|
||||
// copy trading apis
|
||||
'copyTradePosition',
|
||||
'copyTradeOrder',
|
||||
'copyTradeExecution',
|
||||
'copyTradeWallet',
|
||||
// usdc options
|
||||
'user.openapi.option.position',
|
||||
'user.openapi.option.trade',
|
||||
'user.order',
|
||||
'user.openapi.option.order',
|
||||
'user.service',
|
||||
'user.openapi.greeks',
|
||||
'user.mmp.event',
|
||||
// usdc perps
|
||||
'user.openapi.perp.position',
|
||||
'user.openapi.perp.trade',
|
||||
'user.openapi.perp.order',
|
||||
'user.service',
|
||||
// unified margin
|
||||
'user.position.unifiedAccount',
|
||||
'user.execution.unifiedAccount',
|
||||
'user.order.unifiedAccount',
|
||||
'user.wallet.unifiedAccount',
|
||||
'user.greeks.unifiedAccount',
|
||||
// contract v3
|
||||
'user.position.contractAccount',
|
||||
'user.execution.contractAccount',
|
||||
'user.order.contractAccount',
|
||||
'user.wallet.contractAccount',
|
||||
// v5
|
||||
'position',
|
||||
'execution',
|
||||
'order',
|
||||
'wallet',
|
||||
'greeks',
|
||||
];
|
||||
|
||||
export function isPrivateWsTopic(topic: string): boolean {
|
||||
return PRIVATE_TOPICS.includes(topic);
|
||||
}
|
||||
|
||||
export function getWsKeyForTopic(
|
||||
market: APIMarket,
|
||||
topic: string,
|
||||
isPrivate?: boolean,
|
||||
category?: CategoryV5,
|
||||
): WsKey {
|
||||
const isPrivateTopic = isPrivate === true || PRIVATE_TOPICS.includes(topic);
|
||||
switch (market) {
|
||||
case 'inverse': {
|
||||
return WS_KEY_MAP.inverse;
|
||||
}
|
||||
case 'linear': {
|
||||
return isPrivateTopic
|
||||
? WS_KEY_MAP.linearPrivate
|
||||
: WS_KEY_MAP.linearPublic;
|
||||
}
|
||||
case 'spot': {
|
||||
return isPrivateTopic ? WS_KEY_MAP.spotPrivate : WS_KEY_MAP.spotPublic;
|
||||
}
|
||||
case 'spotv3': {
|
||||
return isPrivateTopic
|
||||
? WS_KEY_MAP.spotV3Private
|
||||
: WS_KEY_MAP.spotV3Public;
|
||||
}
|
||||
case 'usdcOption': {
|
||||
return isPrivateTopic
|
||||
? WS_KEY_MAP.usdcOptionPrivate
|
||||
: WS_KEY_MAP.usdcOptionPublic;
|
||||
}
|
||||
case 'usdcPerp': {
|
||||
return isPrivateTopic
|
||||
? WS_KEY_MAP.usdcPerpPrivate
|
||||
: WS_KEY_MAP.usdcPerpPublic;
|
||||
}
|
||||
case 'unifiedOption': {
|
||||
return isPrivateTopic
|
||||
? WS_KEY_MAP.unifiedPrivate
|
||||
: WS_KEY_MAP.unifiedOptionPublic;
|
||||
}
|
||||
case 'unifiedPerp': {
|
||||
if (isPrivateTopic) {
|
||||
return WS_KEY_MAP.unifiedPrivate;
|
||||
}
|
||||
|
||||
const upperTopic = topic.toUpperCase();
|
||||
if (upperTopic.indexOf('USDT') !== -1) {
|
||||
return WS_KEY_MAP.unifiedPerpUSDTPublic;
|
||||
}
|
||||
|
||||
if (
|
||||
upperTopic.indexOf('USDC') !== -1 ||
|
||||
upperTopic.indexOf('PERP') !== -1
|
||||
) {
|
||||
return WS_KEY_MAP.unifiedPerpUSDCPublic;
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
`Failed to determine wskey for unified perps topic: "${topic}"`,
|
||||
);
|
||||
}
|
||||
case 'contractInverse': {
|
||||
return isPrivateTopic
|
||||
? WS_KEY_MAP.contractInversePrivate
|
||||
: WS_KEY_MAP.contractInversePublic;
|
||||
}
|
||||
case 'contractUSDT': {
|
||||
return isPrivateTopic
|
||||
? WS_KEY_MAP.contractUSDTPrivate
|
||||
: WS_KEY_MAP.contractUSDTPublic;
|
||||
}
|
||||
case 'v5': {
|
||||
if (isPrivateTopic) {
|
||||
return WS_KEY_MAP.v5Private;
|
||||
}
|
||||
|
||||
switch (category) {
|
||||
case 'spot': {
|
||||
return WS_KEY_MAP.v5SpotPublic;
|
||||
}
|
||||
case 'linear': {
|
||||
return WS_KEY_MAP.v5LinearPublic;
|
||||
}
|
||||
case 'inverse': {
|
||||
return WS_KEY_MAP.v5InversePublic;
|
||||
}
|
||||
case 'option': {
|
||||
return WS_KEY_MAP.v5OptionPublic;
|
||||
}
|
||||
case undefined: {
|
||||
throw new Error('Category cannot be undefined');
|
||||
}
|
||||
default: {
|
||||
throw neverGuard(
|
||||
category,
|
||||
'getWsKeyForTopic(v5): Unhandled v5 category',
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
default: {
|
||||
throw neverGuard(market, 'getWsKeyForTopic(): Unhandled market');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function getWsUrl(
|
||||
wsKey: WsKey,
|
||||
wsClientOptions: WebsocketClientOptions,
|
||||
logger: typeof DefaultLogger,
|
||||
): string {
|
||||
const wsUrl = wsClientOptions.wsUrl;
|
||||
if (wsUrl) {
|
||||
return wsUrl;
|
||||
}
|
||||
|
||||
const isDemoTrading = wsClientOptions.demoTrading;
|
||||
const isTestnet = wsClientOptions.testnet;
|
||||
const networkKey = isTestnet ? 'testnet' : 'livenet';
|
||||
|
||||
switch (wsKey) {
|
||||
case WS_KEY_MAP.linearPublic: {
|
||||
return WS_BASE_URL_MAP.linear.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.linearPrivate: {
|
||||
return WS_BASE_URL_MAP.linear.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.spotPublic: {
|
||||
return WS_BASE_URL_MAP.spot.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.spotPrivate: {
|
||||
return WS_BASE_URL_MAP.spot.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.spotV3Public: {
|
||||
return WS_BASE_URL_MAP.spotv3.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.spotV3Private: {
|
||||
return WS_BASE_URL_MAP.spotv3.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.inverse: {
|
||||
// private and public are on the same WS connection
|
||||
return WS_BASE_URL_MAP.inverse.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.usdcOptionPublic: {
|
||||
return WS_BASE_URL_MAP.usdcOption.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.usdcOptionPrivate: {
|
||||
return WS_BASE_URL_MAP.usdcOption.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.usdcPerpPublic: {
|
||||
return WS_BASE_URL_MAP.usdcPerp.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.usdcPerpPrivate: {
|
||||
return WS_BASE_URL_MAP.usdcPerp.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.unifiedOptionPublic: {
|
||||
return WS_BASE_URL_MAP.unifiedOption.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.unifiedPerpUSDTPublic: {
|
||||
return WS_BASE_URL_MAP.unifiedPerpUSDT.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.unifiedPerpUSDCPublic: {
|
||||
return WS_BASE_URL_MAP.unifiedPerpUSDC.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.unifiedPrivate: {
|
||||
return WS_BASE_URL_MAP.unifiedPerp.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.contractInversePrivate: {
|
||||
return WS_BASE_URL_MAP.contractInverse.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.contractInversePublic: {
|
||||
return WS_BASE_URL_MAP.contractInverse.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.contractUSDTPrivate: {
|
||||
return WS_BASE_URL_MAP.contractUSDT.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.contractUSDTPublic: {
|
||||
return WS_BASE_URL_MAP.contractUSDT.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5Private: {
|
||||
// https://bybit-exchange.github.io/docs/v5/demo
|
||||
if (isDemoTrading) {
|
||||
return 'wss://stream-demo.bybit.com/v5/private';
|
||||
}
|
||||
|
||||
return WS_BASE_URL_MAP.v5.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5SpotPublic: {
|
||||
return WS_BASE_URL_MAP.v5SpotPublic.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5LinearPublic: {
|
||||
return WS_BASE_URL_MAP.v5LinearPublic.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5InversePublic: {
|
||||
return WS_BASE_URL_MAP.v5InversePublic.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5OptionPublic: {
|
||||
return WS_BASE_URL_MAP.v5OptionPublic.public[networkKey];
|
||||
}
|
||||
default: {
|
||||
logger.error('getWsUrl(): Unhandled wsKey: ', {
|
||||
category: 'bybit-ws',
|
||||
wsKey,
|
||||
});
|
||||
throw neverGuard(wsKey, 'getWsUrl(): Unhandled wsKey');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function getMaxTopicsPerSubscribeEvent(
|
||||
market: APIMarket,
|
||||
wsKey: WsKey,
|
||||
): number | null {
|
||||
const topicsPerEventSpot = 10;
|
||||
switch (market) {
|
||||
case 'inverse':
|
||||
case 'linear':
|
||||
case 'usdcOption':
|
||||
case 'usdcPerp':
|
||||
case 'unifiedOption':
|
||||
case 'unifiedPerp':
|
||||
case 'spot':
|
||||
case 'contractInverse':
|
||||
case 'contractUSDT':
|
||||
case 'v5': {
|
||||
if (wsKey === WS_KEY_MAP.v5SpotPublic) {
|
||||
return topicsPerEventSpot;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
case 'spotv3': {
|
||||
return topicsPerEventSpot;
|
||||
}
|
||||
default: {
|
||||
throw neverGuard(market, 'getWsKeyForTopic(): Unhandled market');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function getUsdcWsKeyForTopic(
|
||||
topic: string,
|
||||
subGroup: 'option' | 'perp',
|
||||
): WsKey {
|
||||
const isPrivateTopic = PRIVATE_TOPICS.includes(topic);
|
||||
if (subGroup === 'option') {
|
||||
return isPrivateTopic
|
||||
? WS_KEY_MAP.usdcOptionPrivate
|
||||
: WS_KEY_MAP.usdcOptionPublic;
|
||||
}
|
||||
return isPrivateTopic
|
||||
? WS_KEY_MAP.usdcOptionPrivate
|
||||
: WS_KEY_MAP.usdcOptionPublic;
|
||||
// return isPrivateTopic
|
||||
// ? WS_KEY_MAP.usdcPerpPrivate
|
||||
// : WS_KEY_MAP.usdcPerpPublic;
|
||||
}
|
||||
|
||||
export const WS_ERROR_ENUM = {
|
||||
NOT_AUTHENTICATED_SPOT_V3: '-1004',
|
||||
API_ERROR_GENERIC: '10001',
|
||||
API_SIGN_AUTH_FAILED: '10003',
|
||||
USDC_OPTION_AUTH_FAILED: '3303006',
|
||||
};
|
||||
|
||||
export function neverGuard(x: never, msg: string): Error {
|
||||
return new Error(`Unhandled value exception "x", ${msg}`);
|
||||
}
|
||||
|
||||
/**
|
||||
* #305: ws.terminate() is undefined in browsers.
|
||||
* This only works in node.js, not in browsers.
|
||||
* Does nothing if `ws` is undefined.
|
||||
*/
|
||||
export function safeTerminateWs(ws?: WebSocket | unknown) {
|
||||
// #305: ws.terminate() undefined in browsers
|
||||
if (ws && typeof ws['terminate'] === 'function') {
|
||||
ws.terminate();
|
||||
}
|
||||
}
|
||||
409
src/util/websockets/WsStore.ts
Normal file
409
src/util/websockets/WsStore.ts
Normal file
@@ -0,0 +1,409 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import WebSocket from 'isomorphic-ws';
|
||||
|
||||
import { DefaultLogger } from '../logger';
|
||||
import {
|
||||
DeferredPromise,
|
||||
WSConnectedResult,
|
||||
WsConnectionStateEnum,
|
||||
WsStoredState,
|
||||
} from './WsStore.types';
|
||||
|
||||
/**
|
||||
* Simple comparison of two objects, only checks 1-level deep (nested objects won't match)
|
||||
*/
|
||||
export function isDeepObjectMatch(object1: unknown, object2: unknown): boolean {
|
||||
if (typeof object1 === 'string' && typeof object2 === 'string') {
|
||||
return object1 === object2;
|
||||
}
|
||||
|
||||
if (typeof object1 !== 'object' || typeof object2 !== 'object') {
|
||||
return false;
|
||||
}
|
||||
|
||||
for (const key in object1) {
|
||||
const value1 = (object1 as any)[key];
|
||||
const value2 = (object2 as any)[key];
|
||||
|
||||
if (value1 !== value2) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
export const DEFERRED_PROMISE_REF = {
|
||||
CONNECTION_IN_PROGRESS: 'CONNECTION_IN_PROGRESS',
|
||||
AUTHENTICATION_IN_PROGRESS: 'AUTHENTICATION_IN_PROGRESS',
|
||||
} as const;
|
||||
|
||||
type DeferredPromiseRef =
|
||||
(typeof DEFERRED_PROMISE_REF)[keyof typeof DEFERRED_PROMISE_REF];
|
||||
|
||||
export class WsStore<
|
||||
WsKey extends string,
|
||||
TWSTopicSubscribeEventArgs extends string | object,
|
||||
> {
|
||||
private wsState: Record<string, WsStoredState<TWSTopicSubscribeEventArgs>> =
|
||||
{};
|
||||
|
||||
private logger: typeof DefaultLogger;
|
||||
|
||||
constructor(logger: typeof DefaultLogger) {
|
||||
this.logger = logger || DefaultLogger;
|
||||
}
|
||||
|
||||
/** Get WS stored state for key, optionally create if missing */
|
||||
get(
|
||||
key: WsKey,
|
||||
createIfMissing?: true,
|
||||
): WsStoredState<TWSTopicSubscribeEventArgs>;
|
||||
|
||||
get(
|
||||
key: WsKey,
|
||||
createIfMissing?: false,
|
||||
): WsStoredState<TWSTopicSubscribeEventArgs> | undefined;
|
||||
|
||||
get(
|
||||
key: WsKey,
|
||||
createIfMissing?: boolean,
|
||||
): WsStoredState<TWSTopicSubscribeEventArgs> | undefined {
|
||||
if (this.wsState[key]) {
|
||||
return this.wsState[key];
|
||||
}
|
||||
|
||||
if (createIfMissing) {
|
||||
return this.create(key);
|
||||
}
|
||||
}
|
||||
|
||||
getKeys(): WsKey[] {
|
||||
return Object.keys(this.wsState) as WsKey[];
|
||||
}
|
||||
|
||||
create(key: WsKey): WsStoredState<TWSTopicSubscribeEventArgs> | undefined {
|
||||
if (this.hasExistingActiveConnection(key)) {
|
||||
this.logger.info(
|
||||
'WsStore setConnection() overwriting existing open connection: ',
|
||||
this.getWs(key),
|
||||
);
|
||||
}
|
||||
this.wsState[key] = {
|
||||
subscribedTopics: new Set<TWSTopicSubscribeEventArgs>(),
|
||||
connectionState: WsConnectionStateEnum.INITIAL,
|
||||
deferredPromiseStore: {},
|
||||
};
|
||||
return this.get(key);
|
||||
}
|
||||
|
||||
delete(key: WsKey): void {
|
||||
// TODO: should we allow this at all? Perhaps block this from happening...
|
||||
if (this.hasExistingActiveConnection(key)) {
|
||||
const ws = this.getWs(key);
|
||||
this.logger.info(
|
||||
'WsStore deleting state for connection still open: ',
|
||||
ws,
|
||||
);
|
||||
ws?.close();
|
||||
}
|
||||
delete this.wsState[key];
|
||||
}
|
||||
|
||||
/* connection websocket */
|
||||
|
||||
hasExistingActiveConnection(key: WsKey): boolean {
|
||||
return this.get(key) && this.isWsOpen(key);
|
||||
}
|
||||
|
||||
getWs(key: WsKey): WebSocket | undefined {
|
||||
return this.get(key)?.ws;
|
||||
}
|
||||
|
||||
setWs(key: WsKey, wsConnection: WebSocket): WebSocket {
|
||||
if (this.isWsOpen(key)) {
|
||||
this.logger.info(
|
||||
'WsStore setConnection() overwriting existing open connection: ',
|
||||
this.getWs(key),
|
||||
);
|
||||
}
|
||||
|
||||
this.get(key, true).ws = wsConnection;
|
||||
return wsConnection;
|
||||
}
|
||||
|
||||
getDeferredPromise<TSuccessResult = any>(
|
||||
wsKey: WsKey,
|
||||
promiseRef: string | DeferredPromiseRef,
|
||||
): DeferredPromise<TSuccessResult> | undefined {
|
||||
const storeForKey = this.get(wsKey);
|
||||
if (!storeForKey) {
|
||||
return;
|
||||
}
|
||||
|
||||
const deferredPromiseStore = storeForKey.deferredPromiseStore;
|
||||
return deferredPromiseStore[promiseRef];
|
||||
}
|
||||
|
||||
createDeferredPromise<TSuccessResult = any>(
|
||||
wsKey: WsKey,
|
||||
promiseRef: string | DeferredPromiseRef,
|
||||
throwIfExists: boolean,
|
||||
): DeferredPromise<TSuccessResult> {
|
||||
const existingPromise = this.getDeferredPromise<TSuccessResult>(
|
||||
wsKey,
|
||||
promiseRef,
|
||||
);
|
||||
if (existingPromise) {
|
||||
if (throwIfExists) {
|
||||
throw new Error(`Promise exists for "${wsKey}"`);
|
||||
} else {
|
||||
// console.log('existing promise');
|
||||
return existingPromise;
|
||||
}
|
||||
}
|
||||
|
||||
// console.log('create promise');
|
||||
const createIfMissing = true;
|
||||
const storeForKey = this.get(wsKey, createIfMissing);
|
||||
|
||||
// TODO: Once stable, use Promise.withResolvers in future
|
||||
const deferredPromise: DeferredPromise = {};
|
||||
|
||||
deferredPromise.promise = new Promise((resolve, reject) => {
|
||||
deferredPromise.resolve = resolve;
|
||||
deferredPromise.reject = reject;
|
||||
});
|
||||
|
||||
const deferredPromiseStore = storeForKey.deferredPromiseStore;
|
||||
|
||||
deferredPromiseStore[promiseRef] = deferredPromise;
|
||||
|
||||
return deferredPromise;
|
||||
}
|
||||
|
||||
resolveDeferredPromise(
|
||||
wsKey: WsKey,
|
||||
promiseRef: string | DeferredPromiseRef,
|
||||
value: unknown,
|
||||
removeAfter: boolean,
|
||||
): void {
|
||||
const promise = this.getDeferredPromise(wsKey, promiseRef);
|
||||
if (promise?.resolve) {
|
||||
promise.resolve(value);
|
||||
}
|
||||
if (removeAfter) {
|
||||
this.removeDeferredPromise(wsKey, promiseRef);
|
||||
}
|
||||
}
|
||||
|
||||
rejectDeferredPromise(
|
||||
wsKey: WsKey,
|
||||
promiseRef: string | DeferredPromiseRef,
|
||||
value: unknown,
|
||||
removeAfter: boolean,
|
||||
): void {
|
||||
const promise = this.getDeferredPromise(wsKey, promiseRef);
|
||||
|
||||
if (promise?.reject) {
|
||||
this.logger.trace(
|
||||
`rejectDeferredPromise(): rejecting ${wsKey}/${promiseRef}/${value}`,
|
||||
);
|
||||
promise.reject(value);
|
||||
}
|
||||
|
||||
if (removeAfter) {
|
||||
this.removeDeferredPromise(wsKey, promiseRef);
|
||||
}
|
||||
}
|
||||
|
||||
removeDeferredPromise(
|
||||
wsKey: WsKey,
|
||||
promiseRef: string | DeferredPromiseRef,
|
||||
): void {
|
||||
const storeForKey = this.get(wsKey);
|
||||
if (!storeForKey) {
|
||||
return;
|
||||
}
|
||||
|
||||
const deferredPromise = storeForKey.deferredPromiseStore[promiseRef];
|
||||
if (deferredPromise) {
|
||||
// Just in case it's pending
|
||||
if (deferredPromise.resolve) {
|
||||
deferredPromise.resolve('promiseRemoved');
|
||||
}
|
||||
|
||||
delete storeForKey.deferredPromiseStore[promiseRef];
|
||||
}
|
||||
}
|
||||
|
||||
rejectAllDeferredPromises(wsKey: WsKey, reason: string): void {
|
||||
const storeForKey = this.get(wsKey);
|
||||
const deferredPromiseStore = storeForKey.deferredPromiseStore;
|
||||
if (!storeForKey || !deferredPromiseStore) {
|
||||
return;
|
||||
}
|
||||
|
||||
const reservedKeys = Object.values(DEFERRED_PROMISE_REF) as string[];
|
||||
|
||||
for (const promiseRef in deferredPromiseStore) {
|
||||
// Skip reserved keys, such as the connection promise
|
||||
if (reservedKeys.includes(promiseRef)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
this.rejectDeferredPromise(wsKey, promiseRef, reason, true);
|
||||
} catch (e) {
|
||||
this.logger.error(
|
||||
'rejectAllDeferredPromises(): Exception rejecting deferred promise',
|
||||
{ wsKey: wsKey, reason, promiseRef, exception: e },
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Get promise designed to track a connection attempt in progress. Resolves once connected. */
|
||||
getConnectionInProgressPromise(
|
||||
wsKey: WsKey,
|
||||
): DeferredPromise<WSConnectedResult> | undefined {
|
||||
return this.getDeferredPromise(
|
||||
wsKey,
|
||||
DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS,
|
||||
);
|
||||
}
|
||||
|
||||
getAuthenticationInProgressPromise(
|
||||
wsKey: WsKey,
|
||||
): DeferredPromise<WSConnectedResult & { event: any }> | undefined {
|
||||
return this.getDeferredPromise(
|
||||
wsKey,
|
||||
DEFERRED_PROMISE_REF.AUTHENTICATION_IN_PROGRESS,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a deferred promise designed to track a connection attempt in progress.
|
||||
*
|
||||
* Will throw if existing promise is found.
|
||||
*/
|
||||
createConnectionInProgressPromise(
|
||||
wsKey: WsKey,
|
||||
throwIfExists: boolean,
|
||||
): DeferredPromise<WSConnectedResult> {
|
||||
return this.createDeferredPromise(
|
||||
wsKey,
|
||||
DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS,
|
||||
throwIfExists,
|
||||
);
|
||||
}
|
||||
|
||||
createAuthenticationInProgressPromise(
|
||||
wsKey: WsKey,
|
||||
throwIfExists: boolean,
|
||||
): DeferredPromise<WSConnectedResult & { event: any }> {
|
||||
return this.createDeferredPromise(
|
||||
wsKey,
|
||||
DEFERRED_PROMISE_REF.AUTHENTICATION_IN_PROGRESS,
|
||||
throwIfExists,
|
||||
);
|
||||
}
|
||||
|
||||
/** Remove promise designed to track a connection attempt in progress */
|
||||
removeConnectingInProgressPromise(wsKey: WsKey): void {
|
||||
return this.removeDeferredPromise(
|
||||
wsKey,
|
||||
DEFERRED_PROMISE_REF.CONNECTION_IN_PROGRESS,
|
||||
);
|
||||
}
|
||||
|
||||
removeAuthenticationInProgressPromise(wsKey: WsKey): void {
|
||||
return this.removeDeferredPromise(
|
||||
wsKey,
|
||||
DEFERRED_PROMISE_REF.AUTHENTICATION_IN_PROGRESS,
|
||||
);
|
||||
}
|
||||
|
||||
/* connection state */
|
||||
|
||||
isWsOpen(key: WsKey): boolean {
|
||||
const existingConnection = this.getWs(key);
|
||||
return (
|
||||
!!existingConnection &&
|
||||
existingConnection.readyState === existingConnection.OPEN
|
||||
);
|
||||
}
|
||||
|
||||
getConnectionState(key: WsKey): WsConnectionStateEnum {
|
||||
return this.get(key, true).connectionState!;
|
||||
}
|
||||
|
||||
setConnectionState(key: WsKey, state: WsConnectionStateEnum) {
|
||||
this.get(key, true).connectionState = state;
|
||||
}
|
||||
|
||||
isConnectionState(key: WsKey, state: WsConnectionStateEnum): boolean {
|
||||
return this.getConnectionState(key) === state;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if we're currently in the process of opening a connection for any reason. Safer than only checking "CONNECTING" as the state
|
||||
* @param key
|
||||
* @returns
|
||||
*/
|
||||
isConnectionAttemptInProgress(key: WsKey): boolean {
|
||||
const isConnectionInProgress =
|
||||
this.isConnectionState(key, WsConnectionStateEnum.CONNECTING) ||
|
||||
this.isConnectionState(key, WsConnectionStateEnum.RECONNECTING);
|
||||
|
||||
return isConnectionInProgress;
|
||||
}
|
||||
|
||||
/* subscribed topics */
|
||||
|
||||
getTopics(key: WsKey): Set<TWSTopicSubscribeEventArgs> {
|
||||
return this.get(key, true).subscribedTopics;
|
||||
}
|
||||
|
||||
getTopicsByKey(): Record<string, Set<TWSTopicSubscribeEventArgs>> {
|
||||
const result: any = {};
|
||||
for (const refKey in this.wsState) {
|
||||
result[refKey] = this.getTopics(refKey as WsKey);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
// Since topics are objects we can't rely on the set to detect duplicates
|
||||
/**
|
||||
* Find matching "topic" request from the store
|
||||
* @param key
|
||||
* @param topic
|
||||
* @returns
|
||||
*/
|
||||
getMatchingTopic(key: WsKey, topic: TWSTopicSubscribeEventArgs) {
|
||||
const allTopics = this.getTopics(key).values();
|
||||
for (const storedTopic of allTopics) {
|
||||
if (isDeepObjectMatch(topic, storedTopic)) {
|
||||
return storedTopic;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
addTopic(key: WsKey, topic: TWSTopicSubscribeEventArgs) {
|
||||
// Check for duplicate topic. If already tracked, don't store this one
|
||||
const existingTopic = this.getMatchingTopic(key, topic);
|
||||
if (existingTopic) {
|
||||
return this.getTopics(key);
|
||||
}
|
||||
return this.getTopics(key).add(topic);
|
||||
}
|
||||
|
||||
deleteTopic(key: WsKey, topic: TWSTopicSubscribeEventArgs) {
|
||||
// Check if we're subscribed to a topic like this
|
||||
const storedTopic = this.getMatchingTopic(key, topic);
|
||||
if (storedTopic) {
|
||||
this.getTopics(key).delete(storedTopic);
|
||||
}
|
||||
|
||||
return this.getTopics(key);
|
||||
}
|
||||
}
|
||||
58
src/util/websockets/WsStore.types.ts
Normal file
58
src/util/websockets/WsStore.types.ts
Normal file
@@ -0,0 +1,58 @@
|
||||
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||
import WebSocket from 'isomorphic-ws';
|
||||
|
||||
export enum WsConnectionStateEnum {
|
||||
INITIAL = 0,
|
||||
CONNECTING = 1,
|
||||
CONNECTED = 2,
|
||||
CLOSING = 3,
|
||||
RECONNECTING = 4,
|
||||
// ERROR_RECONNECTING = 5,
|
||||
// ERROR = 5,
|
||||
}
|
||||
|
||||
export interface DeferredPromise<TSuccess = any, TError = any> {
|
||||
resolve?: (value: TSuccess) => TSuccess;
|
||||
reject?: (value: TError) => TError;
|
||||
promise?: Promise<TSuccess>;
|
||||
}
|
||||
|
||||
export interface WSConnectedResult {
|
||||
wsKey: string;
|
||||
}
|
||||
|
||||
export interface WsStoredState<TWSTopicSubscribeEvent extends string | object> {
|
||||
/** The currently active websocket connection */
|
||||
ws?: WebSocket;
|
||||
/** The current lifecycle state of the connection (enum) */
|
||||
connectionState?: WsConnectionStateEnum;
|
||||
/** A timer that will send an upstream heartbeat (ping) when it expires */
|
||||
activePingTimer?: ReturnType<typeof setTimeout> | undefined;
|
||||
/** A timer tracking that an upstream heartbeat was sent, expecting a reply before it expires */
|
||||
activePongTimer?: ReturnType<typeof setTimeout> | undefined;
|
||||
/** If a reconnection is in progress, this will have the timer for the delayed reconnect */
|
||||
activeReconnectTimer?: ReturnType<typeof setTimeout> | undefined;
|
||||
/**
|
||||
* When a connection attempt is in progress (even for reconnect), a promise is stored here.
|
||||
*
|
||||
* This promise will resolve once connected (and will then get removed);
|
||||
*/
|
||||
// connectionInProgressPromise?: DeferredPromise | undefined;
|
||||
deferredPromiseStore: Record<string, DeferredPromise>;
|
||||
/**
|
||||
* All the topics we are expected to be subscribed to on this connection (and we automatically resubscribe to if the connection drops)
|
||||
*
|
||||
* A "Set" and a deep-object-match are used to ensure we only subscribe to a
|
||||
* topic once (tracking a list of unique topics we're expected to be connected to)
|
||||
*/
|
||||
subscribedTopics: Set<TWSTopicSubscribeEvent>;
|
||||
/** Whether this connection has completed authentication (only applies to private connections) */
|
||||
isAuthenticated?: boolean;
|
||||
/**
|
||||
* Whether this connection has completed authentication before for the Websocket API, so it k
|
||||
* nows to automatically reauth if reconnected
|
||||
*/
|
||||
didAuthWSAPI?: boolean;
|
||||
/** To reauthenticate on the WS API, which channel do we send to? */
|
||||
WSAPIAuthChannel?: string;
|
||||
}
|
||||
3
src/util/websockets/index.ts
Normal file
3
src/util/websockets/index.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
export * from './websocket-util';
|
||||
export * from './WsStore';
|
||||
export * from './WsStore.types';
|
||||
409
src/util/websockets/websocket-util.ts
Normal file
409
src/util/websockets/websocket-util.ts
Normal file
@@ -0,0 +1,409 @@
|
||||
import WebSocket from 'isomorphic-ws';
|
||||
import {
|
||||
APIMarket,
|
||||
CategoryV5,
|
||||
WebsocketClientOptions,
|
||||
WsKey,
|
||||
WsTopic,
|
||||
} from '../../types';
|
||||
|
||||
import { DefaultLogger } from '../logger';
|
||||
import { WSAPIRequest } from '../../types/websockets/ws-api';
|
||||
import { neverGuard } from '../typeGuards';
|
||||
|
||||
export const WS_LOGGER_CATEGORY = { category: 'bybit-ws' };
|
||||
|
||||
export const WS_KEY_MAP = {
|
||||
v5SpotPublic: 'v5SpotPublic',
|
||||
v5LinearPublic: 'v5LinearPublic',
|
||||
v5InversePublic: 'v5InversePublic',
|
||||
v5OptionPublic: 'v5OptionPublic',
|
||||
v5Private: 'v5Private',
|
||||
/**
|
||||
* The V5 Websocket API (for sending orders over WS)
|
||||
*/
|
||||
v5PrivateTrade: 'v5PrivateTrade',
|
||||
} as const;
|
||||
|
||||
export const WS_AUTH_ON_CONNECT_KEYS: WsKey[] = [
|
||||
WS_KEY_MAP.v5Private,
|
||||
WS_KEY_MAP.v5PrivateTrade,
|
||||
];
|
||||
|
||||
export const PUBLIC_WS_KEYS = [
|
||||
WS_KEY_MAP.v5SpotPublic,
|
||||
WS_KEY_MAP.v5LinearPublic,
|
||||
WS_KEY_MAP.v5InversePublic,
|
||||
WS_KEY_MAP.v5OptionPublic,
|
||||
] as string[];
|
||||
|
||||
/** Used to automatically determine if a sub request should be to the public or private ws (when there's two) */
|
||||
const PRIVATE_TOPICS = [
|
||||
'stop_order',
|
||||
'outboundAccountInfo',
|
||||
'executionReport',
|
||||
'ticketInfo',
|
||||
// copy trading apis
|
||||
'copyTradePosition',
|
||||
'copyTradeOrder',
|
||||
'copyTradeExecution',
|
||||
'copyTradeWallet',
|
||||
// usdc options
|
||||
'user.openapi.option.position',
|
||||
'user.openapi.option.trade',
|
||||
'user.order',
|
||||
'user.openapi.option.order',
|
||||
'user.service',
|
||||
'user.openapi.greeks',
|
||||
'user.mmp.event',
|
||||
// usdc perps
|
||||
'user.openapi.perp.position',
|
||||
'user.openapi.perp.trade',
|
||||
'user.openapi.perp.order',
|
||||
'user.service',
|
||||
// unified margin
|
||||
'user.position.unifiedAccount',
|
||||
'user.execution.unifiedAccount',
|
||||
'user.order.unifiedAccount',
|
||||
'user.wallet.unifiedAccount',
|
||||
'user.greeks.unifiedAccount',
|
||||
// contract v3
|
||||
'user.position.contractAccount',
|
||||
'user.execution.contractAccount',
|
||||
'user.order.contractAccount',
|
||||
'user.wallet.contractAccount',
|
||||
// v5
|
||||
'position',
|
||||
'execution',
|
||||
'order',
|
||||
'wallet',
|
||||
'greeks',
|
||||
];
|
||||
|
||||
/**
|
||||
* Normalised internal format for a request (subscribe/unsubscribe/etc) on a topic, with optional parameters.
|
||||
*
|
||||
* - Topic: the topic this event is for
|
||||
* - Payload: the parameters to include, optional. E.g. auth requires key + sign. Some topics allow configurable parameters.
|
||||
* - Category: required for bybit, since different categories have different public endpoints
|
||||
*/
|
||||
export interface WsTopicRequest<
|
||||
TWSTopic extends string = string,
|
||||
TWSPayload = unknown,
|
||||
> {
|
||||
topic: TWSTopic;
|
||||
payload?: TWSPayload;
|
||||
category?: CategoryV5;
|
||||
}
|
||||
|
||||
/**
|
||||
* Conveniently allow users to request a topic either as string topics or objects (containing string topic + params)
|
||||
*/
|
||||
export type WsTopicRequestOrStringTopic<
|
||||
TWSTopic extends string,
|
||||
TWSPayload = unknown,
|
||||
> = WsTopicRequest<TWSTopic, TWSPayload> | string;
|
||||
|
||||
interface NetworkMapV3 {
|
||||
livenet: string;
|
||||
livenet2?: string;
|
||||
testnet: string;
|
||||
testnet2?: string;
|
||||
}
|
||||
|
||||
type PublicPrivateNetwork = 'public' | 'private';
|
||||
|
||||
/**
|
||||
* The following WS keys are logical.
|
||||
*
|
||||
* They're not directly used as a market. They usually have one private endpoint but many public ones,
|
||||
* so they need a bit of extra handling for seamless messaging between endpoints.
|
||||
*
|
||||
* For the unified keys, the "split" happens using the symbol. Symbols suffixed with USDT are obviously USDT topics.
|
||||
* For the v5 endpoints, the subscribe/unsubscribe call must specify the category the subscription should route to.
|
||||
*/
|
||||
type PublicOnlyWsKeys =
|
||||
| 'v5SpotPublic'
|
||||
| 'v5LinearPublic'
|
||||
| 'v5InversePublic'
|
||||
| 'v5OptionPublic';
|
||||
|
||||
export const WS_BASE_URL_MAP: Record<
|
||||
APIMarket,
|
||||
Record<PublicPrivateNetwork, NetworkMapV3>
|
||||
> &
|
||||
Record<PublicOnlyWsKeys, Record<'public', NetworkMapV3>> &
|
||||
Record<
|
||||
typeof WS_KEY_MAP.v5PrivateTrade,
|
||||
Record<PublicPrivateNetwork, NetworkMapV3>
|
||||
> = {
|
||||
v5: {
|
||||
public: {
|
||||
livenet: 'public topics are routed internally via the public wskeys',
|
||||
testnet: 'public topics are routed internally via the public wskeys',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/v5/private',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/private',
|
||||
},
|
||||
},
|
||||
v5PrivateTrade: {
|
||||
public: {
|
||||
livenet: 'public topics are routed internally via the public wskeys',
|
||||
testnet: 'public topics are routed internally via the public wskeys',
|
||||
},
|
||||
private: {
|
||||
livenet: 'wss://stream.bybit.com/v5/trade',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/trade',
|
||||
},
|
||||
},
|
||||
v5SpotPublic: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/v5/public/spot',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/public/spot',
|
||||
},
|
||||
},
|
||||
v5LinearPublic: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/v5/public/linear',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/public/linear',
|
||||
},
|
||||
},
|
||||
v5InversePublic: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/v5/public/inverse',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/public/inverse',
|
||||
},
|
||||
},
|
||||
v5OptionPublic: {
|
||||
public: {
|
||||
livenet: 'wss://stream.bybit.com/v5/public/option',
|
||||
testnet: 'wss://stream-testnet.bybit.com/v5/public/option',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export function isPrivateWsTopic(topic: string): boolean {
|
||||
return PRIVATE_TOPICS.includes(topic);
|
||||
}
|
||||
|
||||
export function getWsKeyForTopic(
|
||||
market: APIMarket,
|
||||
topic: string,
|
||||
isPrivate?: boolean,
|
||||
category?: CategoryV5,
|
||||
): WsKey {
|
||||
const isPrivateTopic = isPrivate === true || PRIVATE_TOPICS.includes(topic);
|
||||
switch (market) {
|
||||
case 'v5': {
|
||||
if (isPrivateTopic) {
|
||||
return WS_KEY_MAP.v5Private;
|
||||
}
|
||||
|
||||
switch (category) {
|
||||
case 'spot': {
|
||||
return WS_KEY_MAP.v5SpotPublic;
|
||||
}
|
||||
case 'linear': {
|
||||
return WS_KEY_MAP.v5LinearPublic;
|
||||
}
|
||||
case 'inverse': {
|
||||
return WS_KEY_MAP.v5InversePublic;
|
||||
}
|
||||
case 'option': {
|
||||
return WS_KEY_MAP.v5OptionPublic;
|
||||
}
|
||||
case undefined: {
|
||||
throw new Error('Category cannot be undefined');
|
||||
}
|
||||
default: {
|
||||
throw neverGuard(
|
||||
category,
|
||||
'getWsKeyForTopic(v5): Unhandled v5 category',
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
default: {
|
||||
throw neverGuard(market, 'getWsKeyForTopic(): Unhandled market');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function getWsUrl(
|
||||
wsKey: WsKey,
|
||||
wsClientOptions: WebsocketClientOptions,
|
||||
logger: typeof DefaultLogger,
|
||||
): string {
|
||||
const wsUrl = wsClientOptions.wsUrl;
|
||||
if (wsUrl) {
|
||||
return wsUrl;
|
||||
}
|
||||
|
||||
// https://bybit-exchange.github.io/docs/v5/demo
|
||||
const DEMO_TRADING_ENDPOINT = 'wss://stream-demo.bybit.com/v5/private';
|
||||
|
||||
const isDemoTrading = wsClientOptions.demoTrading;
|
||||
const isTestnet = wsClientOptions.testnet;
|
||||
const networkKey = isTestnet ? 'testnet' : 'livenet';
|
||||
|
||||
switch (wsKey) {
|
||||
case WS_KEY_MAP.v5Private: {
|
||||
if (isDemoTrading) {
|
||||
return DEMO_TRADING_ENDPOINT;
|
||||
}
|
||||
return WS_BASE_URL_MAP.v5.private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5PrivateTrade: {
|
||||
if (isDemoTrading) {
|
||||
return DEMO_TRADING_ENDPOINT;
|
||||
}
|
||||
return WS_BASE_URL_MAP[wsKey].private[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5SpotPublic: {
|
||||
return WS_BASE_URL_MAP.v5SpotPublic.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5LinearPublic: {
|
||||
return WS_BASE_URL_MAP.v5LinearPublic.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5InversePublic: {
|
||||
return WS_BASE_URL_MAP.v5InversePublic.public[networkKey];
|
||||
}
|
||||
case WS_KEY_MAP.v5OptionPublic: {
|
||||
return WS_BASE_URL_MAP.v5OptionPublic.public[networkKey];
|
||||
}
|
||||
default: {
|
||||
logger.error('getWsUrl(): Unhandled wsKey: ', {
|
||||
category: 'bybit-ws',
|
||||
wsKey,
|
||||
});
|
||||
throw neverGuard(wsKey, 'getWsUrl(): Unhandled wsKey');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function getMaxTopicsPerSubscribeEvent(
|
||||
market: APIMarket,
|
||||
wsKey: WsKey,
|
||||
): number | null {
|
||||
switch (market) {
|
||||
case 'v5': {
|
||||
if (wsKey === WS_KEY_MAP.v5SpotPublic) {
|
||||
return 10;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
default: {
|
||||
throw neverGuard(market, 'getWsKeyForTopic(): Unhandled market');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const WS_ERROR_ENUM = {
|
||||
NOT_AUTHENTICATED_SPOT_V3: '-1004',
|
||||
API_ERROR_GENERIC: '10001',
|
||||
API_SIGN_AUTH_FAILED: '10003',
|
||||
USDC_OPTION_AUTH_FAILED: '3303006',
|
||||
};
|
||||
|
||||
/**
|
||||
* #305: ws.terminate() is undefined in browsers.
|
||||
* This only works in node.js, not in browsers.
|
||||
* Does nothing if `ws` is undefined. Does nothing in browsers.
|
||||
*/
|
||||
export function safeTerminateWs(
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
ws?: WebSocket | any,
|
||||
fallbackToClose?: boolean,
|
||||
): boolean {
|
||||
if (!ws) {
|
||||
return false;
|
||||
}
|
||||
if (typeof ws['terminate'] === 'function') {
|
||||
ws.terminate();
|
||||
return true;
|
||||
} else if (fallbackToClose) {
|
||||
ws.close();
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* WS API promises are stored using a primary key. This key is constructed using
|
||||
* properties found in every request & reply.
|
||||
*/
|
||||
export function getPromiseRefForWSAPIRequest(
|
||||
requestEvent: WSAPIRequest<unknown>,
|
||||
): string {
|
||||
const promiseRef = [requestEvent.op, requestEvent.reqId].join('_');
|
||||
return promiseRef;
|
||||
}
|
||||
|
||||
/**
|
||||
* Users can conveniently pass topics as strings or objects (object has topic name + optional params).
|
||||
*
|
||||
* This method normalises topics into objects (object has topic name + optional params).
|
||||
*/
|
||||
export function getNormalisedTopicRequests(
|
||||
wsTopicRequests: WsTopicRequestOrStringTopic<string>[],
|
||||
): WsTopicRequest<string>[] {
|
||||
const normalisedTopicRequests: WsTopicRequest<string>[] = [];
|
||||
|
||||
for (const wsTopicRequest of wsTopicRequests) {
|
||||
// passed as string, convert to object
|
||||
if (typeof wsTopicRequest === 'string') {
|
||||
const topicRequest: WsTopicRequest<string> = {
|
||||
topic: wsTopicRequest,
|
||||
payload: undefined,
|
||||
};
|
||||
normalisedTopicRequests.push(topicRequest);
|
||||
continue;
|
||||
}
|
||||
|
||||
// already a normalised object, thanks to user
|
||||
normalisedTopicRequests.push(wsTopicRequest);
|
||||
}
|
||||
return normalisedTopicRequests;
|
||||
}
|
||||
|
||||
/**
|
||||
* Groups topics in request into per-wsKey groups
|
||||
* @param normalisedTopicRequests
|
||||
* @param wsKey
|
||||
* @param isPrivateTopic
|
||||
* @returns
|
||||
*/
|
||||
export function getTopicsPerWSKey(
|
||||
market: APIMarket,
|
||||
normalisedTopicRequests: WsTopicRequest[],
|
||||
wsKey?: WsKey,
|
||||
isPrivateTopic?: boolean,
|
||||
): {
|
||||
[key in WsKey]?: WsTopicRequest<WsTopic>[];
|
||||
} {
|
||||
const perWsKeyTopics: { [key in WsKey]?: WsTopicRequest<WsTopic>[] } = {};
|
||||
|
||||
// Sort into per wsKey arrays, in case topics are mixed together for different wsKeys
|
||||
for (const topicRequest of normalisedTopicRequests) {
|
||||
const derivedWsKey =
|
||||
wsKey ||
|
||||
getWsKeyForTopic(
|
||||
market,
|
||||
topicRequest.topic,
|
||||
isPrivateTopic,
|
||||
topicRequest.category,
|
||||
);
|
||||
|
||||
if (
|
||||
!perWsKeyTopics[derivedWsKey] ||
|
||||
!Array.isArray(perWsKeyTopics[derivedWsKey])
|
||||
) {
|
||||
perWsKeyTopics[derivedWsKey] = [];
|
||||
}
|
||||
|
||||
perWsKeyTopics[derivedWsKey]!.push(topicRequest);
|
||||
}
|
||||
|
||||
return perWsKeyTopics;
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,9 +1,7 @@
|
||||
import { WebsocketClient } from '../../src';
|
||||
|
||||
describe.skip('Public V5 Websocket client', () => {
|
||||
const api = new WebsocketClient({
|
||||
market: 'v5',
|
||||
});
|
||||
const api = new WebsocketClient({});
|
||||
|
||||
const linearSymbol = 'BTCUSDT';
|
||||
const linearCategory = 'linear';
|
||||
@@ -11,13 +9,17 @@ describe.skip('Public V5 Websocket client', () => {
|
||||
describe('Topics subscription confirmation', () => {
|
||||
it('can subscribeV5 to LINEAR with valid topic', async () => {
|
||||
await expect(
|
||||
api.subscribeV5(`publicTrade.${linearSymbol}`, linearCategory),
|
||||
).resolves.toBeUndefined();
|
||||
Promise.allSettled(
|
||||
api.subscribeV5(`publicTrade.${linearSymbol}`, linearCategory),
|
||||
),
|
||||
).resolves.toStrictEqual([]);
|
||||
});
|
||||
|
||||
it('cannot subscribeV5 to LINEAR with valid topic', async () => {
|
||||
try {
|
||||
await api.subscribeV5(`publicTrade.${linearSymbol}X`, linearCategory);
|
||||
await Promise.allSettled(
|
||||
api.subscribeV5(`publicTrade.${linearSymbol}X`, linearCategory),
|
||||
);
|
||||
} catch (e) {
|
||||
expect(e).toBeDefined();
|
||||
expect(e).toMatch(`(publicTrade.${linearSymbol}X) failed to subscribe`);
|
||||
|
||||
@@ -1,31 +1,30 @@
|
||||
/* eslint-disable @typescript-eslint/no-unused-vars */
|
||||
/* eslint-disable no-unused-vars */
|
||||
/* eslint-disable @typescript-eslint/no-empty-function */
|
||||
import { WebsocketClient, WsClientEvent } from '../src';
|
||||
import { DefaultLogger, WebsocketClient } from '../src';
|
||||
|
||||
export function getSilentLogger(_logHint?: string) {
|
||||
export function getSilentLogger(_logHint?: string): typeof DefaultLogger {
|
||||
return {
|
||||
silly: () => {},
|
||||
debug: () => {},
|
||||
notice: () => {},
|
||||
trace: () => {},
|
||||
info: () => {},
|
||||
warning: () => {},
|
||||
error: () => {},
|
||||
};
|
||||
}
|
||||
|
||||
export const fullLogger = {
|
||||
silly: (...params) => console.log('silly', ...params),
|
||||
debug: (...params) => console.log('debug', ...params),
|
||||
notice: (...params) => console.log('notice', ...params),
|
||||
export const fullLogger: typeof DefaultLogger = {
|
||||
trace: (...params) => console.log('trace', ...params),
|
||||
info: (...params) => console.info('info', ...params),
|
||||
warning: (...params) => console.warn('warning', ...params),
|
||||
error: (...params) => console.error('error', ...params),
|
||||
};
|
||||
|
||||
export const WS_OPEN_EVENT_PARTIAL = {
|
||||
type: 'open',
|
||||
};
|
||||
export type WsClientEvent =
|
||||
| 'open'
|
||||
| 'update'
|
||||
| 'close'
|
||||
| 'exception'
|
||||
| 'reconnect'
|
||||
| 'reconnected'
|
||||
| 'response';
|
||||
|
||||
/** Resolves a promise if an event is seen before a timeout (defaults to 4.5 seconds) */
|
||||
export function waitForSocketEvent(
|
||||
@@ -47,7 +46,7 @@ export function waitForSocketEvent(
|
||||
clearTimeout(timeout);
|
||||
resolvedOnce = true;
|
||||
wsClient.removeListener(event, (e) => resolver(e));
|
||||
wsClient.removeListener('error', (e) => rejector(e));
|
||||
wsClient.removeListener('exception', (e) => rejector(e));
|
||||
}
|
||||
|
||||
function resolver(event) {
|
||||
@@ -63,7 +62,7 @@ export function waitForSocketEvent(
|
||||
}
|
||||
|
||||
wsClient.on(event, (e) => resolver(e));
|
||||
wsClient.on('error', (e) => rejector(e));
|
||||
wsClient.on('exception', (e) => rejector(e));
|
||||
|
||||
// if (event !== 'close') {
|
||||
// wsClient.on('close', (event) => {
|
||||
@@ -79,21 +78,21 @@ export function waitForSocketEvent(
|
||||
|
||||
export function listenToSocketEvents(wsClient: WebsocketClient) {
|
||||
const retVal: Record<
|
||||
'update' | 'open' | 'response' | 'close' | 'error',
|
||||
'update' | 'open' | 'response' | 'close' | 'exception',
|
||||
typeof jest.fn
|
||||
> = {
|
||||
open: jest.fn(),
|
||||
response: jest.fn(),
|
||||
update: jest.fn(),
|
||||
close: jest.fn(),
|
||||
error: jest.fn(),
|
||||
exception: jest.fn(),
|
||||
};
|
||||
|
||||
wsClient.on('open', retVal.open);
|
||||
wsClient.on('response', retVal.response);
|
||||
wsClient.on('update', retVal.update);
|
||||
wsClient.on('close', retVal.close);
|
||||
wsClient.on('error', retVal.error);
|
||||
wsClient.on('exception', retVal.exception);
|
||||
|
||||
return {
|
||||
...retVal,
|
||||
@@ -102,7 +101,7 @@ export function listenToSocketEvents(wsClient: WebsocketClient) {
|
||||
wsClient.removeListener('response', retVal.response);
|
||||
wsClient.removeListener('update', retVal.update);
|
||||
wsClient.removeListener('close', retVal.close);
|
||||
wsClient.removeListener('error', retVal.error);
|
||||
wsClient.removeListener('exception', retVal.exception);
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
@@ -17,6 +17,6 @@
|
||||
"baseUrl": ".",
|
||||
"outDir": "./lib"
|
||||
},
|
||||
"include": ["src/**/*", "src/.ts"],
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "**/node_modules/*", "coverage", "doc"]
|
||||
}
|
||||
|
||||
@@ -19,8 +19,6 @@ function generateConfig(name) {
|
||||
// Add '.ts' and '.tsx' as resolvable extensions.
|
||||
extensions: [".webpack.js", ".web.js", ".ts", ".tsx", ".js"],
|
||||
alias: {
|
||||
[path.resolve(__dirname, "../lib/util/node-support.js")]:
|
||||
path.resolve(__dirname, "../lib/util/browser-support.js"),
|
||||
process: "process/browser",
|
||||
}
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user