Enums and Constants Reference — bybit-api SDK Guide

import {
  API_ERROR_CODE,
  WS_KEY_MAP,
  linearPositionModeEnum,
  positionTpSlModeEnum,
  LinearPositionIdx,
  WS_API_Operations,
} from 'bybit-api';

import { API_ERROR_CODE } from 'bybit-api';

try {
  await client.setLeverage({ category: 'linear', symbol: 'BTCUSDT', buyLeverage: '10', sellLeverage: '10' });
} catch (err) {
  if (err.retCode === API_ERROR_CODE.V5_LEVERAGE_NOT_CHANGED) {
    console.log('Leverage was already set to that value.');
  }
}

import { WS_KEY_MAP } from 'bybit-api';

console.log(WS_KEY_MAP.v5PrivateTrade); // 'v5PrivateTrade'

export const WS_KEY_MAP = {
  v5SpotPublic: 'v5SpotPublic',
  v5LinearPublic: 'v5LinearPublic',
  v5InversePublic: 'v5InversePublic',
  v5OptionPublic: 'v5OptionPublic',
  v5Private: 'v5Private',
  /**
   * The V5 WebSocket API connection — used for order.create / amend / cancel
   */
  v5PrivateTrade: 'v5PrivateTrade',
} as const;

export const linearPositionModeEnum = {
  OneWayMode: 'MergedSingle',
  HedgeMode: 'BothSide',
} as const;

import { linearPositionModeEnum } from 'bybit-api';

await client.switchPositionMode({
  category: 'linear',
  symbol: 'BTCUSDT',
  mode: linearPositionModeEnum.HedgeMode, // 'BothSide'
});

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;

import { positionTpSlModeEnum } from 'bybit-api';

await client.setTPSLMode({
  category: 'linear',
  symbol: 'BTCUSDT',
  tpSlMode: positionTpSlModeEnum.Partial, // 'Partial'
});

export enum LinearPositionIdx {
  OneWayMode = 0,
  BuySide = 1,
  SellSide = 2,
}

import { LinearPositionIdx } from 'bybit-api';

// Place a limit buy in hedge mode on the buy-side position
await client.submitOrder({
  category: 'linear',
  symbol: 'BTCUSDT',
  side: 'Buy',
  orderType: 'Limit',
  qty: '0.01',
  price: '30000',
  timeInForce: 'GTC',
  positionIdx: LinearPositionIdx.BuySide, // 1
});

export const WS_API_Operations: WSAPIOperation[] = [
  'order.create',
  'order.amend',
  'order.cancel',
  'order.create-batch',
  'order.amend-batch',
  'order.cancel-batch',
];

import { WS_API_Operations } from 'bybit-api';

// Check if an operation is valid before sending
function isValidWSAPIOperation(op: string): op is WSAPIOperation {
  return (WS_API_Operations as string[]).includes(op);
}

type CategoryV5 = 'spot' | 'linear' | 'inverse' | 'option';

const CATEGORY = {
  spot: 'spot',
  linear: 'linear',
  inverse: 'inverse',
  option: 'option',
} as const satisfies Record<string, CategoryV5>;