bybit-api 3.6.1 → 3.7.1-beta.0

package/src/types/request/linear.ts

@@ -0,0 +1,201 @@
+import {
+  LinearPositionIdx,
+  linearPositionModeEnum,
+  positionTpSlModeEnum,
+} from '../../constants/enum';
+import { OrderSide } from '../shared';
+
+export interface LinearGetOrdersRequest {
+  order_id?: string;
+  order_link_id?: string;
+  symbol: string;
+  order?: string;
+  page?: number;
+  limit?: number;
+  order_status?: string;
+}
+
+export interface LinearCancelOrderRequest {
+  symbol: string;
+  order_id?: string;
+  order_link_id?: string;
+}
+
+export interface LinearReplaceOrderRequest {
+  order_id?: string;
+  order_link_id?: string;
+  symbol: string;
+  p_r_qty?: number;
+  p_r_price?: number;
+  take_profit?: number;
+  stop_loss?: number;
+  tp_trigger_by?: string;
+  sl_trigger_by?: string;
+}
+
+export interface LinearGetOrderRequest {
+  order_id?: string;
+  order_link_id?: string;
+  symbol: string;
+}
+
+export type LinearOrderType = 'Limit' | 'Market';
+
+export type LinearTimeInForce =
+  | 'GoodTillCancel'
+  | 'ImmediateOrCancel'
+  | 'FillOrKill'
+  | 'PostOnly';
+
+export interface NewLinearOrder {
+  side: OrderSide;
+  symbol: string;
+  order_type: LinearOrderType;
+  qty: number;
+  price?: number;
+  time_in_force: LinearTimeInForce;
+  take_profit?: number;
+  stop_loss?: number;
+  tp_trigger_by?: string;
+  sl_trigger_by?: string;
+  reduce_only: boolean;
+  close_on_trigger: boolean;
+  order_link_id?: string;
+  position_idx?: LinearPositionIdx;
+}
+
+export interface LinearConditionalOrderRequest {
+  side: string;
+  symbol: string;
+  order_type: string;
+  qty: number;
+  price?: number;
+  base_price: number;
+  stop_px: number;
+  time_in_force: string;
+  trigger_by?: string;
+  close_on_trigger?: boolean;
+  order_link_id?: string;
+  reduce_only: boolean;
+  take_profit?: number;
+  stop_loss?: number;
+  tp_trigger_by?: string;
+  sl_trigger_by?: string;
+}
+
+export interface LinearGetConditionalOrderRequest {
+  stop_order_id?: string;
+  order_link_id?: string;
+  symbol: string;
+  stop_order_status?: string;
+  order?: string;
+  page?: number;
+  limit?: number;
+}
+
+export interface LinearCancelConditionalOrderRequest {
+  symbol: string;
+  stop_order_id?: string;
+  order_link_id?: string;
+}
+
+export interface LinearReplaceConditionalOrderRequest {
+  stop_order_id?: string;
+  order_link_id?: string;
+  symbol: string;
+  p_r_qty?: number;
+  p_r_price?: number;
+  p_r_trigger_price?: number;
+  take_profit?: number;
+  stop_loss?: number;
+  tp_trigger_by?: string;
+  sl_trigger_by?: string;
+}
+
+export interface LinearQueryConditionalOrderRequest {
+  symbol: string;
+  stop_order_id?: string;
+  order_link_id?: string;
+}
+
+export interface LinearSetAutoAddMarginRequest {
+  symbol: string;
+  side: string;
+  auto_add_margin: boolean;
+}
+
+export interface LinearSetMarginSwitchRequest {
+  symbol: string;
+  is_isolated: boolean;
+  buy_leverage: number;
+  sell_leverage: number;
+}
+
+export interface LinearSetPositionModeRequest {
+  symbol: string;
+  mode: typeof linearPositionModeEnum[keyof typeof linearPositionModeEnum];
+}
+
+export interface LinearSetPositionTpSlModeRequest {
+  symbol: string;
+  tp_sl_mode: typeof positionTpSlModeEnum[keyof typeof positionTpSlModeEnum];
+}
+
+export interface LinearSetAddReduceMarginRequest {
+  symbol: string;
+  side: string;
+  margin: number;
+}
+
+export interface LinearSetUserLeverageRequest {
+  symbol: string;
+  buy_leverage: number;
+  sell_leverage: number;
+}
+
+export interface LinearSetTradingStopRequest {
+  symbol: string;
+  side: string;
+  take_profit?: number;
+  stop_loss?: number;
+  trailing_stop?: number;
+  tp_trigger_by?: string;
+  sl_trigger_by?: string;
+  sl_size?: number;
+  tp_size?: number;
+  position_idx?: 0 | 1 | 2;
+}
+
+export interface LinearGetTradeRecordsRequest {
+  symbol: string;
+  start_time?: number;
+  end_time?: number;
+  exec_type?: string;
+  page?: number;
+  limit?: number;
+}
+
+export interface LinearGetHistoryTradeRecordsRequest {
+  symbol: string;
+  start_time?: number;
+  end_time?: number;
+  exec_type?: string;
+  page?: number;
+  limit?: number;
+  page_token?: string;
+}
+
+export interface LinearGetClosedPnlRequest {
+  symbol: string;
+  start_time?: number;
+  end_time?: number;
+  exec_type?: string;
+  page?: number;
+  limit?: number;
+}
+
+export interface LinearSetRiskLimitRequest {
+  symbol: string;
+  side: string;
+  risk_id: number;
+}

