Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
bybit-api
Advanced tools
bybit-api - npm Package Compare versions
Comparing version 3.7.7 to 3.7.8
@@ -29,2 +29,4 @@ import { RestClientOptions, WS_KEY_MAP } from '../util'; | ||
| reconnectTimeout?: number; | ||
| /** Override the recv window for authenticating over websockets (default: 5000 ms) */ | ||
| recvWindow?: number; | ||
| restOptions?: RestClientOptions; | ||
@@ -31,0 +33,0 @@ requestOptions?: any; |
@@ -40,3 +40,3 @@ "use strict"; | ||
| this.wsStore = new WsStore_1.default(this.logger); | ||
| this.options = Object.assign({ testnet: false, pongTimeout: 1000, pingInterval: 10000, reconnectTimeout: 500, fetchTimeOffsetBeforeAuth: false }, options); | ||
| this.options = Object.assign({ testnet: false, pongTimeout: 1000, pingInterval: 10000, reconnectTimeout: 500, recvWindow: 5000, fetchTimeOffsetBeforeAuth: false }, options); | ||
| this.options.restOptions = Object.assign(Object.assign({}, this.options.restOptions), { testnet: this.options.testnet }); | ||
@@ -470,3 +470,4 @@ this.prepareRESTClient(); | ||
| : 0; | ||
| const signatureExpiresAt = Date.now() + timeOffset + 5000; | ||
| const recvWindow = this.options.recvWindow || 5000; | ||
| const signatureExpiresAt = Date.now() + timeOffset + recvWindow; | ||
| const signature = yield node_support_1.signMessage('GET/realtime' + signatureExpiresAt, secret); | ||
@@ -473,0 +474,0 @@ return { |
| { | ||
| "name": "bybit-api", | ||
| "version": "3.7.7", | ||
| "version": "3.7.8", | ||
| "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.", | ||
@@ -5,0 +5,0 @@ "main": "lib/index.js", |
@@ -38,3 +38,2 @@ # Node.js & JavaScript SDK for Bybit REST API & WebSockets | ||
| - [bitget-api](https://www.npmjs.com/package/bitget-api) | ||
| - [ftx-api](https://www.npmjs.com/package/ftx-api) | ||
| - Try my misc utilities: | ||
@@ -59,4 +58,3 @@ - [orderbooks](https://www.npmjs.com/package/orderbooks) | ||
| - [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. | ||
| - [dist](./dist) - the webpack bundle of the project for use in browser environments (see guidance on webpack below). | ||
| - [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome! | ||
| - [examples](./examples) - examples & demonstrations. Contributions are welcome! | ||
@@ -67,31 +65,32 @@ --- | ||
| Bybit has several API groups (originally one per product). Each generation is labelled with the version number (e.g. v1/v2/v3/v5). Some of the newer API groups can only be used by upgrading your account to the unified account, but doing so will prevent you from using the V1 and V2 APIs. | ||
| 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 upgrade guide](https://bybit-exchange.github.io/docs/v5/upgrade-guide) for more information on requirements to use each API group. If you have a choice, you should use the newest generation that is available (e.g. use the V5 instead of the V3 APIs if you can). | ||
| 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) | | ||
| | [ **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). | | ||
| | [ **Futures v2** ] | The Futures v2 APIs | | ||
| | Deprecated! ContractClient or RestClientV5 recommended | Please read the [V5 upgrade guideline](https://bybit-exchange.github.io/docs/v5/upgrade-guide) | | ||
| | [~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) | | ||
| | [ **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) | | ||
| | [~AccountAssetClient~](src/account-asset-client.ts) (deprecated, AccountAssetClientV3 recommended) | [Account Asset V1 APIs](https://bybit-exchange.github.io/docs/account_asset/v1/#t-introduction) | | ||
| | [WebsocketClient](src/websocket-client.ts) | All WebSocket Events (Public & Private for all API categories) | | ||
| | 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) | | ||
| | [ **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). | | ||
| | [ **Futures v2** ] | The Futures v2 APIs | | ||
| | Deprecated! RestClientV5 recommended | Please read the [V5 interface mapping page](https://bybit-exchange.github.io/docs/v5/intro#v5-and-v3-interface-mapping-list) | | ||
| | [~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) | | ||
| | [ **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) | | ||
| | [~AccountAssetClient~](src/account-asset-client.ts) (deprecated, AccountAssetClientV3 recommended) | [Account Asset V1 APIs](https://bybit-exchange.github.io/docs/account_asset/v1/#t-introduction) | | ||
| | [WebsocketClient](src/websocket-client.ts) | All WebSocket Events (Public & Private for all API categories) | | ||
| Examples for using each client can be found in: | ||
@@ -262,2 +261,5 @@ | ||
| // recv window size for authenticated websocket requests (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. | ||
@@ -264,0 +266,0 @@ // restOptions: { }, |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.78%
581537
- Lines of code
- increased by0.03%
11602
- Number of lines in readme file
- increased by0.49%
411
No dependency changes