bybit-api 3.7.1-beta.0 → 3.7.1

package/src/types/response/v5-spot-leverage-token.ts

@@ -1,70 +0,0 @@
-import {
-  LTOrderStatusV5,
-  LTOrderTypeV5,
-  LeverageTokenStatusV5,
-} from '../v5-shared';
-
-export interface LeverageTokenInfoV5 {
-  ltCoin: string;
-  ltName: string;
-  maxPurchase: string;
-  minPurchase: string;
-  maxPurchaseDaily: string;
-  maxRedeem: string;
-  minRedeem: string;
-  maxRedeemDaily: string;
-  purchaseFeeRate: string;
-  redeemFeeRate: string;
-  ltStatus: LeverageTokenStatusV5;
-  fundFee: string;
-  fundFeeTime: string;
-  manageFeeRate: string;
-  manageFeeTime: string;
-  value: string;
-  netValue: string;
-  total: string;
-}
-
-export interface LeveragedTokenMarketResultV5 {
-  ltCoin: string;
-  nav: string;
-  navTime: string;
-  circulation: string;
-  basket: string;
-  leverage: string;
-}
-
-export interface PurchaseSpotLeveragedTokenResultV5 {
-  ltCoin: string;
-  ltOrderStatus: LTOrderStatusV5;
-  execQty: string;
-  execAmt: string;
-  amount: string;
-  purchaseId: string;
-  serialNo: string;
-  valueCoin: string;
-}
-export interface RedeemSpotLeveragedTokenResultV5 {
-  ltCoin: string;
-  ltOrderStatus: LTOrderStatusV5;
-  quantity: string;
-  execQty: string;
-  execAmt: string;
-  redeemId: string;
-  serialNo: string;
-  valueCoin: string;
-}
-
-export interface SpotLeveragedTokenOrderHistoryV5 {
-  ltCoin: string;
-  orderId: string;
-  ltOrderType: LTOrderTypeV5;
-  orderTime: number;
-  updateTime: number;
-  ltOrderStatus: LTOrderStatusV5;
-  fee: string;
-  amount: string;
-  value: string;
-  valueCoin: string;
-  serialNo: string;
-}

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

@@ -1,103 +0,0 @@
-import {
-  CategoryV5,
-  OrderCancelTypeV5,
-  OrderRejectReasonV5,
-  OrderSideV5,
-  OrderStatusV5,
-  OrderTimeInForceV5,
-  OrderTriggerByV5,
-  OrderTypeV5,
-  PositionIdx,
-  StopOrderTypeV5,
-} from '../v5-shared';
-
-export interface OrderResultV5 {
-  orderId: string;
-  orderLinkId: string;
-}
-
-export interface AccountOrderV5 {
-  orderId: string;
-  orderLinkId?: string;
-  blockTradeId?: string;
-  symbol: string;
-  price: string;
-  qty: string;
-  side: OrderSideV5;
-  isLeverage?: string;
-  positionIdx?: PositionIdx;
-  orderStatus: OrderStatusV5;
-  cancelType?: OrderCancelTypeV5;
-  rejectReason?: OrderRejectReasonV5;
-  avgPrice: string;
-  leavesQty: string;
-  leavesValue: string;
-  cumExecQty: string;
-  cumExecValue: string;
-  cumExecFee: string;
-  timeInForce?: OrderTimeInForceV5;
-  orderType?: OrderTypeV5;
-  stopOrderType?: StopOrderTypeV5;
-  orderIv?: string;
-  triggerPrice?: string;
-  takeProfit?: string;
-  stopLoss?: string;
-  tpslMode: 'Full' | 'Partial' | '';
-  tpLimitPrice: string;
-  slLimitPrice: string;
-  tpTriggerBy?: OrderTriggerByV5;
-  slTriggerBy?: OrderTriggerByV5;
-  triggerDirection?: number;
-  triggerBy?: OrderTriggerByV5;
-  lastPriceOnCreated?: string;
-  reduceOnly?: boolean;
-  closeOnTrigger?: boolean;
-  placeType: 'iv' | 'price' | '';
-  smpType: string;
-  smpGroup: string;
-  smpOrderId: string;
-  createdTime: string;
-  updatedTime: string;
-}
-
-export interface BatchCreateOrderResultV5 {
-  category: CategoryV5;
-  symbol: string;
-  orderId: string;
-  orderLinkId: string;
-  createAt: string;
-}
-
-export interface BatchOrdersResponseV5<T extends unknown[]> {
-  result: {
-    list: T;
-  };
-  retExtInfo: {
-    list: {
-      code: number;
-      msg: string;
-    }[];
-  };
-}
-
-export interface BatchAmendOrderResultV5 {
-  category: CategoryV5;
-  symbol: string;
-  orderId: string;
-  orderLinkId: string;
-}
-
-export interface BatchCancelOrderResultV5 {
-  category: CategoryV5;
-  symbol: string;
-  orderId: string;
-  orderLinkId: string;
-}
-
-export interface SpotBorrowCheckResultV5 {
-  symbol: string;
-  side: OrderSideV5;
-  maxTradeQty: string;
-  maxTradeAmount: string;
-  borrowCoin: string;
-}

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