package/src/types/request/spot.ts

@@ -0,0 +1,89 @@
+import { OrderSide, numberInString } from '../shared';
+
+export type OrderTypeSpot = 'LIMIT' | 'MARKET' | 'LIMIT_MAKER';
+export type OrderTimeInForce = 'GTC' | 'FOK' | 'IOC';
+
+export interface NewSpotOrder {
+  symbol: string;
+  qty: number;
+  side: OrderSide;
+  type: OrderTypeSpot;
+  timeInForce?: OrderTimeInForce;
+  price?: number;
+  orderLinkId?: string;
+}
+
+export interface NewSpotOrderV3 {
+  symbol: string;
+  orderQty: string;
+  side: OrderSide;
+  orderType: OrderTypeSpot;
+  timeInForce?: OrderTimeInForce;
+  orderPrice?: string;
+  orderLinkId?: string;
+  orderCategory?: 0 | 1;
+  triggerPrice?: string;
+}
+
+export interface SpotCancelOrderBatchRequest {
+  symbol: string;
+  side?: OrderSide;
+  orderTypes: OrderTypeSpot[];
+  orderCategory?: 0 | 1;
+}
+
+export interface SpotOrderQueryById {
+  orderId?: string;
+  orderLinkId?: string;
+  orderCategory?: 0 | 1;
+}
+
+export interface SpotSymbolInfo {
+  name: string;
+  alias: string;
+  baseCurrency: string;
+  quoteCurrency: string;
+  basePrecision: numberInString;
+  quotePrecision: numberInString;
+  minTradeQuantity: numberInString;
+  minTradeAmount: numberInString;
+  minPricePrecision: numberInString;
+  maxTradeQuantity: numberInString;
+  maxTradeAmount: numberInString;
+  category: numberInString;
+}
+
+export interface SpotMyTradesRequest {
+  symbol?: string;
+  orderId?: string;
+  limit?: string;
+  startTime?: number;
+  endTime?: number;
+  fromTradeId?: string;
+  toTradeId?: string;
+}
+
+export interface SpotLeveragedTokenPRHistoryRequest {
+  ltCode?: string;
+  orderId?: string;
+  startTime?: number;
+  endTime?: number;
+  limit?: number;
+  orderType?: 1 | 2;
+  serialNo?: string;
+}
+
+export interface SpotCrossMarginBorrowingInfoRequest {
+  startTime?: number;
+  endTime?: number;
+  coin?: string;
+  status?: 0 | 1 | 2;
+  limit?: number;
+}
+
+export interface SpotCrossMarginRepaymentHistoryRequest {
+  startTime?: number;
+  endTime?: number;
+  coin?: string;
+  limit?: number;
+}

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

