diff --git a/package-lock.json b/package-lock.json index 99fb7700..8bc1d5b1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "bybit-api", - "version": "3.10.22", + "version": "3.10.23", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "bybit-api", - "version": "3.10.22", + "version": "3.10.23", "license": "MIT", "dependencies": { "axios": "^1.6.6", diff --git a/package.json b/package.json index 237d47e1..9594562b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bybit-api", - "version": "3.10.22", + "version": "3.10.23", "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", diff --git a/src/account-asset-client-v3.ts b/src/account-asset-client-v3.ts index 6b3106de..9b1adb1d 100644 --- a/src/account-asset-client-v3.ts +++ b/src/account-asset-client-v3.ts @@ -43,6 +43,10 @@ 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() { @@ -67,20 +71,20 @@ export class AccountAssetClientV3 extends BaseRestClient { */ createInternalTransfer( - params: InternalTransferRequestV3 + params: InternalTransferRequestV3, ): Promise> { return this.postPrivate( '/asset/v3/private/transfer/inter-transfer', - params + params, ); } getInternalTransfers( - params: QueryInternalTransfersRequestV3 + params: QueryInternalTransfersRequestV3, ): Promise> { return this.getPrivate( '/asset/v3/private/transfer/inter-transfer/list/query', - params + params, ); } @@ -93,16 +97,16 @@ export class AccountAssetClientV3 extends BaseRestClient { }): Promise> { return this.postPrivate( '/asset/v3/private/transfer/sub-member-transfer', - params + params, ); } getSubAccountTransfers( - params?: SubAccountTransferRequestV3 + params?: SubAccountTransferRequestV3, ): Promise> { return this.getPrivate( '/asset/v3/private/transfer/sub-member-transfer/list/query', - params + params, ); } @@ -120,61 +124,61 @@ export class AccountAssetClientV3 extends BaseRestClient { }): Promise> { return this.postPrivate( '/asset/v3/private/transfer/transfer-sub-member-save', - params + params, ); } createUniversalTransfer( - params: UniversalTransferRequestV3 + params: UniversalTransferRequestV3, ): Promise> { return this.postPrivate( '/asset/v3/private/transfer/universal-transfer', - params + params, ); } getUniversalTransfers( - params: UniversalTransferListRequestV3 + params: UniversalTransferListRequestV3, ): Promise> { return this.getPrivate( '/asset/v3/private/transfer/universal-transfer/list/query', - params + params, ); } getTransferableCoinList( - params: TransferCoinListRequestV3 + params: TransferCoinListRequestV3, ): Promise> { return this.getPrivate( '/asset/v3/private/transfer/transfer-coin/list/query', - params + params, ); } getAccountCoinBalance( - params: SingleAccountCoinBalanceRequestV3 + params: SingleAccountCoinBalanceRequestV3, ): Promise> { return this.getPrivate( '/asset/v3/private/transfer/account-coin/balance/query', - params + params, ); } getAccountCoinBalances( - params: AccountCoinBalancesRequestV3 + params: AccountCoinBalancesRequestV3, ): Promise> { return this.getPrivate( '/asset/v3/private/transfer/account-coins/balance/query', - params + params, ); } getAssetInfo( - params?: AssetInfoRequestV3 + params?: AssetInfoRequestV3, ): Promise> { return this.getPrivate( '/asset/v3/private/transfer/asset-info/query', - params + params, ); } @@ -186,49 +190,49 @@ export class AccountAssetClientV3 extends BaseRestClient { /** Get Deposit Spec */ getSupportedDepositList( - params?: SupportedDepositListRequestV3 + params?: SupportedDepositListRequestV3, ): Promise> { return this.get( '/asset/v3/public/deposit/allowed-deposit-list/query', - params + params, ); } getDepositRecords( - params?: DepositRecordQueryRequestV3 + params?: DepositRecordQueryRequestV3, ): Promise> { return this.getPrivate('/asset/v3/private/deposit/record/query', params); } getSubDepositRecords( - params: SubDepositRecordQueryRequestV3 + params: SubDepositRecordQueryRequestV3, ): Promise> { return this.getPrivate( '/asset/v3/private/deposit/sub-member-record/query', - params + params, ); } getWithdrawRecords( - params?: WithdrawRecordQueryRequestV3 + params?: WithdrawRecordQueryRequestV3, ): Promise> { return this.getPrivate('/asset/v3/private/withdraw/record/query', params); } getCoinInformation( - coin?: string + coin?: string, ): Promise> { return this.getPrivate('/asset/v3/private/coin-info/query', { coin }); } submitWithdrawal( - params: WithdrawCreateRequestV3 + params: WithdrawCreateRequestV3, ): Promise> { return this.postPrivate('/asset/v3/private/withdraw/create', params); } cancelWithdrawal( - withdrawalId: number + withdrawalId: number, ): Promise> { return this.postPrivate('/asset/v3/private/withdraw/create', { withdrawalId, @@ -236,28 +240,28 @@ export class AccountAssetClientV3 extends BaseRestClient { } getMasterAccountDepositAddress( - params?: QueryDepositAddressRequestV3 + params?: QueryDepositAddressRequestV3, ): Promise> { return this.getPrivate('/asset/v3/private/deposit/address/query', params); } getSubAccountDepositAddress( - params: QuerySubAccountDepositAddressRequestV3 + params: QuerySubAccountDepositAddressRequestV3, ): Promise> { return this.getPrivate( '/asset/v3/private/deposit/sub-member-address/query', - params + params, ); } createSubMember( - params: CreateSubMemberRequestV3 + params: CreateSubMemberRequestV3, ): Promise> { return this.postPrivate('/user/v3/private/create-sub-member', params); } createSubAPIKey( - params: CreateSubAPIKeyRequestV3 + params: CreateSubAPIKeyRequestV3, ): Promise> { return this.postPrivate('/user/v3/private/create-sub-api', params); } @@ -274,7 +278,7 @@ export class AccountAssetClientV3 extends BaseRestClient { */ freezeSubMember( subuid: number, - frozenStatus: 0 | 1 + frozenStatus: 0 | 1, ): Promise> { return this.postPrivate('/user/v3/private/frozen-sub-member', { subuid, @@ -287,13 +291,13 @@ export class AccountAssetClientV3 extends BaseRestClient { } modifyMasterAPIKey( - params: ModifyAPIKeyRequestV3 + params: ModifyAPIKeyRequestV3, ): Promise> { return this.postPrivate('/user/v3/private/update-api', params); } modifySubAPIKey( - params: ModifyAPIKeyRequestV3 + params: ModifyAPIKeyRequestV3, ): Promise> { return this.postPrivate('/user/v3/private/update-sub-api', params); } diff --git a/src/contract-client.ts b/src/contract-client.ts index b5df43c1..fb31fbd9 100644 --- a/src/contract-client.ts +++ b/src/contract-client.ts @@ -32,6 +32,10 @@ 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() { diff --git a/src/copy-trading-client.ts b/src/copy-trading-client.ts index c8425d3f..45f85b94 100644 --- a/src/copy-trading-client.ts +++ b/src/copy-trading-client.ts @@ -14,6 +14,10 @@ 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() { diff --git a/src/spot-client-v3.ts b/src/spot-client-v3.ts index 029b92d9..ddd443ad 100644 --- a/src/spot-client-v3.ts +++ b/src/spot-client-v3.ts @@ -17,6 +17,10 @@ import BaseRestClient from './util/BaseRestClient'; /** * REST API client for newer Spot 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 SpotClientV3 extends BaseRestClient { getClientType() { diff --git a/src/unified-margin-client.ts b/src/unified-margin-client.ts index 0e172efb..049251d1 100644 --- a/src/unified-margin-client.ts +++ b/src/unified-margin-client.ts @@ -36,6 +36,10 @@ 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() {