@@ -1,58 +0,0 @@
-import { PermissionsV5 } from '../v5-shared';
-
-export interface CreateSubMemberResultV5 {
-  uid: string;
-  username: string;
-  memberType: number;
-  status: number;
-  remark: string;
-}
-
-export interface CreateSubApiKeyResultV5 {
-  id: string;
-  note: string;
-  apiKey: string;
-  readOnly: number;
-  secret: string;
-  permissions: PermissionsV5;
-}
-
-export interface SubMemberV5 {
-  uid: string;
-  username: string;
-  memberType: number;
-  status: number;
-  remark: string;
-}
-export type ApiKeyType = 1 | 2;
-
-export interface ApiKeyInfoV5 {
-  id: string;
-  note: string;
-  apiKey: string;
-  readOnly: 0 | 1;
-  secret: string;
-  permissions: PermissionsV5;
-  ips?: string[];
-  type: 1 | 2;
-  deadlineDay?: number;
-  expiredAt?: string;
-  createdAt: string;
-  unified: 0 | 1;
-  uta: 0 | 1;
-  userID: number;
-  inviterID: number;
-  vipLevel?: string;
-  mktMakerLevel?: string;
-  affiliateID?: number;
-}
-
-export interface UpdateApiKeyResultV5 {
-  id: string;
-  note: string;
-  apiKey: string;
-  readOnly: 0 | 1;
-  secret: string;
-  permissions: PermissionsV5;
-  ips: string[];
-}

package/src/types/shared.ts

@@ -1,175 +0,0 @@
-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 numberInString = string;
-
-export type OrderSide = 'Buy' | 'Sell';
-
-export type KlineInterval =
-  | '1m'
-  | '3m'
-  | '5m'
-  | '15m'
-  | '30m'
-  | '1h'
-  | '2h'
-  | '4h'
-  | '6h'
-  | '12h'
-  | '1d'
-  | '1w'
-  | '1M';
-
-export type KlineIntervalV3 =
-  | '1'
-  | '3'
-  | '5'
-  | '15'
-  | '30'
-  | '60'
-  | '120'
-  | '240'
-  | '360'
-  | '720'
-  | 'D'
-  | '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 APIResponseV3<T> {
-  retCode: number;
-  retMsg: 'OK' | string;
-  result: T;
-}
-
-export interface APIResponseV3WithTime<T> {
-  retCode: number;
-  retMsg: 'OK' | string;
-  result: T;
-  time: number;
-}
-
-export interface APIResponseWithTime<T = {}> extends APIResponse<T> {
-  /** UTC timestamp */
-  time_now: numberInString;
-}
-
-/**
- * Request Parameter Types
- */
-export interface SymbolParam {
-  symbol: string;
-}
-
-export interface SymbolLimitParam<TLimit = number> {
-  symbol: string;
-  limit?: TLimit;
-}
-
-export interface SymbolPeriodLimitParam<TLimit = number> {
-  symbol: string;
-  period: string;
-  limit?: TLimit;
-}
-
-export interface SymbolFromLimitParam {
-  symbol: string;
-  from?: number;
-  limit?: number;
-}
-
-export interface SymbolIntervalFromLimitParam {
-  symbol: string;
-  interval: string;
-  from: number;
-  limit?: number;
-}
-
-export interface CoinParam {
-  coin: string;
-}
-
-export interface WalletFundRecordsReq {
-  start_date?: string;
-  end_date?: string;
-  currency?: string;
-  coin?: string;
-  wallet_fund_type?: string;
-  page?: number;
-  limit?: number;
-}
-
-export interface WithdrawRecordsReq {
-  start_date?: string;
-  end_date?: string;
-  coin?: string;
-  status?: string;
-  page?: number;
-  limit?: number;
-}
-
-export interface AssetExchangeRecordsReq {
-  limit?: number;
-  from?: number;
-  direction?: string;
-}
-
-/**
- * Response types
- */
-
-export interface LeverageFilter {
-  min_leverage: numberInString;
-  max_leverage: numberInString;
-  leverage_step: numberInString;
-}
-export interface PriceFilter {
-  min_price: numberInString;
-  max_price: numberInString;
-  tick_size: numberInString;
-}
-
-export interface LotSizeFilter {
-  max_trading_qty: number;
-  min_trading_qty: number;
-  qty_step: number;
-}
-
-export interface SymbolInfo {
-  name: string;
-  alias: string;
-  status: 'Trading' | string;
-  base_currency: string;
-  quote_currency: string;
-  price_scale: number;
-  taker_fee: numberInString;
-  maker_fee: numberInString;
-  leverage_filter: LeverageFilter;
-  price_filter: PriceFilter;
-  lot_size_filter: LotSizeFilter;
-}