@@ -0,0 +1,247 @@
+import { KlineIntervalV3, OrderSide } from '../shared';
+import { USDCOrderFilter, USDCTimeInForce } from './usdc-shared';
+
+export type UMCategory = 'linear' | 'inverse' | 'option';
+export type UMOrderType = 'Limit' | 'Market';
+export type UMDirection = 'prev' | 'next';
+
+export interface UMCandlesRequest {
+  category: UMCategory;
+  symbol: string;
+  interval: KlineIntervalV3;
+  start: number;
+  end: number;
+  limit?: number;
+}
+
+export interface UMInstrumentInfoRequest {
+  category: UMCategory;
+  symbol?: string;
+  baseCoin?: string;
+  limit?: string;
+  cursor?: string;
+}
+
+export interface UMFundingRateHistoryRequest {
+  category: UMCategory;
+  symbol: string;
+  startTime?: number;
+  endTime?: number;
+  limit?: number;
+}
+
+export interface UMOptionDeliveryPriceRequest {
+  category: UMCategory;
+  symbol?: string;
+  baseCoin?: string;
+  direction?: UMDirection;
+  limit?: string;
+  cursor?: string;
+}
+
+export interface UMPublicTradesRequest {
+  category: UMCategory;
+  symbol: string;
+  baseCoin?: string;
+  optionType?: 'Call' | 'Put';
+  limit?: string;
+}
+
+export interface UMOpenInterestRequest {
+  category: UMCategory;
+  symbol: string;
+  interval: '5min' | '15min' | '30min' | '1h' | '4h' | '1d';
+  startTime?: number;
+  endTime?: number;
+  limit?: number;
+}
+
+export interface UMOrderRequest {
+  category: UMCategory;
+  symbol: string;
+  side: OrderSide;
+  positionIdx?: '0' | '1' | '2';
+  orderType: UMOrderType;
+  qty: string;
+  price?: string;
+  basePrice?: string;
+  triggerPrice?: string;
+  triggerBy?: string;
+  iv?: string;
+  timeInForce: USDCTimeInForce;
+  orderLinkId?: string;
+  takeProfit?: number;
+  stopLoss?: number;
+  tpTriggerBy?: string;
+  slTriggerBy?: string;
+  reduceOnly?: boolean;
+  closeOnTrigger?: boolean;
+  mmp?: boolean;
+}
+
+export interface UMModifyOrderRequest {
+  category: UMCategory;
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+  iv?: string;
+  triggerPrice?: string;
+  qty?: string;
+  price?: string;
+  takeProfit?: number;
+  stopLoss?: number;
+  tpTriggerBy?: string;
+  slTriggerBy?: string;
+  triggerBy?: string;
+}
+
+export interface UMCancelOrderRequest {
+  category: UMCategory;
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+  orderFilter?: USDCOrderFilter;
+}
+
+export interface UMActiveOrdersRequest {
+  category: UMCategory;
+  symbol?: string;
+  baseCoin?: string;
+  orderId?: string;
+  orderLinkId?: string;
+  orderFilter?: USDCOrderFilter;
+  direction?: UMDirection;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface UMHistoricOrdersRequest {
+  category: UMCategory;
+  symbol?: string;
+  baseCoin?: string;
+  orderId?: string;
+  orderLinkId?: string;
+  orderStatus?: string;
+  orderFilter?: USDCOrderFilter;
+  direction?: UMDirection;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface UMBatchOrder {
+  symbol: string;
+  side: OrderSide;
+  positionIdx?: '0';
+  orderType: UMOrderType;
+  qty: string;
+  price?: string;
+  iv?: string;
+  timeInForce: USDCTimeInForce;
+  orderLinkId?: string;
+  reduceOnly?: boolean;
+  closeOnTrigger?: boolean;
+  mmp?: boolean;
+}
+
+export interface UMBatchOrderReplace {
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+  iv?: string;
+  qty?: string;
+  price?: string;
+}
+
+export interface UMBatchOrderCancel {
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+}
+
+export interface UMCancelAllOrdersRequest {
+  category: UMCategory;
+  baseCoin?: string;
+  settleCoin?: string;
+  symbol?: string;
+  orderFilter?: USDCOrderFilter;
+}
+
+export interface UMPositionsRequest {
+  category: UMCategory;
+  symbol?: string;
+  baseCoin?: string;
+  direction?: UMDirection;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface UMSetTPSLRequest {
+  category: UMCategory;
+  symbol: string;
+  takeProfit?: string;
+  stopLoss?: string;
+  trailingStop?: string;
+  tpTriggerBy?: string;
+  slTriggerBy?: string;
+  activePrice?: string;
+  slSize?: string;
+  tpSize?: string;
+  positionIdx?: '0';
+}
+
+export interface UM7DayTradingHistoryRequest {
+  category: UMCategory;
+  symbol: string;
+  baseCoin?: string;
+  orderId?: string;
+  orderLinkId?: string;
+  startTime?: number;
+  endTime?: number;
+  direction?: UMDirection;
+  limit?: number;
+  cursor?: string;
+  execType?: string;
+}
+
+export interface UMOptionsSettlementHistoryRequest {
+  category: UMCategory;
+  symbol?: string;
+  expDate?: string;
+  direction?: UMDirection;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface UMPerpSettlementHistoryRequest {
+  category: UMCategory;
+  symbol?: string;
+  direction?: UMDirection;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface UMTransactionLogRequest {
+  category: UMCategory;
+  currency: string;
+  baseCoin?: string;
+  type?: string;
+  startTime?: number;
+  endTime?: number;
+  direction?: UMDirection;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface UMExchangeCoinsRequest {
+  fromCoin?: string;
+  toCoin?: string;
+}
+
+export interface UMBorrowHistoryRequest {
+  currency: string;
+  startTime?: number;
+  endTime?: number;
+  direction?: UMDirection;
+  limit?: number;
+  cursor?: string;
+}

package/src/types/request/usdc-options.ts

@@ -0,0 +1,134 @@
+import { OrderSide } from '../shared';
+import { USDCAPICategory, USDCOrderType, USDCTimeInForce } from './usdc-shared';
+
+export interface USDCOptionsContractInfoRequest {
+  symbol?: string;
+  status?: 'WAITING_ONLINE' | 'ONLINE' | 'DELIVERING' | 'OFFLINE';
+  baseCoin?: string;
+  direction?: string;
+  limit?: string;
+  cursor?: string;
+}
+
+export interface USDCOptionsDeliveryPriceRequest {
+  symbol?: string;
+  baseCoin?: string;
+  direction?: string;
+  limit?: string;
+  cursor?: string;
+}
+
+export interface USDCOptionsRecentTradesRequest {
+  category: USDCAPICategory;
+  symbol?: string;
+  baseCoin?: string;
+  optionType?: 'Call' | 'Put';
+  limit?: string;
+}
+
+export interface USDCOptionsHistoricalVolatilityRequest {
+  baseCoin?: string;
+  period?: string;
+  startTime?: string;
+  endTime?: string;
+}
+
+export interface USDCOptionsOrderRequest {
+  symbol: string;
+  orderType: USDCOrderType;
+  side: OrderSide;
+  orderPrice?: string;
+  orderQty: string;
+  iv?: string;
+  timeInForce?: USDCTimeInForce;
+  orderLinkId?: string;
+  reduceOnly?: boolean;
+}
+
+export interface USDCOptionsModifyOrderRequest {
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+  orderPrice?: string;
+  orderQty?: string;
+  iv?: string;
+}
+
+export interface USDCOptionsCancelOrderRequest {
+  symbol: string;
+  orderId?: string;
+  orderLinkId?: string;
+}
+
+export interface USDCOptionsCancelAllOrdersRequest {
+  symbol?: string;
+  baseCoin?: string;
+}
+
+export interface USDCOptionsActiveOrdersRealtimeRequest {
+  orderId?: string;
+  orderLinkId?: string;
+  symbol?: string;
+  baseCoin?: string;
+  direction?: string;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface USDCOptionsActiveOrdersRequest {
+  category: 'OPTION';
+  symbol?: string;
+  baseCoin?: string;
+  orderId?: string;
+  orderLinkId?: string;
+  direction?: string;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface USDCOptionsHistoricOrdersRequest {
+  category: 'OPTION';
+  symbol?: string;
+  baseCoin?: string;
+  orderId?: string;
+  orderLinkId?: string;
+  orderStatus?: string;
+  direction?: string;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface USDCOptionsOrderExecutionRequest {
+  category: 'OPTION';
+  symbol?: string;
+  baseCoin?: string;
+  orderId?: string;
+  orderLinkId?: string;
+  startTime?: string;
+  direction?: string;
+  limit?: number;
+  cursor?: string;
+}
+
+export interface USDCOptionsDeliveryHistoryRequest {
+  symbol: string;
+  expDate?: string;
+  direction?: string;
+  limit?: string;
+  cursor?: string;
+}
+
+export interface USDCOptionsPositionsInfoExpiryRequest {
+  expDate?: string;
+  direction?: string;
+  limit?: string;
+  cursor?: string;
+}
+
+export interface USDCOptionsModifyMMPRequest {
+  currency: string;
+  windowMs: number;
+  frozenPeriodMs: number;
+  qtyLimit: string;
+  deltaLimit: string;
+}