bybit-api 3.6.1 → 3.7.1-beta.0

package/src/account-asset-client-v3.ts

@@ -0,0 +1,310 @@
+/* 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
+ */
+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');
+  }
+}

package/src/account-asset-client.ts

@@ -0,0 +1,149 @@
+/* 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
+ */
+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');
+  }
+}

package/src/constants/enum.ts

@@ -0,0 +1,105 @@
+export const linearPositionModeEnum = {
+  OneWayMode: 'MergedSingle',
+  HedgeMode: 'BothSide',
+} as const;
+
+export const positionTpSlModeEnum = {
+  /** Full take profit/stop loss mode (a single TP order and a single SL order can be placed, covering the entire position) */
+  Full: 'Full',
+  /** Partial take profit/stop loss mode (multiple TP and SL orders can be placed, covering portions of the position) */
+  Partial: 'Partial',
+} as const;
+
+export const API_ERROR_CODE = {
+  BALANCE_INSUFFICIENT_SPOT: -1131,
+  ORDER_NOT_FOUND_OR_TOO_LATE_SPOT: -2013,
+  SUCCESS: 0,
+  /** This could mean bad request, incorrect value types or even incorrect/missing values */
+  PARAMS_MISSING_OR_WRONG: 10001,
+  INVALID_API_KEY_OR_PERMISSIONS: 10003,
+  SIGNATURE_NOT_VALID: 10004,
+  INCORRECT_API_KEY_PERMISSIONS: 10005,
+  DB_ERROR_WRONG_CURSOR: 10016,
+  INCORRECT_PRIVATE_OPERATIONS: 3303001,
+  /** Account not unified margin, update required */
+  ACCOUNT_NOT_UNIFIED: 10020,
+  UNKNOWN_ERROR: 12000,
+  BALANCE_INSUFFICIENT_SPOT_V3: 12131,
+  ORDER_NOT_FOUND_SPOT_V3: 12213,
+  ORDER_NOT_FOUND_LEVERAGED_TOKEN: 12407,
+  EXCEEDED_UPPER_LIMIT_LEVERAGED_TOKEN: 12409,
+  QUERY_ACCOUNT_INFO_ERROR: 12602,
+  CROSS_MARGIN_USER_NOT_FOUND: 12607,
+  CROSS_MARGIN_REPAYMENT_NOT_REQUIRED: 12616,
+  ORDER_NOT_FOUND_OR_TOO_LATE: 20001,
+  POSITION_STATUS_NOT_NORMAL: 30013,
+  CANNOT_SET_TRADING_STOP_FOR_ZERO_POS: 30024,
+  /** Seen when placing an order */
+  INSUFFICIENT_BALANCE_FOR_ORDER_COST: 30031,
+  POSITION_IDX_NOT_MATCH_POSITION_MODE: 30041,
+  /** Seen if a conditional order is too large */
+  INSUFFICIENT_BALANCE: 30042,
+  /** E.g. trying to change position margin while on cross */
+  POSITION_IS_CROSS_MARGIN: 30056,
+  POSITION_MODE_NOT_MODIFIED: 30083,
+  ISOLATED_NOT_MODIFIED: 30084,
+  RISK_LIMIT_NOT_EXISTS: 30090,
+  SUB_USER_ALREADY_EXISTS: 31005,
+  LEVERAGE_NOT_MODIFIED: 34036,
+  SAME_SLTP_MODE: 37002,
+  COPY_TRADE_NOT_OPEN_ORDER: 39426,
+  V5_ORDER_NOT_FOUND: 110001,
+  V5_INSUFFICIENT_BALANCE: 110007,
+  V5_API_KEY_PERMISSION_DENIED: 10005,
+  V5_CROSS_ISOLATED_MARGIN_NOT_CHANGED: 110026,
+  V5_LEVERAGE_NOT_CHANGED: 110043,
+  V5_MARGIN_MODE_NOT_CHANGED: 110073,
+  V5_TPSL_NOT_CHANGED: 10001,
+  V5_RISK_ID_NOT_CHANGED: 10001,
+  V5_AUTO_ADD_MARGIN_NOT_CHANGED: 10001,
+  V5_TPSL_ERROR_NO_POSITION: 10001,
+  V5_RISK_ID_NOT_MODIFIED: 110075,
+  QTY_EXCEEDS_MAX_LIMIT: 130006,
+  ORDER_NOT_FOUND_OR_TOO_LATE_LINEAR: 130010,
+  ORDER_COST_NOT_AVAILABLE: 130021,
+  CANNOT_SET_LINEAR_TRADING_STOP_FOR_ZERO_POS: 130024,
+  ISOLATED_NOT_MODIFIED_LINEAR: 130056,
+  POSITION_SIZE_IS_ZERO: 130057,
+  AUTO_ADD_MARGIN_NOT_MODIFIED: 130060,
+  INSUFFICIENT_BALANCE_FOR_ORDER_COST_LINEAR: 130080,
+  SAME_SLTP_MODE_LINEAR: 130150,
+  NOT_SUPPORTED_FOR_SUBACCOUNTS: 131003,
+  TRANSFER_ID_EXISTS: 131214,
+  RISK_ID_NOT_MODIFIED: 134026,
+  CONTRACT_ORDER_NOT_EXISTS: 140001,
+  CONTRACT_INSUFFICIENT_BALANCE: 140007,
+  CONTRACT_POSITION_MODE_NOT_MODIFIED: 140025,
+  CONTRACT_MARGIN_MODE_NOT_MODIFIED: 140026,
+  CONTRACT_RISK_LIMIT_INFO_NOT_EXISTS: 140031,
+  CONTRACT_SET_LEVERAGE_NOT_MODIFIED: 140043,
+  SUB_USER_NOT_FOUND: 141009,
+  SPOT_LEVERAGE_TOKEN_INSUFFICIENT_BALANCE: 175006,
+  SPOT_LEVERAGE_TOKEN_ORDER_NOT_FOUND: 175007,
+  SPOT_LEVERAGE_QUIZ_REQUIRED: 175010,
+  SPOT_MARGIN_NOT_ENABLED: 176008,
+  SPOT_MARGIN_QUESTIONNAIRE_NOT_SUBMIT: 176037,
+  /** E.g. USDC Options trading, trying to access a symbol that is no longer active */
+  CONTRACT_NAME_NOT_EXIST: 3100111,
+  ORDER_NOT_EXIST: 3100136,
+  NO_ACTIVE_ORDER: 3100205,
+  /** E.g. USDC Options trading when the account hasn't been opened for USDC Options yet */
+  ACCOUNT_NOT_EXIST: 3200200,
+  SET_MARGIN_MODE_FAILED_USDC: 3400045,
+  INCORRECT_MMP_PARAMETERS: 3500712,
+  INSTITION_MMP_PROFILE_NOT_FOUND: 3500713,
+} as const;
+
+/**
+ * Position idx, used to identify positions in different position modes.
+ * Required if you are under One-Way Mode:
+ */
+export enum LinearPositionIdx {
+  OneWayMode = 0,
+  BuySide = 1,
+  SellSide = 2,
+}