package/src/types/v5-shared.ts

@@ -1,213 +0,0 @@
-export type CategoryV5 = 'spot' | 'linear' | 'inverse' | 'option';
-export type ContractTypeV5 =
-  | 'InversePerpetual'
-  | 'LinearPerpetual'
-  | 'InverseFutures';
-
-export type InstrumentStatusV5 =
-  | 'PreLaunch'
-  | 'Trading'
-  | 'Settling'
-  | 'Delivering'
-  | 'Closed';
-
-export type OrderFilterV5 = 'Order' | 'tpslOrder';
-export type OrderSideV5 = 'Buy' | 'Sell';
-export type OrderTypeV5 = 'Market' | 'Limit';
-export type OrderTimeInForceV5 = 'GTC' | 'IOC' | 'FOK' | 'PostOnly';
-export type OrderTriggerByV5 = 'LastPrice' | 'IndexPrice' | 'MarkPrice';
-
-export type OrderSMPTypeV5 =
-  | 'None'
-  | 'CancelMaker'
-  | 'CancelTaker'
-  | 'CancelBoth';
-
-export type OrderStatusV5 =
-  | 'Created'
-  | 'New'
-  | 'Rejected'
-  | 'PartiallyFilled'
-  | 'PartiallyFilledCanceled'
-  | 'Filled'
-  | 'Cancelled'
-  | 'Untriggered'
-  | 'Triggered'
-  | 'Deactivated'
-  | 'Active';
-
-export type OrderCancelTypeV5 =
-  | 'CancelByUser'
-  | 'CancelByReduceOnly'
-  | 'CancelByPrepareLiq'
-  | 'CancelAllBeforeLiq'
-  | 'CancelByPrepareAdl'
-  | 'CancelAllBeforeAdl'
-  | 'CancelByAdmin'
-  | 'CancelByTpSlTsClear'
-  | 'CancelByPzSideCh';
-
-export type OrderRejectReasonV5 =
-  | 'EC_NoError'
-  | 'EC_Others'
-  | 'EC_UnknownMessageType'
-  | 'EC_MissingClOrdID'
-  | 'EC_MissingOrigClOrdID'
-  | 'EC_ClOrdIDOrigClOrdIDAreTheSame'
-  | 'EC_DuplicatedClOrdID'
-  | 'EC_OrigClOrdIDDoesNotExist'
-  | 'EC_TooLateToCancel'
-  | 'EC_UnknownOrderType'
-  | 'EC_UnknownSide'
-  | 'EC_UnknownTimeInForce'
-  | 'EC_WronglyRouted'
-  | 'EC_MarketOrderPriceIsNotZero'
-  | 'EC_LimitOrderInvalidPrice'
-  | 'EC_NoEnoughQtyToFill'
-  | 'EC_NoImmediateQtyToFill'
-  | 'EC_PerCancelRequest'
-  | 'EC_MarketOrderCannotBePostOnly'
-  | 'EC_PostOnlyWillTakeLiquidity'
-  | 'EC_CancelReplaceOrder'
-  | 'EC_InvalidSymbolStatus';
-
-export type StopOrderTypeV5 =
-  | 'TakeProfit'
-  | 'StopLoss'
-  | 'TrailingStop'
-  | 'Stop'
-  | 'PartialTakeProfit'
-  | 'PartialStopLoss'
-  | 'tpslOrder';
-
-/**
- * Position index. Used to identify positions in different position modes.
- *
- * - 0 one-way mode position
- * - 1 Buy side of hedge-mode position
- * - 2 Sell side of hedge-mode position
- */
-export type PositionIdx = 0 | 1 | 2;
-
-export type OptionTypeV5 = 'Call' | 'Put';
-
-/**
- * Trade mode.
- *
- * - 0 cross-margin,
- * - 1 isolated margin
- */
-export type TradeModeV5 = 0 | 1;
-
-export type TPSLModeV5 = 'Full' | 'Partial';
-export type AccountMarginModeV5 = 'REGULAR_MARGIN' | 'PORTFOLIO_MARGIN';
-export type UnifiedUpdateStatusV5 = 'FAIL' | 'PROCESS' | 'SUCCESS';
-
-export type AccountTypeV5 =
-  | 'CONTRACT'
-  | 'SPOT'
-  | 'INVESTMENT'
-  | 'OPTION'
-  | 'UNIFIED'
-  | 'FUND';
-
-export type TransactionTypeV5 =
-  | 'TRANSFER_IN'
-  | 'TRANSFER_OUT'
-  | 'TRADE'
-  | 'SETTLEMENT'
-  | 'DELIVERY'
-  | 'LIQUIDATION'
-  | 'BONUS'
-  | 'FEE_REFUND'
-  | 'INTEREST'
-  | 'CURRENCY_BUY'
-  | 'CURRENCY_SELL';
-
-export type PermissionTypeV5 =
-  | 'ContractTrade'
-  | 'Spot'
-  | 'Wallet'
-  | 'Options'
-  | 'Derivatives'
-  | 'Exchange'
-  | 'NFT';
-
-/**
- * Leveraged token status:
- *
- * - '1' LT can be purchased and redeemed
- * - '2' LT can be purchased, but not redeemed
- * - '3' LT can be redeemed, but not purchased
- * - '4' LT cannot be purchased nor redeemed
- * - '5' Adjusting position
- */
-export type LeverageTokenStatusV5 = '1' | '2' | '3' | '4' | '5';
-
-/**
- * Leveraged token order type: '1': purchase, '2': redeem
- */
-export type LTOrderTypeV5 = '1' | '2';
-
-/**
- * Leveraged token order status: '1': completed, '2': in progress, '3': failed
- */
-export type LTOrderStatusV5 = '1' | '2' | '3';
-
-export type ExecTypeV5 =
-  | 'Trade'
-  | 'AdlTrade'
-  | 'Funding'
-  | 'BustTrade'
-  | 'Settle';
-
-/**
- * Withdraw type. 0(default): on chain. 1: off chain. 2: all.
- */
-export type WithdrawalTypeV5 = '0' | '1' | '2';
-
-export interface PermissionsV5 {
-  ContractTrade?: string[];
-  Spot?: string[];
-  Wallet?: string[];
-  Options?: string[];
-  Derivatives?: string[];
-  CopyTrading?: string[];
-  BlockTrade?: string[];
-  Exchange?: string[];
-  NFT?: string[];
-}
-
-export interface CategoryCursorListV5<
-  T extends unknown[],
-  TCategory extends CategoryV5 = CategoryV5,
-> {
-  category: TCategory;
-  list: T;
-  nextPageCursor?: string;
-}
-
-/**
- * Next page cursor does not exist for spot!
- */
-export interface CursorListV5<T extends unknown[]> {
-  nextPageCursor: string;
-  list: T;
-}
-
-export interface CategoryListV5<
-  T extends unknown[],
-  TCategory extends CategoryV5,
-> {
-  category: TCategory;
-  list: T;
-}
-
-export interface CategorySymbolListV5<
-  T extends unknown[],
-  TCategory extends CategoryV5,
-> {
-  category: TCategory;
-  symbol: string;
-  list: T;
-}