bybit-api 3.7.0 → 3.7.1-beta.0

package/src/types/request/v5-trade.ts

@@ -0,0 +1,133 @@
+import {
+  CategoryV5,
+  OrderFilterV5,
+  OrderSMPTypeV5,
+  OrderSideV5,
+  OrderStatusV5,
+  OrderTimeInForceV5,
+  OrderTriggerByV5,
+  OrderTypeV5,
+  PositionIdx,
+} from '../v5-shared';
+
+export interface OrderParamsV5 {
+  category: CategoryV5;
+  symbol: string;
+  isLeverage?: 0 | 1;
+  side: OrderSideV5;
+  orderType: OrderTypeV5;
+  qty: string;
+  price?: string;
+  triggerDirection?: 1 | 2;
+  orderFilter?: 'Order' | 'tpslOrder';
+  triggerPrice?: string;
+  triggerBy?: OrderTriggerByV5;
+  orderIv?: string;
+  timeInForce?: OrderTimeInForceV5;
+  positionIdx?: PositionIdx;
+  orderLinkId?: string;
+  takeProfit?: string;
+  stopLoss?: string;
+  tpTriggerBy?: OrderTriggerByV5;
+  slTriggerBy?: OrderTriggerByV5;
+  reduceOnly?: boolean;
+  closeOnTrigger?: boolean;
+  smpType?: OrderSMPTypeV5;
+  mmp?: boolean;
+  tpslMode?: 'Full' | 'Partial';
+  tpLimitPrice?: string;
+  slLimitPrice?: string;
+  tpOrderType?: OrderTypeV5;
+  slOrderType?: OrderTypeV5;
+}
+
+export interface AmendOrderParamsV5 {
+  category: CategoryV5;
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+  orderIv?: string;
+  triggerPrice?: string;
+  qty?: string;
+  price?: string;
+  takeProfit?: string;
+  stopLoss?: string;
+  tpTriggerBy?: OrderTriggerByV5;
+  slTriggerBy?: OrderTriggerByV5;
+  triggerBy?: OrderTriggerByV5;
+  tpLimitPrice?: string;
+  slLimitPrice?: string;
+}
+
+export interface CancelOrderParamsV5 {
+  category: CategoryV5;
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+  orderFilter?: OrderFilterV5;
+}
+
+export interface GetAccountOrdersParams {
+  category: CategoryV5;
+  symbol?: string;
+  baseCoin?: string;
+  settleCoin?: string;
+  orderId?: string;
+  orderLinkId?: string;
+  openOnly?: 0 | 1 | 2;
+  orderFilter?: OrderFilterV5;
+  orderStatus?: OrderStatusV5;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface GetAccountHistoricOrdersPArams {
+  category: CategoryV5;
+  symbol?: string;
+  baseCoin?: string;
+  orderId?: string;
+  orderLinkId?: string;
+  orderFilter?: OrderFilterV5;
+  orderStatus?: OrderStatusV5;
+  startTime?: number;
+  endTime?: number;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface CancelAllOrdersParamsV5 {
+  category: CategoryV5;
+  symbol?: string;
+  baseCoin?: string;
+  settleCoin?: string;
+  orderFilter?: OrderFilterV5;
+}
+
+export interface BatchOrderParamsV5 {
+  symbol: string;
+  side: OrderSideV5;
+  orderType: OrderTypeV5;
+  qty: string;
+  price?: string;
+  orderIv?: string;
+  timeInForce?: OrderTimeInForceV5;
+  orderLinkId: string;
+  reduceOnly?: boolean;
+  mmp?: boolean;
+  smpType?: OrderSMPTypeV5;
+}
+
+export interface BatchAmendOrderParamsV5 {
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+  qty?: string;
+  price?: string;
+  orderIv?: string;
+}
+
+export interface BatchCancelOrderParamsV5 {
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+}

package/src/types/request/v5-user.ts

@@ -0,0 +1,21 @@
+import { PermissionsV5 } from '../v5-shared';
+
+export interface CreateSubApiKeyParamsV5 {
+  subuid: number;
+  note?: string;
+  readOnly: 0 | 1;
+  ips?: string[];
+  permissions: PermissionsV5;
+}
+
+export interface UpdateApiKeyParamsV5 {
+  readOnly?: 0 | 1;
+  ips?: string[];
+  permissions: PermissionsV5;
+}
+
+export interface UpdateSubApiKeyUpdateParamsV5 {
+  readOnly?: number;
+  ips?: string[];
+  permissions: PermissionsV5;
+}

package/src/types/response/account-asset.ts

@@ -0,0 +1,236 @@
+export interface UniversalTransferCreateResponse {
+  transferId: string;
+}
+
+export interface UniversalTransferListResponseV3 {
+  list: {
+    transferId: string;
+    coin: string;
+    amount: string;
+    timestamp: string;
+    status: string;
+    fromAccountType: string;
+    toAccountType: string;
+    fromMemberId: string;
+    toMemberId: string;
+  }[];
+  nextPageCursor: string;
+}
+
+export interface QueryInternalTransferSResponseV3 {
+  list: {
+    transferId: string;
+    coin: string;
+    amount: string;
+    fromAccountType: string;
+    toAccountType: string;
+    timestamp: string;
+    status: string;
+  }[];
+  nextPageCursor: string;
+}
+
+export interface SubAccountTransferResponseV3 {
+  list: {
+    transferId: string;
+    coin: string;
+    amount: string;
+    memberId: number;
+    subMemberId: number;
+    timestamp: string;
+    status: string;
+    type: 'IN' | 'OUT';
+  }[];
+  nextPageCursor: string;
+}
+
+export interface AccountCoinBalanceResponseV3 {
+  accountType: string;
+  bizType: number;
+  accountId: string;
+  memberId: string;
+  balance: {
+    coin: string;
+    walletBalance: string;
+    transferBalance: string;
+    bonus: string;
+  };
+}
+
+export interface AccountCoinBalancesResponseV3 {
+  accountType: string;
+  memberId: string;
+  balance: {
+    coin: string;
+    walletBalance: string;
+    transferBalance: string;
+    bonus: string;
+  }[];
+}
+
+export interface AssetInfoResponseV3 {
+  spot: {
+    status: 'ACCOUNT_STATUS_NORMAL' | 'ACCOUNT_STATUS_UNSPECIFIED';
+    assets: {
+      coin: string;
+      frozen: string;
+      free: string;
+      withdraw: string;
+    }[];
+  };
+}
+
+interface SupportedDepositV3 {
+  coin: string;
+  chain: string;
+  coinShowName: string;
+  chainType: string;
+  blockConfirmNumber: number;
+  minDepositAmount: string;
+}
+
+export interface SupportedDepositListResponseV3 {
+  configList: SupportedDepositV3[];
+  nextPageCursor: string;
+}
+
+interface DepositRecordV3 {
+  coin: string;
+  chain: string;
+  amount: string;
+  txID: string;
+  status: number;
+  toAddress: string;
+  tag: string;
+  depositFee: string;
+  successAt: string;
+  confirmations: string;
+  txIndex: string;
+  blockHash: string;
+}
+
+export interface DepositRecordQueryResponseV3 {
+  rows: DepositRecordV3[];
+  nextPageCursor: string;
+}
+
+export interface WithdrawRecordsQueryResponseV3 {
+  rows: {
+    coin: string;
+    chain: string;
+    amount: string;
+    txID: string;
+    status: number;
+    toAddress: string;
+    tag: string;
+    withdrawFee: string;
+    createTime: string;
+    updateTime: string;
+    withdrawId: string;
+    withdrawType: number;
+  }[];
+  nextPageCursor: string;
+}
+
+export interface CoinInfoV3 {
+  name: string;
+  coin: string;
+  remainAmount: string;
+  chains: {
+    chainType: string;
+    confirmation: string;
+    withdrawFee: string;
+    depositMin: string;
+    withdrawMin: string;
+    chain: string;
+    chainDeposit: string;
+    chainWithdraw: string;
+    minAccuracy: string;
+  }[];
+}
+
+export interface CoinInfoQueryResponseV3 {
+  rows: CoinInfoV3[];
+}
+
+export interface DepositAddressChainV3 {
+  chainType: string;
+  addressDeposit: string;
+  tagDeposit: string;
+  chain: string;
+}
+
+export interface DepositAddressResponseV3 {
+  coin: string;
+  chains: DepositAddressChainV3[];
+}
+
+export interface CreateSubMemberResponseV3 {
+  uid: number;
+  username: string;
+  memberType: 1 | 6;
+  switch: 0 | 1;
+  note: string;
+}
+
+export interface CreateSubAPIKeyResponseV3 {
+  id: string;
+  note: string;
+  apiKey: string;
+  readOnly: string;
+  secret: string;
+  permissions: {
+    ContractTrade: string[];
+    Spot: string[];
+    Wallet: string[];
+    Options: string[];
+    Derivatives: string[];
+    CopyTrading: string[];
+    BlockTrade: string[];
+    Exchange: string[];
+    NFT: string[];
+  };
+}
+
+export interface SubMemberV3 {
+  uid: string;
+  username: string;
+  memberType: 1 | 6;
+  status: 1 | 2 | 4;
+  remark: string;
+}
+
+export interface SubMemberResponseV3 {
+  subMembers: SubMemberV3[];
+}
+
+export interface APIKeyInfoV3 {
+  id: string;
+  note: string;
+  apiKey: string;
+  readOnly: string;
+  secret: string;
+  permissions: {
+    ContractTrade: string[];
+    Spot: string[];
+    Wallet: string[];
+    Options: string[];
+    Derivatives: string[];
+    CopyTrading: string[];
+    BlockTrade: string[];
+    Exchange: string[];
+    NFT: string[];
+  };
+  ips: string[];
+  type: number;
+  deadlineDay: number;
+  expiredAt: string;
+  createdAt: string;
+  unified: number;
+  uta: number;
+  userID: number;
+  inviterID: number;
+  vipLevel: string;
+  mktMakerLevel: string;
+  affiliateID: number;
+}

package/src/types/response/contract.ts

@@ -0,0 +1,74 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface PaginatedResult<TList = any> {
+  nextPageCursor: string;
+  list: TList[];
+}
+export interface ContractListResult<TList = any> {
+  category: string;
+  list: TList[];
+}
+
+export interface ContractHistoricOrder {
+  symbol: string;
+  orderId: string;
+  orderLinkId: string;
+  side: string;
+  orderType: string;
+  price: string;
+  iv: string;
+  qty: string;
+  timeInForce: string;
+  orderStatus: string;
+  positionIdx: number;
+  lastPriceOnCreated: string;
+  createdTime: string;
+  updatedTime: string;
+  cancelType: string;
+  rejectReason: string;
+  stopOrderType: string;
+  triggerDirection: number;
+  triggerBy: string;
+  triggerPrice: string;
+  cumExecValue: string;
+  cumExecFee: string;
+  cumExecQty: string;
+  leavesValue: string;
+  leavesQty: string;
+  takeProfit: string;
+  stopLoss: string;
+  tpslMode: string;
+  tpLimitPrice: string;
+  slLimitPrice: string;
+  tpTriggerBy: string;
+  slTriggerBy: string;
+  reduceOnly: boolean;
+  closeOnTrigger: boolean;
+  blockTradeId: string;
+  smpType: string;
+  smpGroup: number;
+  smpOrderId: string;
+}
+
+export interface ContractSymbolTicker {
+  symbol: string;
+  bidPrice: string;
+  askPrice: string;
+  lastPrice: string;
+  lastTickDirection: string;
+  prevPrice24h: string;
+  price24hPcnt: string;
+  highPrice24h: string;
+  lowPrice24h: string;
+  prevPrice1h: string;
+  markPrice: string;
+  indexPrice: string;
+  openInterest: string;
+  turnover24h: string;
+  volume24h: string;
+  fundingRate: string;
+  nextFundingTime: string;
+  predictedDeliveryPrice: string;
+  basisRate: string;
+  deliveryFeeRate: string;
+  deliveryTime: string;
+}

package/src/types/response/index.ts

@@ -0,0 +1,13 @@
+export * from './account-asset';
+export * from './contract';
+export * from './shared';
+export * from './spot';
+export * from './usdt-perp';
+export * from './unified-margin';
+export * from './v5-account';
+export * from './v5-asset';
+export * from './v5-market';
+export * from './v5-position';
+export * from './v5-trade';
+export * from './v5-user';
+export * from './v5-spot-leverage-token';

package/src/types/response/shared.ts

@@ -0,0 +1,19 @@
+export interface SymbolWalletBalance {
+  equity: number;
+  available_balance: number;
+  used_margin: number;
+  order_margin: number;
+  position_margin: number;
+  occ_closing_fee: number;
+  occ_funding_fee: number;
+  wallet_balance: number;
+  realised_pnl: number;
+  unrealised_pnl: number;
+  cum_realised_pnl: number;
+  given_cash: number;
+  service_cash: number;
+}
+
+export interface WalletBalances {
+  [symbol: string]: SymbolWalletBalance | undefined;
+}

package/src/types/response/spot.ts

@@ -0,0 +1,17 @@
+export interface SpotBalance {
+  coin: string;
+  coinId: string;
+  coinName: string;
+  total: string;
+  free: string;
+  locked: string;
+}
+
+export interface SpotBalances {
+  balances: SpotBalance[];
+}
+
+export interface SpotLastPrice {
+  symbol: string;
+  price: string;
+}

package/src/types/response/unified-margin.ts

@@ -0,0 +1,71 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export interface UMPaginatedResult<List = any> {
+  nextPageCursor: string;
+  category: string;
+  list: List[];
+}
+
+export interface UMLeverageFilter {
+  minLeverage: string;
+  maxLeverage: string;
+  leverageStep: string;
+}
+
+export interface UMPriceFilter {
+  minPrice: string;
+  maxPrice: string;
+  tickSize: string;
+}
+
+export interface UMLotSizeFilter {
+  maxTradingQty: string;
+  minTradingQty: string;
+  qtyStep: string;
+}
+
+export interface UMInstrumentInfo {
+  symbol: string;
+  contractType: string;
+  status: string;
+  baseCoin: string;
+  quoteCoin: string;
+  launchTime: string;
+  deliveryTime: string;
+  deliveryFeeRate: string;
+  priceScale: string;
+  leverageFilter: UMLeverageFilter;
+  priceFilter: UMPriceFilter;
+  lotSizeFilter: UMLotSizeFilter;
+}
+
+export interface UMHistoricOrder {
+  symbol: string;
+  orderType: string;
+  orderLinkId: string;
+  orderId: string;
+  stopOrderType: string;
+  orderStatus: string;
+  takeProfit: string;
+  cumExecValue: string;
+  blockTradeId: string;
+  rejectReason: string;
+  price: string;
+  createdTime: number;
+  tpTriggerBy: string;
+  timeInForce: string;
+  basePrice: string;
+  leavesValue: string;
+  updatedTime: number;
+  side: string;
+  triggerPrice: string;
+  cumExecFee: string;
+  slTriggerBy: string;
+  leavesQty: string;
+  closeOnTrigger: boolean;
+  cumExecQty: string;
+  reduceOnly: boolean;
+  qty: string;
+  stopLoss: string;
+  triggerBy: string;
+  orderIM: string;
+}

package/src/types/response/usdt-perp.ts

@@ -0,0 +1,58 @@
+export interface PerpPosition {
+  user_id: number;
+  symbol: string;
+  side: string;
+  size: number;
+  position_value: number;
+  entry_price: number;
+  liq_price: number;
+  bust_price: number;
+  leverage: number;
+  auto_add_margin: number;
+  is_isolated: boolean;
+  position_margin: number;
+  occ_closing_fee: number;
+  realised_pnl: number;
+  cum_realised_pnl: number;
+  free_qty: number;
+  tp_sl_mode: string;
+  unrealised_pnl: number;
+  deleverage_indicator: number;
+  risk_id: number;
+  stop_loss: number;
+  take_profit: number;
+  trailing_stop: number;
+  position_idx: number;
+  mode: string;
+}
+
+export interface PerpPositionRoot {
+  data: PerpPosition;
+  is_valid: boolean;
+}
+
+export interface LinearOrder {
+  order_id: string;
+  user_id: number;
+  symbol: string;
+  side: string;
+  order_type: string;
+  price: number;
+  qty: number;
+  time_in_force: string;
+  order_status: string;
+  last_exec_price: number;
+  cum_exec_qty: number;
+  cum_exec_value: number;
+  cum_exec_fee: number;
+  reduce_only: boolean;
+  close_on_trigger: boolean;
+  order_link_id: string;
+  created_time: string;
+  updated_time: string;
+  take_profit: number;
+  stop_loss: number;
+  tp_trigger_by: string;
+  sl_trigger_by: string;
+  position_idx: number;
+}