llms.txt

This file is a merged representation of a subset of the codebase, containing files not matching ignore patterns, combined into a single document by Repomix.
The content has been processed where content has been compressed (code blocks are separated by ⋮---- delimiter).

================================================================
File Summary
================================================================

Purpose:
--------
This file contains a packed representation of a subset of the repository's contents that is considered the most important context.
It is designed to be easily consumable by AI systems for analysis, code review,
or other automated processes.

File Format:
------------
The content is organized as follows:
1. This summary section
2. Repository information
3. Directory structure
4. Repository files (if enabled)
5. Multiple file entries, each consisting of:
  a. A separator line (================)
  b. The file path (File: path/to/file)
  c. Another separator line
  d. The full contents of the file
  e. A blank line

Usage Guidelines:
-----------------
- This file should be treated as read-only. Any changes should be made to the
  original repository files, not this packed version.
- When processing this file, use the file path to distinguish
  between different files in the repository.
- Be aware that this file may contain sensitive information. Handle it with
  the same level of security as you would the original repository.

Notes:
------
- Some files may have been excluded based on .gitignore rules and Repomix's configuration
- Binary files are not included in this packed representation. Please refer to the Repository Structure section for a complete list of file paths, including binary files
- Files matching these patterns are excluded: .github/, examples/apidoc/, docs/images/, docs/endpointFunctionList.md, test/, src/util/, dist/, lib/
- Files matching patterns in .gitignore are excluded
- Files matching default ignore patterns are excluded
- Content has been compressed - code blocks are separated by ⋮---- delimiter
- Files are sorted by Git change count (files with more changes are at the bottom)


================================================================
Directory Structure
================================================================
examples/
  Rest/
    app.okx.com.ts
    demo-trading.ts
    my.okx.com.ts
    rest-private-trade-market.ts
    rest-private-trade.ts
    rest-public.ts
  Websocket/
    WS-API/
      ws-api-client.ts
      ws-api-trade-raw.ts
    app.okx.com.ts
    ws-private-handle-auth-fail.ts
    ws-private.ts
    ws-public.ts
  README.md
src/
  constants/
    funding.ts
  types/
    rest/
      request/
        account.ts
        affiliate.ts
        block-trading.ts
        convert.ts
        copy-trading.ts
        dual-investment.ts
        funding.ts
        grid-trading.ts
        public.ts
        recurring-buy.ts
        shared.ts
        signal-bot.ts
        simple-earn.ts
        spread-trading.ts
        stable-rewards.ts
        subaccount.ts
        trade.ts
      response/
        private-account.ts
        private-affiliate.ts
        private-block-trading.ts
        private-copy-trading.ts
        private-dual-investment.ts
        private-flexible-loan.ts
        private-funding.ts
        private-recurring-buy.ts
        private-signal-bot.ts
        private-spread-trading.ts
        private-stable-rewards.ts
        private-subaccount.ts
        private-trade.ts
        public-data.ts
      client.ts
      shared.ts
    websockets/
      ws-api-request.ts
      ws-api-response.ts
      ws-api.ts
      ws-events.ts
      ws-general.ts
      ws-request.ts
    shared.ts
  index.ts
  rest-client.ts
  websocket-api-client.ts
  websocket-client-legacy.ts
  websocket-client.ts
webpack/
  webpack.config.cjs
.eslintrc.cjs
.gitignore
.jshintrc
.nvmrc
.prettierrc
jest.config.ts
LICENSE.md
package.json
postBuild.sh
README.md
tsconfig.cjs.json
tsconfig.esm.json
tsconfig.json
tsconfig.linting.json

================================================================
Files
================================================================

================
File: examples/README.md
================
# Examples

These samples can be executed using `ts-node`:
```
ts-node ./examples/rest-spot-public.ts
```

================
File: src/constants/funding.ts
================
/**
 * Asset bill type, auto-generated using table from funding asset bill details:
 * https://www.okx.com/docs-v5/en/#rest-api-funding-asset-bills-details
 */
export enum ASSET_BILL_TYPE {
  DEPOSIT = '1',
  WITHDRAWAL = '2',
  CANCELED_WITHDRAWAL = '13',
  TRANSFER_TO_SUB_ACCOUNT = '20',
  TRANSFER_FROM_SUB_ACCOUNT = '21',
  CLAIM = '28',
  SYSTEM_REVERSAL = '47',
  RECEIVED_FROM_ACTIVITIES = '48',
  GIVEN_AWAY_TO_ACTIVITIES = '49',
  RECEIVED_FROM_APPOINTMENTS = '50',
  DEDUCTED_FROM_APPOINTMENTS = '51',
  RED_PACKET_SENT = '52',
  RED_PACKET_SNATCHED = '53',
  RED_PACKET_REFUNDED = '54',
  CONVERSION = '61',
  CLAIM_REBATE_CARD = '68',
  DISTRIBUTE_REBATE_CARD = '69',
  TOKEN_RECEIVED = '72',
  TOKEN_GIVEN_AWAY = '73',
  TOKEN_REFUNDED = '74',
  SUBSCRIPTION_TO_SAVINGS = '75',
  REDEMPTION_TO_SAVINGS = '76',
  DISTRIBUTE = '77',
  LOCK_UP = '78',
  NODE_VOTING = '79',
  STAKING_1 = '80',
  VOTE_REDEMPTION = '81',
  STAKING_REDEMPTION_1 = '82',
  STAKING_YIELD = '83',
  VIOLATION_FEE = '84',
  POW_MINING_YIELD = '85',
  CLOUD_MINING_PAY = '86',
  CLOUD_MINING_YIELD = '87',
  SUBSIDY = '88',
  STAKING_2 = '89',
  STAKING_SUBSCRIPTION = '90',
  STAKING_REDEMPTION_2 = '91',
  ADD_COLLATERAL = '92',
  REDEEM_COLLATERAL = '93',
  INVESTMENT = '94',
  BORROWER_BORROWS = '95',
  PRINCIPAL_TRANSFERRED_IN = '96',
  BORROWER_TRANSFERRED_LOAN_OUT = '97',
  BORROWER_TRANSFERRED_INTEREST_OUT = '98',
  INVESTOR_TRANSFERRED_INTEREST_IN = '99',
  PREPAYMENT_PENALTY_TRANSFERRED_IN = '102',
  PREPAYMENT_PENALTY_TRANSFERRED_OUT = '103',
  FEE_TRANSFERRED_IN = '104',
  FEE_TRANSFERRED_OUT = '105',
  OVERDUE_FEE_TRANSFERRED_IN = '106',
  OVERDUE_FEE_TRANSFERRED_OUT = '107',
  OVERDUE_INTEREST_TRANSFERRED_OUT = '108',
  OVERDUE_INTEREST_TRANSFERRED_IN = '109',
  COLLATERAL_FOR_CLOSED_POSITION_TRANSFERRED_IN = '110',
  COLLATERAL_FOR_CLOSED_POSITION_TRANSFERRED_OUT = '111',
  COLLATERAL_FOR_LIQUIDATION_TRANSFERRED_IN = '112',
  COLLATERAL_FOR_LIQUIDATION_TRANSFERRED_OUT = '113',
  INSURANCE_FUND_TRANSFERRED_IN = '114',
  INSURANCE_FUND_TRANSFERRED_OUT_ = '115',
  PLACE_AN_ORDER = '116',
  FULFILL_AN_ORDER = '117',
  CANCEL_AN_ORDER = '118',
  MERCHANTS_UNLOCK_DEPOSIT = '119',
  MERCHANTS_ADD_DEPOSIT = '120',
  FIATGATEWAY_PLACE_AN_ORDER = '121',
  FIATGATEWAY_CANCEL_AN_ORDER = '122',
  FIATGATEWAY_FULFILL_AN_ORDER = '123',
  JUMPSTART_UNLOCKING = '124',
  MANUAL_DEPOSIT = '125',
  INTEREST_DEPOSIT = '126',
  INVESTMENT_FEE_TRANSFERRED_IN = '127',
  INVESTMENT_FEE_TRANSFERRED_OUT = '128',
  REWARDS_TRANSFERRED_IN = '129',
  TRANSFERRED_FROM_TRADING_ACCOUNT = '130',
  TRANSFERRED_TO_TRADING_ACCOUNT = '131',
  FROZEN_BY_CUSTOMER_SERVICE = '132',
  UNFROZEN_BY_CUSTOMER_SERVICE = '133',
  TRANSFERRED_BY_CUSTOMER_SERVICE = '134',
  CROSS_CHAIN_EXCHANGE = '135',
  CONVERT = '136',
  ETH_2_0_SUBSCRIPTION = '137',
  ETH_2_0_SWAPPING = '138',
  ETH_2_0_EARNINGS = '139',
  FEE_TRANSFER_IN = '141',
  FEE_TRANSFER_OUT = '142',
  SYSTEM_REVERSE = '143',
  TRANSFER_OUT_OF_UNIFIED_ACCOUNT_RESERVE = '144',
  REWARD_EXPIRED = '145',
  CUSTOMER_FEEDBACK = '146',
  VESTED_SUSHI_REWARDS = '147',
  AFFILIATE_COMMISSION = '150',
  REFERRAL_REWARD = '151',
  BROKER_REWARD = '152',
  JOINER_REWARD = '153',
  MYSTERY_BOX_REWARD = '154',
  REWARDS_WITHDRAW = '155',
  FEE_REBATE_1 = '156',
  COLLECTED_CRYPTO = '157',
  DUAL_INVESTMENT_SUBSCRIBE = '160',
  DUAL_INVESTMENT_COLLECTION = '161',
  DUAL_INVESTMENT_PROFIT = '162',
  DUAL_INVESTMENT_REFUND = '163',
  NEW_YEAR_REWARDS_2022 = '169',
  REFERRAL_REFERRED_CUSTOMER = '170',
  REFERRAL_WAS_REFERRED = '171',
  SUB_AFFILIATE_COMMISSION = '172',
  FEE_REBATE_2 = '173',
  PAY = '174',
  LOCKED_COLLATERAL = '175',
  LOAN = '176',
  ADDED_COLLATERAL = '177',
  RETURNED_COLLATERAL = '178',
  REPAYMENT = '179',
  UNLOCKED_COLLATERAL = '180',
  REPAY_AIRDROPPED_CRYPTO = '181',
  FEEDBACK_BOUNTY = '182',
  INVITE_FRIENDS_REWARDS = '183',
  DIVIDE_THE_REWARD_POOL = '184',
  BROKER_CONVERT_REWARD = '185',
  FREEETH = '186',
  CONVERT_TRANSFER = '187',
  SLOT_AUCTION_CONVERSION = '188',
  MYSTERY_BOX_BONUS = '189',
  CARD_PAYMENT_BUY_1 = '193',
  CARD_PAYMENT_BUY_2 = '194',
  UNTRADABLE_ASSET_WITHDRAWAL = '195',
  UNTRADABLE_ASSET_WITHDRAWAL_REVOKED = '196',
  UNTRADABLE_ASSET_DEPOSIT = '197',
  UNTRADABLE_ASSET_COLLECTION_1 = '198',
  UNTRADABLE_ASSET_COLLECTION_2 = '199',
  BUY = '200',
  WIN_CRYPTO_WITH_SATOSHI = '211',
}
⋮----
export type AssetBillType = `${ASSET_BILL_TYPE}`;

================
File: src/types/rest/request/copy-trading.ts
================
export interface GetCurrentSubpositionsRequest {
  instType?: 'SPOT' | 'SWAP';
  instId?: string;
  uniqueCode?: string;
  subPosType?: 'lead' | 'copy';
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GetSubpositionsHistoryRequest {
  instType?: 'SPOT' | 'SWAP';
  instId?: string;
  subPosType?: 'lead' | 'copy';
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface PlaceCTAlgoOrderRequest {
  instType?: 'SPOT' | 'SWAP';
  subPosId: string;
  tpTriggerPx?: string;
  slTriggerPx?: string;
  tpOrdPx?: string;
  slOrdPx?: string;
  tpTriggerPxType?: 'last' | 'index' | 'mark';
  slTriggerPxType?: 'last' | 'index' | 'mark';
  tag?: string;
  subPosType?: 'lead' | 'copy';
}
⋮----
export interface CloseSubpositionRequest {
  instType?: 'SPOT' | 'SWAP';
  subPosType?: 'lead' | 'copy';
  subPosId: string;
  ordType?: 'market' | 'limit';
  px?: string;
  tag?: string;
}
⋮----
export interface GetCTProfitDetailsRequest {
  instType?: 'SPOT' | 'SWAP';
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface CopySettingsRequest {
  instType?: 'SWAP';
  uniqueCode: string;
  copyMgnMode: 'cross' | 'isolated' | 'copy';
  copyInstIdType: 'custom' | 'copy';
  instId?: string;
  copyMode?: 'fixed_amount' | 'ratio_copy';
  copyTotalAmt: string;
  copyAmt?: string;
  copyRatio?: string;
  tpRatio?: string;
  slRatio?: string;
  slTotalAmt?: string;
  subPosCloseType: 'market_close' | 'copy_close' | 'manual_close';
}
⋮----
export interface GetCTBatchLeverageInfoRequest {
  mgnMode: 'cross' | 'isolated';
  uniqueCode: string;
  instId?: string;
}
⋮----
export interface SetCTBatchLeverageRequest {
  mgnMode: 'cross' | 'isolated';
  lever: string;
  instId: string;
}
⋮----
export interface GetCTHistoryLeadTradersRequest {
  instType?: 'SWAP';
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GetLeadTraderRanksRequest {
  instType?: 'SWAP';
  sortType?:
    | 'overview'
    | 'pnl'
    | 'aum'
    | 'win_ratio'
    | 'pnl_ratio'
    | 'current_copy_trader_pnl';
  state?: '0' | '1';
  minLeadDays?: '1' | '2' | '3' | '4';
  minAssets?: string;
  maxAssets?: string;
  minAum?: string;
  maxAum?: string;
  dataVer?: string;
  page?: string;
  limit?: string;
}
⋮----
export interface GetLeadTraderStatsRequest {
  instType?: 'SWAP';
  uniqueCode: string;
  lastDays: '1' | '2' | '3' | '4';
}
⋮----
export interface GetLeadTraderPositionsRequest {
  instType?: 'SWAP';
  uniqueCode: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GetCopyTradersRequest {
  instType?: 'SWAP';
  uniqueCode: string;
  limit?: string;
}
⋮----
export interface GetPrivateLeadTraderRanksRequest {
  instType?: 'SWAP';
  sortType?:
    | 'overview'
    | 'pnl'
    | 'aum'
    | 'win_ratio'
    | 'pnl_ratio'
    | 'current_copy_trader_pnl';
  state?: '0' | '1';
  minLeadDays?: '1' | '2' | '3' | '4';
  minAssets?: string;
  maxAssets?: string;
  minAum?: string;
  maxAum?: string;
  dataVer?: string;
  page?: string;
  limit?: string;
}

================
File: src/types/rest/request/grid-trading.ts
================
export type GridAlgoOrderType = 'grid' | 'contract_grid' | 'moon_grid';
⋮----
export interface GetGridAlgoOrdersRequest {
  algoOrdType: GridAlgoOrderType;
  algoId?: string;
  instId?: string;
  instType?: 'SPOT' | 'MARGIN' | 'SWAP' | 'FUTURES';
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GridAlgoTrigger {
  triggerAction: 'start' | 'stop';
  triggerStrategy: 'instant' | 'price' | 'rsi';
  delaySeconds?: string;
  timeframe?: '3m' | '5m' | '15m' | '30m' | '1H' | '4H' | '1D';
  thold?: string;
  triggerCond?: 'cross_up' | 'cross_down' | 'above' | 'below' | 'cross';
  timePeriod?: string;
  triggerPx?: string;
  stopType?: '1' | '2';
}
⋮----
export interface GridAlgoOrderRequest {
  instId: string;
  algoOrdType: GridAlgoOrderType;
  maxPx: string;
  minPx: string;
  gridNum: string;
  runType: '1' | '2';
  quoteSz?: string;
  baseSz?: string;
  sz?: string;
  direction?: 'long' | 'short' | 'neutral';
  lever?: string;
  basePos?: boolean;
  tpRatio?: string;
  slRatio?: string;
  triggerParams?: GridAlgoTrigger[];
}
⋮----
export interface StopGridAlgoOrderRequest {
  algoId: string;
  instId: string;
  algoOrdType: GridAlgoOrderType;
  stopType: '1' | '2';
}
⋮----
export interface CloseContractGridPositionRequest {
  algoId: string;
  mktClose: boolean;
  sz?: string;
  px?: string;
}
⋮----
export interface GetRSIBackTestingRequest {
  instId: string;
  timeframe: '3m' | '5m' | '15m' | '30m' | '1H' | '4H' | '1D';
  thold: string;
  timePeriod: string;
  triggerCond?: 'cross_up' | 'cross_down' | 'above' | 'below' | 'cross';
  duration?: string;
}
⋮----
export interface MaxGridQuantityRequest {
  instId: string;
  runType: '1' | '2';
  algoOrdType: 'grid' | 'contract_grid';
  maxPx: string;
  minPx: string;
  lever?: string;
}

================
File: src/types/rest/request/recurring-buy.ts
================
export interface RecurringBuyInfo {
  ccy: string;
  ratio: string;
}
⋮----
export interface PlaceRecurringBuyOrderRequest {
  stgyName: string;
  recurringList: RecurringBuyInfo[];
  period: 'monthly' | 'weekly' | 'daily' | 'hourly';
  recurringDay?: string;
  recurringHour?: string;
  recurringTime: string;
  timeZone: string;
  amt: string;
  investmentCcy: 'USDT' | 'USDC';
  tdMode: 'cross' | 'cash';
  algoClOrdId?: string;
  tag?: string;
}
⋮----
export interface AmendRecurringBuyOrderRequest {
  algoId: string;
  stgyName: string;
}
⋮----
export interface GetRecurringBuyOrderListRequest {
  algoId?: string;
  after?: string;
  before?: string;
  limit?: string;
}

================
File: src/types/rest/request/shared.ts
================
import { numberInString } from '../shared.js';
⋮----
export interface PaginatedSymbolRequest {
  ccy?: string;
  after?: numberInString;
  before?: numberInString;
  limit?: numberInString;
}

================
File: src/types/rest/request/signal-bot.ts
================
export interface CreateSignalRequest {
  signalChanName: string;
  signalChanDesc?: string;
}
⋮----
export interface GetSignalsRequest {
  signalSourceType: string;
  signalChanId?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface EntrySettingParam {
  allowMultipleEntry?: string;
  entryType?: string;
  amt?: string;
  ratio?: { ratio: string }[];
}
⋮----
export interface ExitSettingParam {
  tpSlType: string;
  tpPct?: string;
  slPct?: string;
}
⋮----
export interface CreateSignalBotRequest {
  signalChanId: string;
  lever: string;
  investAmt: string;
  subOrdType: string;
  includeAll?: boolean;
  instIds?: string;
  ratio?: string;
  entrySettingParam?: EntrySettingParam;
  exitSettingParam?: ExitSettingParam;
}
⋮----
export interface AdjustMarginBalanceRequest {
  algoId: string;
  type: 'add' | 'reduce';
  amt: string;
  allowReinvest?: boolean;
}
⋮----
export interface AmendTPSLRequest {
  algoId: string;
  exitSettingParam: ExitSettingParam;
}
⋮----
export interface SetSignalInstrumentsRequest {
  algoId: string;
  instIds: string[];
  includeAll: boolean;
}
⋮----
export interface GetSignalBotRequest {
  algoOrdType: string;
  algoId: string;
  after: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GetSignalBotPositionHistoryRequest {
  algoId?: string;
  instId?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface PlaceSubOrderRequest {
  instId: string;
  algoId: string;
  side: 'buy' | 'sell';
  ordType: 'market' | 'limit';
  sz: string;
  px?: string;
  reduceOnly?: boolean;
}
⋮----
export interface CancelSubOrderRequest {
  algoId: string;
  instId: string;
  signalOrdId: string;
}
⋮----
export interface GetSignalBotSubOrdersRequest {
  algoId: string;
  algoOrdType: 'contract';
  type?: 'live' | 'filled';
  clOrdId?: string;
  state?: 'live' | 'partially_filled' | 'filled' | 'cancelled';
  signalOrdId?: string;
  after?: string;
  before?: string;
  begin?: string;
  end?: string;
  limit?: string;
}
⋮----
export interface GetSignalBotEventHistoryRequest {
  algoId: string;
  after?: string;
  before?: string;
  limit?: string;
}

================
File: src/types/rest/request/simple-earn.ts
================
export interface GetLendingOrderListRequest {
  ordId?: string;
  ccy?: string;
  term?: '30D';
  state?: 'pending' | 'earning' | 'expired' | 'settled';
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface LendingOrder {
  ccy: string;
  amt: string;
  rate?: string;
  term: '30D';
  autoRenewal?: boolean;
}
⋮----
export interface GetLendingSubOrderListRequest {
  ordId: string;
  state?: 'earning' | 'expired' | 'settled';
  after?: string;
  before?: string;
  limit?: string;
}

================
File: src/types/rest/request/spread-trading.ts
================
export interface PlaceSpreadOrderRequest {
  sprdId: string;
  clOrdId?: string;
  tag?: string;
  side: 'buy' | 'sell';
  ordType: 'limit' | 'post_only' | 'ioc' | 'market';
  sz: string;
  px: string;
}
⋮----
export interface UpdateSpreadOrderRequest {
  ordId?: string;
  clOrdId?: string;
  reqId?: string;
  newSz?: string;
  newPx?: string;
}
⋮----
export interface GetActiveSpreadOrdersRequest {
  sprdId?: string;
  ordType?: 'limit' | 'post_only' | 'ioc' | 'market';
  state?: 'live' | 'partially_filled';
  beginId?: string;
  endId?: string;
  limit?: string;
}
⋮----
export interface GetSpreadOrderHistoryRequest {
  sprdId?: string;
  ordType?: 'limit' | 'post_only' | 'ioc' | 'market';
  state?: 'canceled' | 'filled';
  beginId?: string;
  endId?: string;
  begin?: string;
  end?: string;
  limit?: string;
}
⋮----
export interface GetSpreadOrderHistoryArchiveRequest {
  sprdId?: string;
  ordType?: 'limit' | 'post_only' | 'ioc' | 'market';
  state?: 'canceled' | 'filled';
  instType?: 'SPOT' | 'FUTURES' | 'SWAP';
  instFamily?: string;
  beginId?: string;
  endId?: string;
  begin?: string;
  end?: string;
  limit?: string;
}
⋮----
export interface GetSpreadTradesRequest {
  sprdId?: string;
  tradeId?: string;
  ordId?: string;
  beginId?: string;
  endId?: string;
  begin?: string;
  end?: string;
  limit?: string;
}
⋮----
export interface GetSpreadsRequest {
  baseCcy?: string;
  instId?: string;
  sprdId?: string;
  state?: 'live' | 'suspend' | 'expired';
}
⋮----
export interface GetSpreadCandlesRequest {
  sprdId: string;
  bar?: string;
  after?: string;
  before?: string;
  limit?: string;
}

================
File: src/types/rest/request/subaccount.ts
================
type AccountType = '6' | '18';
⋮----
export interface SubAccountTransferRequest {
  ccy: string;
  amt: string;
  from: AccountType;
  to: AccountType;
  fromSubAccount: string;
  toSubAccount: string;
  loanTrans?: boolean;
  omitPosRisk?: boolean;
}
⋮----
export interface GetSubAccountMaxWithdrawalsRequest {
  subAcct: string;
  ccy?: string;
}
⋮----
export interface GetManagedSubAccountTransferHistoryRequest {
  ccy?: string;
  type?: '0' | '1';
  subAcct?: string;
  subUid?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface LoanAllocation {
  subAcct: string;
  loanAlloc: string;
}
⋮----
export interface SetSubAccountLoanAllocationRequest {
  enable: boolean;
  alloc?: LoanAllocation[];
}

================
File: src/types/rest/response/private-copy-trading.ts
================
export interface CurrentSubposition {
  algoId: string;
  ccy: string;
  instId: string;
  instType: string;
  lever: string;
  margin: string;
  markPx: string;
  mgnMode: string;
  openAvgPx: string;
  openOrdId: string;
  openTime: string;
  posSide: string;
  slOrdPx: string;
  slTriggerPx: string;
  subPos: string;
  subPosId: string;
  tpOrdPx: string;
  tpTriggerPx: string;
  uniqueCode: string;
  upl: string;
  uplRatio: string;
  availSubPos: string;
}
⋮----
export interface SubpositionsHistory {
  ccy: string;
  closeAvgPx: string;
  closeTime: string;
  instId: string;
  instType: string;
  lever: string;
  margin: string;
  markPx: string;
  mgnMode: string;
  openAvgPx: string;
  openOrdId: string;
  openTime: string;
  pnl: string;
  pnlRatio: string;
  posSide: string;
  profitSharingAmt: string;
  subPos: string;
  closeSubPos: string;
  type: string;
  subPosId: string;
  uniqueCode: string;
}
⋮----
export interface PlaceCTAlgoOrderResult {
  subPosId: string;
  tag: string;
}
⋮----
export interface GetCTProfitDetailsResult {
  ccy: string;
  nickName: string;
  profitSharingAmt: string;
  profitSharingId: string;
  portLink: string;
  ts: string;
  instType: string;
}
⋮----
export interface GetCTTotalProfitResult {
  ccy: string;
  totalProfitSharingAmt: string;
  instType: string;
}
⋮----
export interface GetCTUnrealizedProfitResult {
  ccy: string;
  nickName: string;
  portLink: string;
  ts: string;
  unrealizedProfitSharingAmt: string;
  instType: string;
}
⋮----
export interface AccountConfigurationDetails {
  copyTraderNum: string;
  instType: 'SPOT' | 'SWAP';
  maxCopyTraderNum: string;
  profitSharingRatio: string;
  roleType: '0' | '1' | '2';
}
⋮----
export interface GetAccountConfigurationResult {
  uniqueCode: string;
  nickName: string;
  portLink: string;
  details: AccountConfigurationDetails[];
}
⋮----
export interface CopySettingsInstId {
  instId: string;
  enabled: string;
}
⋮----
export interface GetCopySettingsResult {
  ccy: string;
  copyAmt: string;
  copyInstIdType: 'custom' | 'copy';
  copyMgnMode: 'cross' | 'isolated' | 'copy';
  copyMode: 'fixed_amount' | 'ratio_copy';
  copyRatio: string;
  copyState: '0' | '1';
  copyTotalAmt: string;
  instIds: CopySettingsInstId[];
  slRatio: string;
  slTotalAmt: string;
  subPosCloseType: 'market_close' | 'copy_close' | 'manual_close';
  tpRatio: string;
}
⋮----
export interface LeverageInfo {
  lever: string;
  posSide: 'long' | 'short';
}
⋮----
export interface GetCTBatchLeverageInfoResult {
  instId: string;
  mgnMode: 'cross' | 'isolated';
  leadTraderLevers: LeverageInfo[];
  myLevers: LeverageInfo[];
}
⋮----
export interface SetCTBatchLeverageResult {
  succInstId: string;
  failInstId: string;
  result: '0' | '1' | '2';
}
⋮----
export interface GetCTMyLeadTradersResult {
  portLink: string;
  nickName: string;
  margin: string;
  copyTotalAmt: string;
  copyTotalPnl: string;
  uniqueCode: string;
  ccy: string;
  profitSharingRatio: string;
  beginCopyTime: string;
  upl: string;
  todayPnl: string;
  leadMode: 'public' | 'private';
}
⋮----
export interface GetCTHistoryLeadTradersResult {
  portLink: string;
  nickName: string;
  uniqueCode: string;
  copyNum: string;
  copyTotalAmt: string;
  copyTotalPnl: string;
  copyAmt: string;
  copyMode: 'fixed_amount' | 'ratio_copy';
  copyRatio: string;
  ccy: string;
  profitSharingRatio: string;
  beginCopyTime: string;
  endCopyTime: string;
  copyRelId: string;
  copyState: '0' | '1';
  leadMode: 'public' | 'private';
}
⋮----
export interface GetCopyTradingConfigResult {
  maxCopyAmt: string;
  minCopyAmt: string;
  maxCopyTotalAmt: string;
  minCopyRatio: string;
  maxCopyRatio: string;
  maxTpRatio: string;
  maxSlRatio: string;
}
⋮----
export interface PnlRatio {
  beginTs: string;
  pnlRatio: string;
}
⋮----
export interface LeadTraderRank {
  accCopyTraderNum: string;
  aum: string;
  ccy: string;
  copyState: '0' | '1';
  copyTraderNum: string;
  leadDays: string;
  maxCopyTraderNum: string;
  nickName: string;
  pnl: string;
  pnlRatio: string;
  pnlRatios: PnlRatio[];
  portLink: string;
  traderInsts: string[];
  uniqueCode: string;
  winRatio: string;
}
⋮----
export interface GetLeadTraderRanksResult {
  dataVer: string;
  ranks: LeadTraderRank[];
  totalPage: string;
}
⋮----
export interface LeadTraderPnl {
  beginTs: string;
  pnl: string;
  pnlRatio: string;
}
⋮----
export interface LeadTraderStats {
  avgSubPosNotional: string;
  ccy: string;
  curCopyTraderPnl: string;
  investAmt: string;
  lossDays: string;
  profitDays: string;
  winRatio: string;
}
⋮----
export interface LeadTraderPreference {
  ccy: string;
  ratio: string;
}
⋮----
export interface LeadTraderCurrentPosition {
  ccy: string;
  instId: string;
  instType: string;
  lever: string;
  margin: string;
  markPx: string;
  mgnMode: string;
  openAvgPx: string;
  openTime: string;
  posSide: string;
  subPos: string;
  subPosId: string;
  uniqueCode: string;
  upl: string;
  uplRatio: string;
}
⋮----
export interface LeadTraderPositionHistory {
  ccy: string;
  closeAvgPx: string;
  closeTime: string;
  instId: string;
  instType: string;
  lever: string;
  margin: string;
  mgnMode: string;
  openAvgPx: string;
  openTime: string;
  pnl: string;
  pnlRatio: string;
  posSide: string;
  subPos: string;
  subPosId: string;
  uniqueCode: string;
}
⋮----
export interface CopyTraderInfo {
  beginCopyTime: string;
  nickName: string;
  portLink: string;
  pnl: string;
}
⋮----
export interface GetCopyTradersResult {
  copyTotalPnl: string;
  ccy: string;
  copyTraderNumChg: string;
  copyTraderNumChgRatio: string;
  copyTraders: CopyTraderInfo[];
}
⋮----
export interface GetPrivateLeadTraderRanksResult {
  dataVer: string;
  chanType: 'OKX' | 'ND';
  ranks: LeadTraderRank[];
  totalPage: string;
}

================
File: src/types/rest/response/private-recurring-buy.ts
================
export interface RecurringBuyOrderResult {
  algoId: string;
  algoClOrdId: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface RecurringBuyInfoResult {
  ccy: string;
  ratio: string;
}
⋮----
export interface RecurringBuyOrder {
  algoId: string;
  algoClOrdId: string;
  instType: string;
  cTime: string;
  uTime: string;
  algoOrdType: 'recurring';
  state: 'running' | 'stopping' | 'pause';
  stgyName: string;
  recurringList: RecurringBuyInfoResult[];
  period: 'monthly' | 'weekly' | 'daily' | 'hourly';
  recurringDay?: string;
  recurringHour?: string;
  recurringTime: string;
  timeZone: string;
  amt: string;
  investmentAmt: string;
  investmentCcy: 'USDT' | 'USDC';
  totalPnl: string;
  totalAnnRate: string;
  pnlRatio: string;
  mktCap: string;
  cycles: string;
  tag: string;
}
⋮----
export interface RecurringBuyInfoOrder {
  ccy: string;
  ratio: string;
  totalAmt: string;
  profit: string;
  avgPx: string;
  px: string;
}
⋮----
export interface RecurringBuySubOrder {
  algoId: string;
  instType: string;
  instId: string;
  algoOrdType: 'recurring';
  ordId: string;
  cTime: string;
  uTime: string;
  tdMode: 'cross' | 'cash';
  ordType: 'market';
  sz: string;
  state: 'canceled' | 'live' | 'partially_filled' | 'filled' | 'cancelling';
  side: 'buy' | 'sell';
  px: string;
  fee: string;
  feeCcy: string;
  avgPx: string;
  accFillSz: string;
  tag: string;
}

================
File: src/types/rest/response/private-signal-bot.ts
================
export interface CreateSignalResult {
  signalChanId: string;
  signalToken: string;
}
⋮----
export interface GetSignalsResult {
  signalChanId: string;
  signalChanName: string;
  signalChanDesc: string;
  signalChanToken: string;
  signalSourceType: string;
}
⋮----
export interface CreateSignalBotResult {
  algoId: string;
  algoClOrdId: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface CancelSignalBotsResult {
  algoId: string;
  sCode: string;
  sMsg: string;
}

================
File: src/types/rest/response/private-spread-trading.ts
================
export interface PlaceSpreadOrderResponse {
  ordId: string;
  clOrdId: string;
  tag: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface CancelSpreadOrderResponse {
  ordId: string;
  clOrdId: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface UpdateSpreadOrderResponse {
  ordId: string;
  clOrdId: string;
  reqId: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface SpreadOrder {
  instId: string;
  ordId: string;
  clOrdId: string;
  tag: string;
  px: string;
  sz: string;
  ordType: 'limit' | 'post_only' | 'ioc';
  side: 'buy' | 'sell';
  fillSz: string;
  fillPx: string;
  tradeId: string;
  accFillSz: string;
  pendingFillSz: string;
  pendingSettleSz: string;
  canceledSz: string;
  avgPx: string;
  state: 'canceled' | 'live' | 'partially_filled' | 'filled';
  cancelSource: string;
  uTime: string;
  cTime: string;
}
⋮----
export interface SpreadTradeLeg {
  instId: string;
  px: string;
  sz: string;
  side: 'buy' | 'sell';
  fee: string;
  szCont: string;
  feeCcy: string;
  tradeId: string;
}
⋮----
export interface SpreadTrade {
  sprdId: string;
  tradeId: string;
  ordId: string;
  clOrdId: string;
  tag: string;
  fillPx: string;
  fillSz: string;
  side: 'buy' | 'sell';
  state: 'filled' | 'rejected';
  execType: 'T' | 'M';
  ts: string;
  legs: SpreadTradeLeg[];
}
⋮----
export interface SpreadLeg {
  instId: string;
  side: 'buy' | 'sell';
}
⋮----
export interface SpreadDetails {
  sprdId: string;
  sprdType: 'linear' | 'inverse' | 'hybrid';
  state: 'live' | 'expired' | 'suspend';
  baseCcy: string;
  szCcy: string;
  quoteCcy: string;
  tickSz: string;
  minSz: string;
  lotSz: string;
  listTime: string;
  expTime: string;
  uTime: string;
  legs: SpreadLeg[];
}
⋮----
export interface OrderBookEntry {
  price: string;
  quantity: string;
  orderCount: string;
}
⋮----
export interface SpreadOrderBook {
  asks: OrderBookEntry[];
  bids: OrderBookEntry[];
  ts: string;
}
⋮----
export interface SpreadTicker {
  sprdId: string;
  last: string;
  lastSz: string;
  askPx: string;
  askSz: string;
  bidPx: string;
  bidSz: string;
  open24h: string;
  high24h: string;
  low24h: string;
  vol24h: string;
  ts: string;
}
⋮----
export interface PublicSpreadTrade {
  sprdId: string;
  tradeId: string;
  px: string;
  sz: string;
  side: 'buy' | 'sell';
  ts: string;
}
⋮----
export interface SpreadCandle {
  ts: string;
  o: string;
  h: string;
  l: string;
  c: string;
  vol: string;
  confirm: string;
}

================
File: src/types/rest/response/private-subaccount.ts
================
export interface SubAccount {
  enable: boolean;
  subAcct: string;
  type: string;
  label: string;
  mobile: string;
  gAuth: boolean;
  canTransOut: boolean;
  ts: string;
}
⋮----
export interface SubAccountAPIReset {
  subAcct: string;
  label: string;
  apiKey: string;
  perm: string;
  ip: string;
  ts: string;
}
⋮----
export interface SubAccountBalanceDetail {
  availBal: string;
  availEq: string;
  cashBal: string;
  ccy: string;
  crossLiab: string;
  disEq: string;
  eq: string;
  eqUsd: string;
  frozenBal: string;
  interest: string;
  isoEq: string;
  isoLiab: string;
  liab: string;
  maxLoan: string;
  mgnRatio: string;
  notionalLever: string;
  ordFrozen: string;
  twap: string;
  uTime: string;
  upl: string;
  uplLiab: string;
  spotBal: string; // Spot balance. The unit is currency, e.g. BTC.
  openAvgPx: string[]; // Spot average cost price. The unit is USD.
  accAvgPx: string[]; // Spot accumulated cost price. The unit is USD.
  spotUpl: string; // Spot unrealized profit and loss. The unit is USD.
  spotUplRatio: string; // Spot unrealized profit and loss ratio.
  totalPnl: string; // Spot accumulated profit and loss. The unit is USD.
  totalPnlRatio: string; // Spot accumulated profit and loss ratio.
}
⋮----
spotBal: string; // Spot balance. The unit is currency, e.g. BTC.
openAvgPx: string[]; // Spot average cost price. The unit is USD.
accAvgPx: string[]; // Spot accumulated cost price. The unit is USD.
spotUpl: string; // Spot unrealized profit and loss. The unit is USD.
spotUplRatio: string; // Spot unrealized profit and loss ratio.
totalPnl: string; // Spot accumulated profit and loss. The unit is USD.
totalPnlRatio: string; // Spot accumulated profit and loss ratio.
⋮----
export interface SubAccountBalances {
  adjEq: string;
  details: SubAccountBalanceDetail[];
  imr: string;
  isoEq: string;
  mgnRatio: string;
  mmr: string;
  notionalUsd: string;
  ordFroz: string;
  totalEq: string;
  uTime: string;
  spotCopyTradingEq: string;
}
⋮----
export interface SubAccountTransferResult {
  transId: string;
}
⋮----
export interface SubAccountMaxWithdrawal {
  ccy: string;
  maxWd: string;
  maxWdEx: string;
  spotOffsetMaxWd: string;
  spotOffsetMaxWdEx: string;
}
⋮----
export interface ManagedSubAccountTransfer {
  billId: string;
  ccy: string;
  amt: string;
  type: string;
  subAcct: string;
  subUid: string;
  ts: string;
}

================
File: .eslintrc.cjs
================
'require-extensions', // only once moved to ESM
⋮----
'plugin:require-extensions/recommended', // only once moved to ESM
⋮----
// 'no-unused-vars': ['warn'],

================
File: .jshintrc
================
{
  "esversion": 8,
  "asi": true,
  "laxbreak": true,
  "predef": [ "-Promise" ]
}

================
File: .nvmrc
================
v22.17.1

================
File: .prettierrc
================
{
  "tabWidth": 2,
  "singleQuote": true,
  "trailingComma": "all"
}

================
File: jest.config.ts
================
/**
 * For a detailed explanation regarding each configuration property, visit:
 * https://jestjs.io/docs/configuration
 */
⋮----
import type { Config } from 'jest';
⋮----
// All imported modules in your tests should be mocked automatically
// automock: false,
⋮----
// Stop running tests after `n` failures
// bail: 0,
bail: false, // enable to stop test when an error occur,
⋮----
// The directory where Jest should store its cached dependency information
// cacheDirectory: "/private/var/folders/kf/2k3sz4px6c9cbyzj1h_b192h0000gn/T/jest_dx",
⋮----
// Automatically clear mock calls, instances, contexts and results before every test
⋮----
// Indicates whether the coverage information should be collected while executing the test
⋮----
// An array of glob patterns indicating a set of files for which coverage information should be collected
⋮----
// The directory where Jest should output its coverage files
⋮----
// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
//   "/node_modules/"
// ],
⋮----
// Indicates which provider should be used to instrument code for coverage
⋮----
// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
//   "json",
//   "text",
//   "lcov",
//   "clover"
// ],
⋮----
// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,
⋮----
// A path to a custom dependency extractor
// dependencyExtractor: undefined,
⋮----
// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,
⋮----
// The default configuration for fake timers
// fakeTimers: {
//   "enableGlobally": false
// },
⋮----
// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],
⋮----
// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: undefined,
⋮----
// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,
⋮----
// A set of global variables that need to be available in all test environments
// globals: {},
⋮----
// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",
⋮----
// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
//   "node_modules"
// ],
⋮----
// An array of file extensions your modules use
⋮----
// modulePaths: ['src'],
⋮----
// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
// moduleNameMapper: {},
⋮----
// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],
⋮----
// Activates notifications for test results
// notify: false,
⋮----
// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",
⋮----
// A preset that is used as a base for Jest's configuration
// preset: undefined,
⋮----
// Run tests from one or more projects
// projects: undefined,
⋮----
// Use this configuration option to add custom reporters to Jest
// reporters: undefined,
⋮----
// Automatically reset mock state before every test
// resetMocks: false,
⋮----
// Reset the module registry before running each individual test
// resetModules: false,
⋮----
// A path to a custom resolver
// resolver: undefined,
⋮----
// Automatically restore mock state and implementation before every test
// restoreMocks: false,
⋮----
// The root directory that Jest should scan for tests and modules within
// rootDir: undefined,
⋮----
// A list of paths to directories that Jest should use to search for files in
// roots: [
//   "<rootDir>"
// ],
⋮----
// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",
⋮----
// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],
⋮----
// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: [],
⋮----
// The number of seconds after which a test is considered as slow and reported as such in the results.
// slowTestThreshold: 5,
⋮----
// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],
⋮----
// The test environment that will be used for testing
// testEnvironment: "jest-environment-node",
⋮----
// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},
⋮----
// Adds a location field to test results
// testLocationInResults: false,
⋮----
// The glob patterns Jest uses to detect test files
⋮----
// "**/__tests__/**/*.[jt]s?(x)",
⋮----
// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
// testPathIgnorePatterns: [
//   "/node_modules/"
// ],
⋮----
// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],
⋮----
// This option allows the use of a custom results processor
// testResultsProcessor: undefined,
⋮----
// This option allows use of a custom test runner
// testRunner: "jest-circus/runner",
⋮----
// A map from regular expressions to paths to transformers
// transform: undefined,
⋮----
// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
// transformIgnorePatterns: [
//   "/node_modules/",
//   "\\.pnp\\.[^\\/]+$"
// ],
⋮----
// Prevents import esm module error from v1 axios release, issue #5026
⋮----
// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,
⋮----
// Indicates whether each individual test should be reported during the run
// verbose: undefined,
verbose: true, // report individual test
⋮----
// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],
⋮----
// Whether to use watchman for file crawling
// watchman: true,

================
File: LICENSE.md
================
Copyright 2022 Tiago Siebler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

================
File: postBuild.sh
================
#!/bin/bash
#
#   Add package.json files to cjs/mjs subtrees
#

cat >dist/cjs/package.json <<!EOF
{
    "type": "commonjs"
}
!EOF

cat >dist/mjs/package.json <<!EOF
{
    "type": "module"
}
!EOF

find src -name '*.d.ts' -exec cp {} dist/mjs \;
find src -name '*.d.ts' -exec cp {} dist/cjs \;

================
File: tsconfig.cjs.json
================
{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "module": "commonjs",
    "outDir": "dist/cjs",
    "target": "esnext"
  },
  "include": ["src/**/*.*"]
}

================
File: tsconfig.esm.json
================
{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "module": "esnext",
    "outDir": "dist/mjs",
    "target": "esnext"
  },
  "include": ["src/**/*.*"]
}

================
File: tsconfig.json
================
{
  "compilerOptions": {
    "allowSyntheticDefaultImports": true,
    "baseUrl": ".",
    "noEmitOnError": true,
    "declaration": true,
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": false,
    "inlineSourceMap": false,
    "lib": ["esnext", "DOM"],
    "listEmittedFiles": false,
    "listFiles": false,
    "moduleResolution": "node",
    "noFallthroughCasesInSwitch": true,
    "noImplicitAny": true,
    "noUnusedParameters": true,
    "pretty": true,
    "removeComments": false,
    "resolveJsonModule": true,
    "skipLibCheck": false,
    "sourceMap": true,
    "strict": true,
    "strictNullChecks": true,
    "types": ["node", "jest"],
    "module": "CommonJS",
    "outDir": "dist/cjs",
    "target": "ESNext"
  },
  "compileOnSave": true,
  "include": ["src/**/*.*", "test/**/*.*", ".eslintrc.cjs"],
  "exclude": ["node_modules", "**/node_modules/*", "coverage", "doc", "dist"]
}

================
File: tsconfig.linting.json
================
{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "module": "commonjs",
    "target": "esnext",
    "rootDir": "../",
    "allowJs": true
  },
  "include": [
    "src/**/*.*",
    "test/**/*.*",
    "examples/**/*.*",
    ".eslintrc.cjs",
    "jest.config.ts",
    "webpack/webpack.config.ts"
  ]
}

================
File: examples/Rest/app.okx.com.ts
================
import { RestClient, WebsocketClient } from '../../src/index.js';
⋮----
// or
// import { RestClient } from 'okx-api';
⋮----
/**
   * To use "app.okx.com", set market to "US"
   *
   * Note: your available functionality may differ, refer to the corresponding API docs for more details:
   * https://app.okx.com/docs-v5/en/#overview-production-trading-services
   */
⋮----
/**
 * This is a simple script wrapped in a immediately invoked function expression, designed to make public API calls without credentials
 */
⋮----
// Raw data will arrive on the 'update' event
⋮----
// console.log(
//   new Date(),
//   'ws update (raw data received)',
//   JSON.stringify(data, null, 2),
// );
// console.log('ws update (raw data received)', JSON.stringify(data, null, 2));

================
File: examples/Rest/demo-trading.ts
================
import { RestClient, WebsocketClient } from '../../src/index.js';
⋮----
// or
// import { RestClient} from 'okx-api';
⋮----
// read from environmental variables, your demo trading keys
⋮----
// okx api credentials
⋮----
// Raw data will arrive on the 'update' event
⋮----
// console.log('ws update (raw data received)', JSON.stringify(data, null, 2));
⋮----
// Replies (e.g. authenticating or subscribing to channels) will arrive on the 'response' event
⋮----
// console.log('ws response: ', JSON.stringify(data, null, 2));
⋮----
// Subscribe to demo account events:
⋮----
/** Simple examples for private REST API calls with bybit's V5 REST APIs */
⋮----
// Trade USDT linear perps

================
File: examples/Rest/my.okx.com.ts
================
import { RestClient, WebsocketClient } from '../../src/index.js';
⋮----
// or
// import { RestClient } from 'okx-api';
⋮----
/**
   * To use "my.okx.com", set market to "EEA"
   *
   * Note: your available functionality may differ, refer to the corresponding API docs for more details:
   * https://my.okx.com/docs-v5/en/#overview-production-trading-services
   */
⋮----
async function start()
⋮----
// Raw data will arrive on the 'update' event
⋮----
// console.log(
//   new Date(),
//   'ws update (raw data received)',
//   JSON.stringify(data, null, 2),
// );
// console.log('ws update (raw data received)', JSON.stringify(data, null, 2));

================
File: examples/Rest/rest-private-trade-market.ts
================
import { OrderRequest, RestClient } from '../../src/index.js';
⋮----
// or
// import { RestClient, OrderRequest } from 'okx-api';
⋮----
// read from environmental variables
⋮----
// If running from CLI in unix, you can pass env vars as such:
// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/rest-private-trade-market.ts
⋮----
// note the single quotes, preventing special characters such as $ from being incorrectly passed
⋮----
// apiKey: 'apiKeyHere',
⋮----
// apiSecret: 'apiSecretHere',
⋮----
// apiPass: 'apiPassHere',
⋮----
/** Get available balance for an asset */
async function getAssetBalance(
  client: RestClient,
  coin: string,
): Promise<number | null>
⋮----
/**
 * This is a simple REST API demo script wrapped in a immediately invoked function expression. The logic below will immediately execute if you run this script.
 *
 * It is designed to:
 * - check for any available USDT balance
 * - immediately use half the balance to buy bitcoin (in spot)
 * - check the available BTC balance
 * - immediately sell all available BTC back to USDT
 */

================
File: examples/Rest/rest-public.ts
================
import { RestClient } from '../../src/index.js';
⋮----
// or
// import { RestClient } from 'okx-api';
⋮----
/**
 * This is a simple script wrapped in a immediately invoked function expression, designed to make public API calls without credentials
 */

================
File: examples/Websocket/app.okx.com.ts
================
import { RestClient, WebsocketClient } from '../../src/index.js';
⋮----
// or
// import { RestClient } from 'okx-api';
⋮----
/**
   * To use "app.okx.com", set market to "US"
   *
   * Note: your available functionality may differ, refer to the corresponding API docs for more details:
   * https://app.okx.com/docs-v5/en/#overview-production-trading-services
   */
⋮----
/**
 * This is a simple script wrapped in a immediately invoked function expression, designed to make public API calls without credentials
 */
⋮----
// Raw data will arrive on the 'update' event
⋮----
// console.log(
//   new Date(),
//   'ws update (raw data received)',
//   JSON.stringify(data, null, 2),
// );
// console.log('ws update (raw data received)', JSON.stringify(data, null, 2));

================
File: examples/Websocket/ws-private-handle-auth-fail.ts
================
// If you cloned the repo and are using typescript, you can import from src directly:
import { WebsocketClient } from '../../src/index.js';
⋮----
/**
 *
 * This simple example demonstrates one way to handle failed authentication, stopping the
 * websocket client from running into a reconnect-loop when authentication fails (e.g. bad API keys).
 *
 * However, keep in mind it might be safer to make a test REST API call (e.g. fetch account balance) before
 * trying to make a private WS connection to the account.
 *
 */
⋮----
// For private topics, include one or more accounts in an array. Otherwise only public topics will work
⋮----
// Raw data will arrive on the 'update' event
⋮----
// console.log('ws update (raw data received)', JSON.stringify(data, null, 2));
⋮----
// Replies (e.g. authenticating or subscribing to channels) will arrive on the 'response' event
⋮----
// console.log('ws response: ', JSON.stringify(data, null, 2));
⋮----
// Optional, connect before subscribing:
⋮----
// This is optional though. The wsclient will automatically open and subscribe if the connection doesn't exist yet.
⋮----
// Subscribe one event at a time:

================
File: examples/Websocket/ws-private.ts
================
// If you cloned the repo and are using typescript, you can import from src directly:
import { DefaultLogger, WebsocketClient } from '../../src/index.js';
⋮----
// or use the module installed via `npm install okx-api`:
// import { WebsocketClient, DefaultLogger } from 'okx-api';
⋮----
// or if you're not using typescript (e.g. pure nodejs), change the "import" to "require":
// const { WebsocketClient, DefaultLogger } = require('okx-api');
⋮----
// Optional: Inject a custom logger.
// This example overrides the default logger to also log "trace" (super verbose) messages, which are disabled by default
⋮----
// trace: (...params) => console.log('trace', ...params),
⋮----
// For private events, all 3 of the following are required (per account):
⋮----
// If running from CLI in unix, you can pass env vars as such:
// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/ws-private.ts
⋮----
// note the single quotes, preventing special characters such as $ from being incorrectly passed
⋮----
// For Global users (www.okx.com), you don't need to set the market.
// It will use global by default.
// Not needed: market: 'GLOBAL',
⋮----
// For EEA users (my.okx.com), set market to "EEA":
// market: 'EEA',
⋮----
// For US users (app.okx.com), set market to "US":
// market: 'US',
⋮----
// For private topics, include one or more accounts in an array. Otherwise only public topics will work
⋮----
// {
//   apiKey: 'yourApiKeyHere',
//   apiSecret: 'yourApiSecretHere',
//   apiPass: 'yourApiPassHere',
// },
// {
//   apiKey: 'anotherAccountKey',
//   apiSecret: 'anotherAccountSecret',
//   apiPass: 'anotherAccountPass',
// },
⋮----
// Raw data will arrive on the 'update' event
⋮----
// console.log('ws update (raw data received)', JSON.stringify(data, null, 2));
⋮----
// Replies (e.g. authenticating or subscribing to channels) will arrive on the 'response' event
⋮----
// console.log('ws response: ', JSON.stringify(data, null, 2));
⋮----
// Optional, connect before subscribing:
// wsClient.connectPrivate();
⋮----
// This is optional though. The wsclient will automatically open and subscribe if the connection doesn't exist yet.
⋮----
/**
   * # Subscribing to channels
   *
   * Subscribe to channels using the inner "args" part of the subscription request described in the OKX API docs.
   *
   * For example, if the docs state your request should look as such:
   {
     op: "subscribe",
     args: [
       {
         channel: "account"
       }
     ]
   }
   *
   * You should call the wsClient.subscribe function using only the "args".
   *
   * Either of these examples is correct (one channel vs one or more channels in an array):
   wsClient.subscribe({
     channel: 'account'
   });

   wsClient.subscribe([
     {
       channel: "account"
     }
   ])
   */
⋮----
// Subscribe one event at a time:
⋮----
// OR, combine multiple subscription events into one request using an array instead of an object:
⋮----
/**
 * Examples for each private channel listed in the API docs:
 * https://www.okx.com/docs-v5/en/#websocket-api-private-channel
 */
⋮----
// Account events for all symbols
⋮----
// Account events for specific symbol only
⋮----
// Withdrawal events for specific symbol only
⋮----
// Position events on any instrument type
⋮----
// Position events on specific instruments
⋮----
// Balance & position channel
⋮----
// Order channel
⋮----
// Order channel with extra args
⋮----
// Algo orders channel
⋮----
// Advance algo orders channel
⋮----
// Position risk warning channel
⋮----
// Account greeks channel
⋮----
// Spot grid algo orders channel
⋮----
// Contract grid orders channel
⋮----
// Moon grid orders channel
⋮----
// Moon grid orders channel
⋮----
// Grid positions channel
⋮----
// Grid sub orders channel

================
File: examples/Websocket/ws-public.ts
================
import { DefaultLogger, WebsocketClient } from '../../src/index.js';
⋮----
// or use the module installed via `npm install okx-api`:
// import { WebsocketClient, DefaultLogger } from 'okx-api';
⋮----
// or if you're not using typescript (e.g. pure nodejs), change the "import" to "require":
// const { WebsocketClient, DefaultLogger } = require('okx-api');
⋮----
// Optional: Inject a custom logger.
// This example overrides the default logger to also log "trace" (super verbose) messages, which are disabled by default
⋮----
// trace: (...params) => console.log('trace', ...params),
⋮----
// For Global users (www.okx.com), you don't need to set the market.
// It will use global by default.
// Not needed: market: 'GLOBAL',
// For EEA users (my.okx.com), set market to "EEA":
// market: 'EEA',
// For US users (app.okx.com), set market to "US":
// market: 'US',
⋮----
logger, // Optional: inject the custom logger here
⋮----
// Raw data will arrive on the 'update' event
⋮----
// console.log(
//   new Date(),
//   'ws update (raw data received)',
//   JSON.stringify(data, null, 2),
// );
// console.log('ws update (raw data received)', JSON.stringify(data, null, 2));
⋮----
// Replies (e.g. authenticating or subscribing to channels) will arrive on the 'response' event
⋮----
// Send one topic at a time
⋮----
// Or an array of requests
⋮----
/**
 *
 * Examples for each channel: https://www.okx.com/docs-v5/en/#websocket-api-public-channel
 *
 */
⋮----
// Instruments channel
⋮----
// Tickers channel
⋮----
// Open interest channel
⋮----
// Candlesticks channel
⋮----
// Trades channel
⋮----
// Estimated delivery/exercise price channel
⋮----
// Mark price channel
⋮----
// Mark price candlesticks channel
⋮----
// Price limit channel
⋮----
// Order book channel
⋮----
// OPTION summary channel
⋮----
// Funding rate channel
⋮----
// Index candlesticks channel
⋮----
// Index tickers channel
⋮----
// Status channel
⋮----
// Liquidation orders channel

================
File: src/types/rest/request/affiliate.ts
================
export type AffiliatePeriodType =
  | 'last_7d'
  | 'last_30d'
  | 'this_month'
  | 'last_month'
  | 'total'
  | 'today'
  | 'this_week'
  | 'custom';
⋮----
export type AffiliateCommissionCategory = 'SPOT' | 'DERIVATIVE' | 'BSC';
⋮----
export type AffiliateKycStatus = 'unverified' | 'verified';
⋮----
export type AffiliateLinkType = 'standard' | 'co_inviter';
⋮----
export type AffiliateLinkStatus = 'normal' | 'abnormal';
⋮----
export type AffiliateInviteeListOrderBy =
  | 'cTime'
  | 'depAmt'
  | 'vol'
  | 'fee'
  | 'rebate';
⋮----
export type AffiliateSubAffiliateListOrderBy =
  | 'cTime'
  | 'depAmt'
  | 'vol'
  | 'fee'
  | 'rebate';
⋮----
export type AffiliateOrderDir = 'asc' | 'desc';
⋮----
export interface GetAffiliatePerformanceSummaryRequest {
  periodType?: AffiliatePeriodType;
  /** Required when periodType=custom, together with end. Inclusive. */
  begin?: string;
  /** Required when periodType=custom, together with begin. Inclusive. */
  end?: string;
}
⋮----
/** Required when periodType=custom, together with end. Inclusive. */
⋮----
/** Required when periodType=custom, together with begin. Inclusive. */
⋮----
export interface GetInviteeDetailRequest {
  uid: string;
}
⋮----
export interface GetAffiliateInviteeListRequest {
  page?: string;
  limit?: string;
  periodType?: AffiliatePeriodType;
  /** Required when periodType=custom, together with end. Inclusive. */
  begin?: string;
  /** Required when periodType=custom, together with begin. Inclusive. */
  end?: string;
  keyword?: string;
  commissionCategory?: AffiliateCommissionCategory;
  orderBy?: AffiliateInviteeListOrderBy;
  orderDir?: AffiliateOrderDir;
  kycStatus?: AffiliateKycStatus;
  subAffiliateUid?: string;
}
⋮----
/** Required when periodType=custom, together with end. Inclusive. */
⋮----
/** Required when periodType=custom, together with begin. Inclusive. */
⋮----
export interface GetAffiliateLinkListRequest {
  page?: string;
  limit?: string;
  linkType?: AffiliateLinkType;
  linkStatus?: AffiliateLinkStatus;
}
⋮----
export interface GetAffiliateCoInviterLinkListRequest {
  page?: string;
  limit?: string;
  linkStatus?: AffiliateLinkStatus;
}
⋮----
export interface GetAffiliateSubAffiliateListRequest {
  page?: string;
  limit?: string;
  keyword?: string;
  commissionCategory?: AffiliateCommissionCategory;
  orderBy?: AffiliateSubAffiliateListOrderBy;
  orderDir?: AffiliateOrderDir;
}

================
File: src/types/rest/request/block-trading.ts
================
import { OrderSide, RFQLeg } from '../shared.js';
export interface AccountAllocationLeg {
  sz: string;
  instId: string;
  tdMode?: string;
  ccy?: string;
  posSide?: string;
}
⋮----
export interface AccountAllocation {
  acct: string;
  legs: AccountAllocationLeg[];
}
⋮----
export interface CreateBlockRFQRequest {
  counterparties: string[];
  anonymous?: boolean;
  clRfqId?: string;
  tag?: string;
  allowPartialExecution?: boolean;
  legs: RFQLeg[];
  acctAlloc?: AccountAllocation[];
}
⋮----
export interface CancelBlockRFQRequest {
  rfqId?: string;
  clRfqId?: string;
}
⋮----
export interface CancelMultipleBlockRFQRequest {
  rfqIds?: string[];
  clRfqIds?: string[];
}
⋮----
export interface ExecuteBlockQuoteRequest {
  rfqId: string;
  quoteId: string;
}
⋮----
export interface CreateBlockQuoteLeg {
  px: string;
  sz: string;
  instId: string;
  side: OrderSide;
  tgtCcy?: 'base_ccy' | 'quote_ccy';
}
⋮----
export interface CreateBlockQuoteRequest {
  rfqId: string;
  clQuoteId?: string;
  quoteSide: OrderSide;
  anonymous?: boolean;
  expiresIn?: string;
  legs: CreateBlockQuoteLeg[];
}
⋮----
export interface CancelBlockQuoteRequest {
  quoteId?: string;
  clQuoteId?: string;
}
⋮----
export interface CancelMultipleBlockQuoteRequest {
  quoteIds?: string[];
  clQuoteIds?: string[];
}
⋮----
export interface GetBlockRFQSParams {
  rfqId?: string;
  clRfqId?: string;
  state?: string;
  beginId?: string;
  endId?: string;
  limit?: string;
}
⋮----
export interface GetBlockQuoteParams {
  rfqId?: string;
  clRfqId?: string;
  quoteId?: string;
  clQuoteId?: string;
  state?: string;
  beginId?: string;
  endId?: string;
  limit?: string;
}
⋮----
export interface MakerInstrumentData {
  uly?: string;
  instId?: string;
  maxBlockSz?: string;
  makerPxBand?: string;
}
⋮----
export interface SetQuoteProductsRequest {
  instType: string;
  includeAll?: boolean;
  data: MakerInstrumentData[];
}
⋮----
export interface SetMmpConfigRequest {
  timeInterval: string;
  frozenInterval: string;
  countLimit: string;
}

================
File: src/types/rest/request/convert.ts
================
export interface ConvertQuoteEstimateRequest {
  baseCcy: string;
  quoteCcy: string;
  side: string;
  rfqSz: string;
  rfqSzCcy: string;
  clTReqId?: string;
  tag?: string;
  /** 0: standard convert (default), 1: large order convert for VIP */
  convertMode?: '0' | '1';
}
⋮----
/** 0: standard convert (default), 1: large order convert for VIP */
⋮----
export interface ConvertTradeRequest {
  quoteId: string;
  baseCcy: string;
  quoteCcy: string;
  side: string;
  sz: string;
  szCcy: string;
  clTReqId?: string;
  tag?: string;
  /** 0: standard convert (default), 1: large order convert for VIP */
  convertMode?: '0' | '1';
}
⋮----
/** 0: standard convert (default), 1: large order convert for VIP */

================
File: src/types/rest/request/dual-investment.ts
================
export interface GetDcdProductsRequest {
  baseCcy: string;
  quoteCcy: string;
  optType: 'C' | 'P';
}
⋮----
export interface RequestDcdQuoteRequest {
  productId: string;
  notionalSz: string;
  notionalCcy: string;
}
⋮----
export interface SubmitDcdTradeRequest {
  quoteId: string;
}
⋮----
export interface RequestDcdRedeemQuoteRequest {
  ordId: string;
}
⋮----
export interface SubmitDcdRedeemRequest {
  ordId: string;
  quoteId: string;
}
⋮----
export interface GetDcdOrderStatusRequest {
  ordId: string;
}
⋮----
export type DcdOrderState =
  | 'initial'
  | 'live'
  | 'pending_settle'
  | 'settled'
  | 'pending_redeem'
  | 'redeemed'
  | 'rejected';
⋮----
export interface GetDcdOrderHistoryRequest {
  ordId?: string;
  productId?: string;
  uly?: string;
  state?: DcdOrderState;
  beginId?: string;
  endId?: string;
  begin?: string;
  end?: string;
  limit?: string;
}

================
File: src/types/rest/request/public.ts
================
export interface EconomicCalendarRequest {
  region?: string;
  importance?: '1' | '2' | '3';
  before?: string;
  after?: string;
  limit?: string;
}
⋮----
export interface UnitConvertRequest {
  type?: '1' | '2';
  instId: string;
  sz: string;
  px?: string;
  unit?: 'coin' | 'usds';
  opType: 'open' | 'close';
}
⋮----
export interface CandleRequest {
  instId: string;
  after?: string;
  before?: string;
  bar?: string;
  limit?: string;
}
⋮----
export interface GetPremiumHistoryRequest {
  instId: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GetContractOpenInterestHistoryRequest {
  instId: string;
  period?: string;
  end?: string;
  begin?: string;
  limit?: string;
}
⋮----
export interface GetContractTakerVolumeRequest {
  instId: string;
  period?: string;
  unit?: string;
  end?: string;
  begin?: string;
  limit?: string;
}
⋮----
export interface GetTopTradersContractLongShortRatioRequest {
  instId: string;
  period?: string;
  end?: string;
  begin?: string;
  limit?: string;
}
⋮----
export interface GetOptionTradesRequest {
  instId?: string;
  instFamily?: string;
  optType?: 'C' | 'P';
}
⋮----
/**
 * @see GET /api/v5/public/market-data-history
 * Module 11: borrowing rate (T+2 typical, UTC+8 for timestamp parsing).
 */
export interface GetHistoricalMarketDataRequest {
  /**
   * 1: trades, 2: 1m candles, 3: funding rate, 4: 400-level book, 5: 5000-level, 6: 50-level (use 4/5), 11: borrowing rate
   */
  module: string;
  instType: 'SPOT' | 'FUTURES' | 'SWAP' | 'OPTION';
  instIdList?: string;
  instFamilyList?: string;
  dateAggrType: 'daily' | 'monthly';
  begin: string;
  end: string;
}
⋮----
/**
   * 1: trades, 2: 1m candles, 3: funding rate, 4: 400-level book, 5: 5000-level, 6: 50-level (use 4/5), 11: borrowing rate
   */
⋮----
/**
 * @see GET /api/v5/public/event-contract/series
 */
export interface GetEventContractSeriesRequest {
  seriesId?: string;
}
⋮----
/**
 * @see GET /api/v5/public/event-contract/events
 */
export interface GetEventContractEventsRequest {
  seriesId: string;
  eventId?: string;
  state?: 'preopen' | 'live' | 'settling' | 'expired' | string;
  limit?: string;
  before?: string;
  after?: string;
}
⋮----
/**
 * @see GET /api/v5/public/event-contract/markets
 */
export interface GetEventContractMarketsRequest {
  seriesId: string;
  eventId?: string;
  instId?: string;
  state?: 'preopen' | 'live' | 'settling' | 'expired' | string;
  limit?: string;
  before?: string;
  after?: string;
}
⋮----
/**
 * @see GET /api/v5/public/insurance-fund (Get security fund)
 * @see 2026-06-09 changelog — `regular_update` removed; `adl` and `platform_revenue` deprecated (return empty).
 */
export interface GetInsuranceFundRequest {
  instType?: string;
  /**
   * `adl` and `platform_revenue` are deprecated and return empty values.
   * `regular_update` was removed in 2026-06-09.
   */
  type?:
    | 'liquidation_balance_deposit'
    | 'bankruptcy_loss'
    | 'platform_revenue'
    | 'adl';
  instFamily?: string;
  ccy?: string;
  before?: string;
  after?: string;
  limit?: string;
}
⋮----
/**
   * `adl` and `platform_revenue` are deprecated and return empty values.
   * `regular_update` was removed in 2026-06-09.
   */

================
File: src/types/rest/request/stable-rewards.ts
================
export interface GetStableRewardsProductInfoRequest {
  ccy: string;
}
⋮----
export interface RequestStableRewardsQuoteRequest {
  ccy: string;
  settleCcy: string;
  action: 'subscribe' | 'redeem';
  amt: string;
}
⋮----
export interface SubmitStableRewardsTradeRequest {
  quoteId: string;
}
⋮----
export interface GetStableRewardsBalanceRequest {
  ccy?: string;
}
⋮----
export interface GetStableRewardsApyHistoryRequest {
  ccy: string;
  days?: string;
}
⋮----
export interface GetStableRewardsSubscribeRedeemHistoryRequest {
  ccy: string;
  type?: 'subscribe' | 'redeem';
  status?: 'pending' | 'success' | 'failed';
  after?: string;
  before?: string;
  limit?: string;
}

================
File: src/types/rest/response/private-affiliate.ts
================
import type { AffiliateCommissionCategory } from '../request/affiliate.js';
⋮----
export interface AffiliatePerformanceSummaryDetail {
  commissionCategory: AffiliateCommissionCategory;
  firstTraderCnt: string;
  traderCnt: string;
  vol: string;
  commission: string;
}
⋮----
export interface AffiliatePerformanceSummary {
  uTime: string;
  inviteeCnt: string;
  depAmt: string;
  details: AffiliatePerformanceSummaryDetail[];
}
⋮----
export interface InviteeDetail {
  inviteeLevel: string;
  joinTime: string;
  inviteeRebateRate: string;
  totalCommission: string;
  firstTradeTime: string;
  level: string;
  depAmt: string;
  wdAmt: string;
  volMonth: string;
  totalVol: string;
  accFee: string;
  kycTime: string;
  region: string;
  affiliateCode: string;
}
⋮----
export type AffiliateInviteeListKycStatus = 'unverified' | 'verified';
⋮----
export interface AffiliateInviteeListItem {
  uid: string;
  country: string;
  joinTime: string;
  firstTradeTime: string;
  channelName: string;
  rebateRate: string;
  feeTierRank: string;
  kycStatus: AffiliateInviteeListKycStatus;
  kycTime: string;
  depAmt: string;
  totalVol: string;
  totalFee: string;
  totalCommission: string;
  isCompliant: boolean;
}
⋮----
export type AffiliateLinkListLinkType = 'standard' | 'co_inviter';
⋮----
export type AffiliateLinkListLinkStatus = 'normal' | 'abnormal';
⋮----
export interface AffiliateLinkListItem {
  channelId: string;
  channelName: string;
  joinLink: string;
  linkType: AffiliateLinkListLinkType;
  inviterCommissionRate: string;
  coInviterCommissionRate: string;
  inviteeDiscountRate: string;
  inviteeCnt: string;
  traderCnt: string;
  totalCommission: string;
  commission24h: string;
  cTime: string;
  isDefault: boolean;
  linkStatus: AffiliateLinkListLinkStatus;
}
⋮----
export type AffiliateChannelAssessmentStatus =
  | 'valid'
  | 'not_reach_trade'
  | 'not_reach_invite'
  | 'not_reach_both';
⋮----
export type AffiliateInviterChannelStatus =
  | 'valid'
  | 'identity_invalid'
  | 'level_downgraded';
⋮----
export type AffiliateCoInviterChannelStatus =
  | 'valid'
  | 'identity_invalid'
  | 'not_reach_assessment'
  | 'identity_invalid_and_not_reach_assessment';
⋮----
export interface AffiliateCoInviterLinkListItem {
  channelId: string;
  channelName: string;
  joinLink: string;
  inviterCommissionRate: string;
  coInviterCommissionRate: string;
  inviteeDiscountRate: string;
  parUserName: string;
  coUserName: string;
  isCompliant: boolean;
  note?: string;
  isDefault: boolean;
  totalCommission: string;
  commission24h: string;
  inviteeCnt: string;
  traderCnt: string;
  clickCnt: string;
  totalFee: string;
  cTime: string;
  channelAssessmentStatus: AffiliateChannelAssessmentStatus;
  inviterChannelStatus: AffiliateInviterChannelStatus;
  coInviterChannelStatus: AffiliateCoInviterChannelStatus;
  linkStatus: AffiliateLinkListLinkStatus;
}
⋮----
export interface AffiliateSubAffiliateListItem {
  subAffiliateUid: string;
  country: string;
  joinTime: string;
  subAffiliateLevel: string;
  commissionRate: string;
  isCompliant: boolean;
  inviteeCnt: string;
  traderCnt: string;
  depAmt: string;
  totalVol: string;
  totalFee: string;
  totalCommission: string;
}

================
File: src/types/rest/response/private-block-trading.ts
================
import { RFQLeg, RFQQuoteLegExtended } from '../shared.js';
⋮----
export interface BlockCounterParty {
  traderName: string;
  traderCode: string;
  type: never; // Currently not live
}
⋮----
type: never; // Currently not live
⋮----
export interface AccountAllocationLegResult {
  instId: string;
  sz: string;
  tdMode: string;
  ccy: string;
  posSide: string;
}
export interface AccountAllocationResult {
  acct: string;
  sCode: string;
  sMsg: string;
  legs: AccountAllocationLegResult[];
}
⋮----
export interface CreateRFQResult {
  cTime: string;
  uTime: string;
  traderCode: string;
  rfqId: string;
  clRfqId: string;
  state: string;
  validUntil: string;
  counterparties: string[];
  legs: Required<RFQLeg>[];
  groupId?: string;
  acctAlloc?: AccountAllocationResult[];
}
⋮----
export interface CancelBlockRFQResult {
  rfqId: string;
  clRfqId: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface AccountAllocationLegExecutionResult {
  instId: string;
  sz: string;
  fee: string;
  feeCcy: string;
  tradeId: string;
}
⋮----
export interface AccountAllocationExecutionResult {
  acct: string;
  blockTdId: string;
  sCode: string;
  sMsg: string;
  legs: AccountAllocationLegExecutionResult[];
}
export interface ExecuteBlockQuoteResult {
  blockTdId: string;
  rfqId: string;
  clRfqId: string;
  quoteId: string;
  clQuoteId: string;
  tTraderCode: string;
  mTraderCode: string;
  cTime: string;
  tag?: string;
  legs: RFQQuoteLegExtended[];
  acctAlloc?: AccountAllocationExecutionResult[];
}
⋮----
export interface CreatedBlockQuoteLeg {
  px: string;
  sz: string;
  instId: string;
  side: string;
  tgtCcy: string;
}
⋮----
export interface CreateBlockQuoteResult {
  cTime: string;
  uTime: string;
  quoteId: string;
  clQuoteId: string;
  rfqId: string;
  quoteSide: string;
  state: string;
  validUntil: string;
  legs: CreatedBlockQuoteLeg[];
}
⋮----
export interface CancelBlockQuoteResult {
  rfqId: string;
  clQuoteId: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface BlockRFQResult {
  rfqId: string;
  clRfqId: string;
  traderCode: string;
  validUntil: string;
  state: string;
  counterparties: string[];
  legs: Required<RFQLeg>[];
  cTime: string;
  uTime: string;
  allowPartialExecution?: boolean;
  groupId?: string;
  acctAlloc?: AccountAllocationResult[];
}
⋮----
export interface BlockQuoteLeg {
  px: string;
  sz: string;
  instId: string;
  side: string;
  tgtCcy: string;
}
⋮----
export interface GetBlockQuoteResult {
  validUntil: string;
  uTime: string;
  cTime: string;
  legs: BlockQuoteLeg[];
  quoteId: string;
  rfqId: string;
  quoteSide: string;
  state: string;
  clQuoteId: string;
  clRfqId: string;
  traderCode: string;
}
⋮----
export interface BlockMakerInstrumentData {
  uly?: string;
  instId?: string;
  maxBlockSz?: string;
  makerPxBand?: string;
}
⋮----
export interface AccountAllocationTradeLegResult {
  instId: string;
  sz: string;
  tradeId: string;
  fee: string;
  feeCcy: string;
}
export interface AccountAllocationTradeResult {
  blockTdId: string;
  errorCode: string;
  acct: string;
  legs: AccountAllocationTradeLegResult[];
}
⋮----
export interface BlockTradeLeg {
  instId: string;
  side: string;
  sz: string;
  px: string;
  tradeId: string;
  fee: string;
  feeCcy: string;
  tradeQuoteCcy?: string;
}
⋮----
export interface BlockTradeResult {
  rfqId: string;
  clRfqId: string;
  quoteId: string;
  clQuoteId: string;
  blockTdId: string;
  tag: string;
  isSuccessful: boolean;
  errorCode: string;
  cTime: string;
  tTraderCode: string;
  mTraderCode: string;
  legs: BlockTradeLeg[];
  groupId?: string;
  acctAlloc?: AccountAllocationTradeResult[];
}
⋮----
export interface BlockMakerInstrumentSettings {
  instType: string;
  includeALL: boolean;
  data: BlockMakerInstrumentData[];
}
⋮----
export interface SetMmpConfigResult {
  timeInterval: string;
  frozenInterval: string;
  countLimit: string;
}
⋮----
export interface BlockMMPConfig {
  frozenInterval: string;
  mmpFrozen: boolean;
  mmpFrozenUntil: string;
  countLimit: string;
  timeInterval: string;
}
⋮----
export interface PublicBlockTradeLeg {
  instId: string;
  tradeId: string;
  px: string;
  sz: string;
  side: 'buy' | 'sell';
}
⋮----
export interface PublicBlockTrade {
  blockTdId: string;
  groupId?: string;
  legs: PublicBlockTradeLeg[];
  strategy?: string;
  cTime: string;
}

================
File: src/types/rest/response/private-dual-investment.ts
================
export interface DcdCurrencyPair {
  baseCcy: string;
  quoteCcy: string;
  optType: 'C' | 'P';
  uly: string;
}
⋮----
export interface DcdProduct {
  absYield: string;
  annualizedYield: string;
  baseCcy: string;
  quoteCcy: string;
  expTime: string;
  interestAccrualTime: string;
  listTime: string;
  maxSize: string;
  minSize: string;
  notionalCcy: string;
  optType: 'C' | 'P';
  productId: string;
  quoteTime: string;
  redeemEndTime: string;
  redeemStartTime: string;
  stepSz: string;
  tradeEndTime: string;
  strike: string;
  uly: string;
}
⋮----
export interface DcdQuote {
  absYield: string;
  annualizedYield: string;
  interestAccrualTime: string;
  notionalSz: string;
  notionalCcy: string;
  productId: string;
  quoteId: string;
  validUntil: string;
  idxPx: string;
}
⋮----
export type DcdTradeOrderState =
  | 'initial'
  | 'pending_book'
  | 'live'
  | 'rejected';
⋮----
export interface DcdTradeResult {
  quoteId: string;
  ordId: string;
  state: DcdTradeOrderState;
}
⋮----
export interface DcdRedeemQuote {
  ordId: string;
  quoteId: string;
  redeemCcy: string;
  redeemSz: string;
  termRate: string;
  validUntil: string;
}
⋮----
export type DcdRedeemConfirmState =
  | 'pending_redeem_booking'
  | 'pending_redeem'
  | 'redeeming'
  | 'redeemed';
⋮----
export interface DcdRedeemResult {
  ordId: string;
  state: DcdRedeemConfirmState;
}
⋮----
export type DcdOrderStatusState =
  | 'initial'
  | 'live'
  | 'pending_settle'
  | 'settled'
  | 'pending_redeem'
  | 'redeemed'
  | 'rejected';
⋮----
export interface DcdOrderStatus {
  ordId: string;
  state: DcdOrderStatusState;
}
⋮----
export interface DcdOrderHistoryItem {
  ordId: string;
  quoteId: string;
  state: DcdOrderStatusState;
  productId: string;
  baseCcy: string;
  quoteCcy: string;
  uly: string;
  strike: string;
  notionalSz: string;
  notionalCcy: string;
  absYield: string;
  annualizedYield: string;
  yieldSz: string;
  yieldCcy: string;
  settleSz: string;
  settleCcy: string;
  settlePx: string;
  settleTime: string;
  expTime: string;
  redeemStartTime: string;
  redeemEndTime: string;
  cTime: string;
  uTime: string;
}

================
File: src/types/rest/response/private-flexible-loan.ts
================
export interface CollateralAsset {
  ccy: string;
  amt: string;
  notionalUsd: string;
}
⋮----
export interface CollateralAssetsResponse {
  assets: CollateralAsset[];
}
⋮----
export interface SupplementaryCollateral {
  ccy: string;
  amt: string;
}
⋮----
export interface GetFlexibleLoanCollateralAssetsRequest {
  ccy?: string;
  /** When the account has multiple active flexible-loan positions. */
  ordId?: string;
}
⋮----
/** When the account has multiple active flexible-loan positions. */
⋮----
export interface MaxLoanRequest {
  borrowCcy: string;
  supCollateral?: SupplementaryCollateral[];
  /** When multiple active loans exist. */
  ordId?: string;
}
⋮----
/** When multiple active loans exist. */
⋮----
export interface MaxLoanResponse {
  borrowCcy: string;
  maxLoan: string;
  notionalUsd: string;
  remainingQuota: string;
}
⋮----
export interface AdjustCollateralRequest {
  type: 'add' | 'reduce';
  collateralCcy: string;
  collateralAmt: string;
  /** When multiple active loans exist. */
  ordId?: string;
}
⋮----
/** When multiple active loans exist. */
⋮----
export interface LoanCurrencyData {
  ccy: string;
  amt: string;
}
⋮----
export interface RiskWarningData {
  instId: string;
  liqPx: string;
}
⋮----
export interface GetLoanInfoRequest {
  /** When the account has multiple active flexible loans . */
  ordId?: string;
}
⋮----
/** When the account has multiple active flexible loans . */
⋮----
export interface LoanInfo {
  /**
   * Active loan / position id when the account can hold multiple loan orders.
   */
  ordId?: string;
  loanNotionalUsd: string;
  loanData: LoanCurrencyData[];
  /** Adjusted collateral value in USD. */
  collateralNotionalUsd: string;
  collateralData: LoanCurrencyData[];
  riskWarningData: RiskWarningData;
  curLTV: string;
  marginCallLTV: string;
  liqLTV: string;
}
⋮----
/**
   * Active loan / position id when the account can hold multiple loan orders.
   */
⋮----
/** Adjusted collateral value in USD. */
⋮----
export interface LoanHistoryRequest {
  type?:
    | 'borrowed'
    | 'repaid'
    | 'collateral_locked'
    | 'collateral_released'
    | 'forced_repayment_buy'
    | 'forced_repayment_sell'
    | 'forced_liquidation'
    | 'partial_liquidation';
  /** When multiple active loans exist. */
  ordId?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
/** When multiple active loans exist. */
⋮----
export interface LoanHistoryItem {
  refId: string;
  type: string;
  ccy: string;
  amt: string;
  ts: string;
}
⋮----
export interface AccruedInterestRequest {
  ccy?: string;
  /** When multiple active loans exist. */
  ordId?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
/** When multiple active loans exist. */
⋮----
export interface AccruedInterestItem {
  refId: string;
  ccy: string;
  loan: string;
  interest: string;
  interestRate: string;
  ts: string;
}

================
File: src/types/rest/response/private-stable-rewards.ts
================
export interface StableRewardsProductInfoDetail {
  ccy: string;
  settleCcy: string;
  subFeeRate: string;
  redemptFeeRate: string;
  minSubAmt: string;
  minRedeemAmt: string;
  remainingSubQuota: string;
  remainingRedemptQuota: string;
  canRedeem: boolean;
}
⋮----
export interface StableRewardsProductInfo {
  details: StableRewardsProductInfoDetail[];
  ts: string;
}
⋮----
export interface StableRewardsQuote {
  quoteId: string;
  quoteAmt: string;
  quoteCcy: string;
  exchRate: string;
  feeRate: string;
  quoteTime: string;
  ttlMs: string;
}
⋮----
export interface StableRewardsTradeResult {
  quoteId: string;
  ordId: string;
}
⋮----
export type StableRewardsBalanceState = 'earning' | 'pending';
⋮----
export interface StableRewardsBalanceDetail {
  ccy: string;
  amt: string;
  totalEarnAccrual: string;
  state: StableRewardsBalanceState;
}
⋮----
export interface StableRewardsBalance {
  details: StableRewardsBalanceDetail[];
  ts: string;
}
⋮----
export interface StableRewardsApyHistoryItem {
  rate: string;
  ts: string;
}
⋮----
export type StableRewardsSubscribeRedeemType = 'subscribe' | 'redeem';
⋮----
export type StableRewardsSubscribeRedeemStatus =
  | 'pending'
  | 'success'
  | 'failed';
⋮----
export interface StableRewardsSubscribeRedeemHistoryItem {
  type: StableRewardsSubscribeRedeemType;
  status: StableRewardsSubscribeRedeemStatus;
  ccy: string;
  settleCcy: string;
  ccyAmt: string;
  settleCcyAmt: string;
  fee: string;
  quoteId: string;
  ordId: string;
  ts: string;
}

================
File: src/types/rest/response/private-trade.ts
================
import {
  AlgoOrderState,
  AlgoOrderType,
  AlgoPositionSide,
  numberInString,
  OrderState,
  OrderType,
  PositionSide,
} from '../shared.js';
⋮----
/**
 * Nested rows in `attachAlgoOrds` on orders / history (incl. trailing stop fields)
 */
export interface AttachAlgoOrderDetail {
  attachAlgoClOrdId?: string;
  tpTriggerPx?: string;
  tpTriggerRatio?: string;
  tpOrdPx?: string;
  tpOrdKind?: string;
  slTriggerPx?: string;
  slTriggerRatio?: string;
  slOrdPx?: string;
  tpTriggerPxType?: string;
  slTriggerPxType?: string;
  sz?: string;
  amendPxOnTriggerType?: string;
  callbackRatio?: string;
  callbackSpread?: string;
  activePx?: string;
}
⋮----
export interface OrderResult {
  clOrdId: string;
  ordId: string;
  tag: string;
  ts: string;
  sCode: numberInString;
  /** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
  subCode?: string;
  sMsg: string;
}
⋮----
/** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
⋮----
export interface CancelledOrderResult {
  clOrdId: string;
  ordId: string;
  sCode: string;
  /** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
  subCode?: string;
  sMsg: string;
}
⋮----
/** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
⋮----
export interface AmendedOrder {
  clOrdId: string;
  ordId: string;
  reqId: string;
  sCode: string;
  /** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
  subCode?: string;
  sMsg: string;
}
⋮----
/** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
⋮----
export interface ClosedPositions {
  instId: string;
  posSide: PositionSide;
}
⋮----
export interface OrderDetails {
  instType: string;
  instId: string;
  ccy: string;
  ordId: string;
  clOrdId: string;
  tag: string;
  px: string;
  sz: string;
  pnl: string;
  ordType: OrderType;
  side: string;
  posSide: PositionSide;
  tdMode: string;
  accFillSz: string;
  fillPx: string;
  tradeId: string;
  fillSz: string;
  fillTime: string;
  state: OrderState;
  avgPx: string;
  lever: string;
  tpTriggerPx: string;
  tpTriggerPxType: string;
  tpOrdPx: string;
  slTriggerPx: string;
  slTriggerPxType: string;
  slOrdPx: string;
  attachAlgoOrds?: AttachAlgoOrderDetail[];
  feeCcy: string;
  fee: string;
  rebateCcy: string;
  rebate: string;
  tgtCcy: string;
  category: string;
  outcome?: string;
  uTime: string;
  cTime: string;
}
⋮----
export interface OrderListItem {
  accFillSz: string;
  avgPx: string;
  cTime: string;
  category: string;
  ccy: string;
  clOrdId: string;
  fee: string;
  feeCcy: string;
  fillPx: string;
  fillSz: string;
  fillTime: string;
  instId: string;
  instType: string;
  lever: string;
  ordId: string;
  ordType: OrderType;
  pnl: string;
  posSide: PositionSide;
  px: string;
  pxUsd: string;
  pxVol: string;
  pxType: string;
  rebate: string;
  rebateCcy: string;
  side: string;
  attachAlgoClOrdId: string;
  slOrdPx: string;
  slTriggerPx: string;
  slTriggerPxType: string;
  state: OrderState;
  stpId: string;
  stpMode: string;
  sz: string;
  tag: string;
  tgtCcy: string;
  tdMode: string;
  source: string;
  tpOrdPx: string;
  tpTriggerPx: string;
  tpTriggerPxType: string;
  tradeId: string;
  reduceOnly: string;
  quickMgnType: string;
  algoClOrdId: string;
  algoId: string;
  uTime: string;
  attachAlgoOrds?: AttachAlgoOrderDetail[];
  outcome?: string;
}
⋮----
export interface HistoricOrder {
  instType: string;
  instId: string;
  ccy: string;
  ordId: string;
  clOrdId: string;
  tag: string;
  px: string;
  pxUsd: string;
  pxVol: string;
  pxType: string;
  sz: string;
  ordType: OrderType;
  side: string;
  posSide: PositionSide;
  tdMode: string;
  accFillSz: string;
  fillPx: string;
  tradeId: string;
  fillSz: string;
  fillTime: string;
  state: OrderState;
  avgPx: string;
  lever: string;
  attachAlgoClOrdId: string;
  tpTriggerPx: string;
  tpTriggerPxType: string;
  tpOrdPx: string;
  slTriggerPx: string;
  slTriggerPxType: string;
  slOrdPx: string;
  attachAlgoOrds?: AttachAlgoOrderDetail[];
  stpId: string;
  stpMode: string;
  feeCcy: string;
  fee: string;
  rebateCcy: string;
  source: string;
  rebate: string;
  tgtCcy: string;
  pnl: string;
  category: string;
  reduceOnly: string;
  cancelSource: string;
  cancelSourceReason: string;
  algoClOrdId: string;
  algoId: string;
  outcome?: string;
  uTime: string;
  cTime: string;
}
⋮----
export interface OrderFill {
  instType: string;
  instId: string;
  tradeId: string;
  ordId: string;
  clOrdId: string;
  billId: string;
  tag: string;
  fillPx: string;
  fillSz: string;
  side: string;
  posSide: PositionSide;
  execType: string;
  feeCcy: string;
  fee: string;
  ts: string;
}
⋮----
export interface AlgoOrderResult {
  algoId: string;
  algoClOrdId: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface AmendAlgoOrderResult extends AlgoOrderResult {
  reqId: string;
}
⋮----
export interface AlgoOrderDetailsResult {
  instType: string;
  instId: string;
  ordId: string;
  ordIdList: string[];
  ccy: string;
  clOrdId: string;
  algoId: string;
  attachAlgoOrds?: AttachAlgoOrderDetail[];
  sz: string;
  closeFraction: string;
  ordType: AlgoOrderType;
  side: string;
  posSide: AlgoPositionSide;
  tdMode: string;
  tgtCcy: string;
  state: AlgoOrderState;
  lever: string;
  tpTriggerPx: string;
  tpTriggerPxType: string;
  tpOrdPx: string;
  slTriggerPx: string;
  slTriggerPxType: string;
  slOrdPx: string;
  triggerPx: string;
  triggerPxType: string;
  ordPx: string;
  actualSz: string;
  actualPx: string;
  actualSide: string;
  pxVar: string;
  pxSpread: string;
  pxLimit: string;
  szLimit: string;
  tag: string;
  timeInterval: string;
  callbackRatio: string;
  callbackSpread: string;
  activePx: string;
  moveTriggerPx: string;
  reduceOnly: string;
  triggerTime: string;
  quickMgnType: string;
  last: string;
  failCode: string;
  algoClOrdId: string;
  amendPxOnTriggerType: string;
  cTime: string;
  isTradeBorrowMode: boolean;
  chaseType?: string;
  chaseVal?: string;
  maxChaseType?: string;
  maxChaseVal?: string;
}
⋮----
export interface AlgoOrderListItem {
  activePx: string;
  actualPx: string;
  actualSide: string;
  actualSz: string;
  algoId: string;
  attachAlgoOrds?: AttachAlgoOrderDetail[];
  cTime: string;
  callbackRatio: string;
  callbackSpread: string;
  ccy: string;
  clOrdId: string;
  instId: string;
  instType: string;
  lever: string;
  moveTriggerPx: string;
  ordId: string;
  ordIdList: string[];
  ordPx: string;
  ordType: AlgoOrderType;
  posSide: AlgoPositionSide;
  pxLimit: string;
  pxSpread: string;
  pxVar: string;
  side: string;
  slOrdPx: string;
  slTriggerPx: string;
  slTriggerPxType: string;
  state: AlgoOrderState;
  sz: string;
  closeFraction: string;
  szLimit: string;
  tag: string;
  tdMode: string;
  tgtCcy: string;
  timeInterval: string;
  tpOrdPx: string;
  tpTriggerPx: string;
  tpTriggerPxType: string;
  triggerPx: string;
  reduceOnly: string;
  triggerPxType: string;
  quickMgnType: string;
  last: string;
  failCode: string;
  algoClOrdId: string;
  triggerTime: string;
  amendPxOnTriggerType: string;
  isTradeBorrowMode: boolean;
  chaseType?: string;
  chaseVal?: string;
  maxChaseType?: string;
  maxChaseVal?: string;
}
⋮----
export interface HistoricAlgoOrder {
  activePx: string;
  actualPx: string;
  actualSide: string;
  actualSz: string;
  algoClOrdId: string;
  algoId: string;
  attachAlgoOrds?: AttachAlgoOrderDetail[];
  cTime: string;
  callbackRatio: string;
  callbackSpread: string;
  ccy: string;
  clOrdId: string;
  closeFraction: string;
  failCode: string;
  instId: string;
  instType: string;
  last: string;
  lever: string;
  moveTriggerPx: string;
  ordId: string;
  ordIdList: string[];
  ordPx: string;
  ordType: AlgoOrderType;
  posSide: AlgoPositionSide;
  pxLimit: string;
  pxSpread: string;
  pxVar: string;
  quickMgnType: string;
  reduceOnly: string;
  side: string;
  slOrdPx: string;
  slTriggerPx: string;
  slTriggerPxType: string;
  state: AlgoOrderState;
  sz: string;
  szLimit: string;
  tag: string;
  tdMode: string;
  tgtCcy: string;
  timeInterval: string;
  tpOrdPx: string;
  tpTriggerPx: string;
  tpTriggerPxType: string;
  triggerPx: string;
  triggerPxType: string;
  triggerTime: string;
  amendPxOnTriggerType: string;
  isTradeBorrowMode: boolean;
  chaseType?: string;
  chaseVal?: string;
  maxChaseType?: string;
  maxChaseVal?: string;
}
⋮----
export interface CancelAllAfterResponse {
  triggerTime: string;
  tag: string;
  ts: string;
}

================
File: src/types/websockets/ws-api-response.ts
================
import { numberInString } from '../rest/shared.js';
⋮----
export interface WSAPICancelOrderResultV5 {
  clOrdId: string;
  ordId: string;
  ts: numberInString;
  sCode: string;
  /** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
  subCode?: string;
  sMsg: string;
}
⋮----
/** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
⋮----
export interface WSAPISpreadPlaceOrderResultV5 {
  clOrdId: string;
  ordId: string;
  tag: string;
  sCode: numberInString;
  /** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
  subCode?: string;
  sMsg: string;
}
⋮----
/** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
⋮----
export interface WSAPISpreadAmendOrderResultV5 {
  clOrdId: string;
  ordId: string;
  reqId: string;
  sCode: string;
  /** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
  subCode?: string;
  sMsg: string;
}
⋮----
/** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
⋮----
export interface WSAPISpreadCancelOrderResultV5 {
  clOrdId: string;
  ordId: string;
  sCode: string;
  /** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
  subCode?: string;
  sMsg: string;
}
⋮----
/** Sub-code of sCode. Returns "" when sCode is 0. @see 2026-03-10 changelog */
⋮----
/**
 * @see Ws public channel: estimated-price
 */
export type WsEstimatedPriceSettleType = 'settlement' | 'delivery' | 'exercise';
⋮----
export interface WsEstimatedPriceData {
  instId: string;
  instType: string;
  settlePx: string;
  settleType: WsEstimatedPriceSettleType;
  ts: string;
}

================
File: src/types/websockets/ws-api.ts
================
import { WS_KEY_MAP, WsKey } from '../../util/websocket-util.js';
import { OrderIdRequest } from '../rest/request/trade.js';
import { OrderResult } from '../rest/response/private-trade.js';
import { numberInString } from '../rest/shared.js';
import {
  WSAPIAmendOrderRequestV5,
  WSAPIAmendSpreadOrderRequestV5,
  WSAPICancelSpreadOrderRequestV5,
  WSAPIMassCancelOrdersRequestV5,
  WSAPIPlaceOrderRequestV5,
  WSAPIPlaceSpreadOrderRequestV5,
  WSAPISpreadMassCancelOrdersRequestV5,
} from './ws-api-request.js';
import {
  WSAPICancelOrderResultV5,
  WSAPISpreadAmendOrderResultV5,
  WSAPISpreadCancelOrderResultV5,
  WSAPISpreadPlaceOrderResultV5,
} from './ws-api-response.js';
import { WsAuthRequestArg, WsChannelSubUnSubRequestArg } from './ws-request.js';
⋮----
export interface WSAPIRequestFlags {
  /** If true, will skip auth requirement for WS API connection */
  authIsOptional?: boolean | undefined;
  /**
   * Request effective deadline. Unix timestamp format in milliseconds, e.g. 1597026383085
   *
   * Only applies for order placement and order amend (batch commands included)
   */
  expTime?: numberInString;
}
⋮----
/** If true, will skip auth requirement for WS API connection */
⋮----
/**
   * Request effective deadline. Unix timestamp format in milliseconds, e.g. 1597026383085
   *
   * Only applies for order placement and order amend (batch commands included)
   */
⋮----
export type WSOperation = 'subscribe' | 'unsubscribe' | 'login';
⋮----
/**
 *
 * Top level requests with args
 *
 */
⋮----
/**

/**
 * request looks like this:
{
  "id": "1512",
  "op": "subscribe",
  "args": [
    {
      "channel": "tickers",
      "instId": "BTC-USDT"
    }
  ]
}
 */
export interface WsRequestOperationOKX<TWSRequestArg> {
  id: string;
  op: WSOperation;
  args?: TWSRequestArg[];
}
⋮----
export interface WsSubRequest
  extends WsRequestOperationOKX<WsChannelSubUnSubRequestArg> {
  op: 'subscribe';
}
⋮----
export interface WsUnsubRequest
  extends WsRequestOperationOKX<WsChannelSubUnSubRequestArg> {
  op: 'unsubscribe';
}
⋮----
export interface WsAuthRequest extends WsRequestOperationOKX<WsAuthRequestArg> {
  op: 'login';
}
⋮----
export type WSAPIPrivateOperations =
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
  | 'order'
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
  | 'batch-orders'
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
  | 'cancel-order'
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders
  | 'batch-cancel-orders'
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
  | 'amend-order'
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
  | 'batch-amend-orders'
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
  | 'mass-cancel';
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
⋮----
export type WSAPIBusinessOperations =
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order
  | 'sprd-order'
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order
  | 'sprd-amend-order'
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
  | 'sprd-cancel-order'
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
  | 'sprd-mass-cancel';
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
⋮----
// When new WS API operations are added, make sure to also update WS_API_Operations[] below
export type WSAPIOperation = WSAPIPrivateOperations | WSAPIBusinessOperations;
⋮----
export interface WSAPIRequestOKX<TRequestParams> {
  id: numberInString;
  op: WSAPIOperation;
  expTime?: numberInString;
  args: TRequestParams[];
}
⋮----
export interface WSAPIResponse<
  TResponseData extends object = object,
  TOperation extends WSAPIOperation = WSAPIOperation,
> {
  wsKey: WsKey;
  id: numberInString;
  op: TOperation;
  code: numberInString;
  msg: string;
  data: TResponseData;
  inTime: numberInString;
  outTime: numberInString;
}
⋮----
export interface WSOperationLoginParams {
  apiKey: string;
  passphrase: string;
  timestamp: number;
  sign: string;
}
⋮----
export type Exact<T> = {
  // This part says: if there's any key that's not in T, it's an error
  [K: string]: never;
} & {
  [K in keyof T]: T[K];
};
⋮----
// This part says: if there's any key that's not in T, it's an error
⋮----
/**
 * List of operations supported for this WsKey (connection)
 */
export interface WsAPIWsKeyTopicMap {
  // Global
  [WS_KEY_MAP.prodPrivate]: WSAPIPrivateOperations;
  [WS_KEY_MAP.prodDemoPrivate]: WSAPIPrivateOperations;

  [WS_KEY_MAP.prodBusiness]: WSAPIBusinessOperations;
  [WS_KEY_MAP.prodDemoBusiness]: WSAPIBusinessOperations;

  // [WS_KEY_MAP.prodPublic]: never;
  // [WS_KEY_MAP.prodDemoPublic]: never;

  // EEA
  [WS_KEY_MAP.eeaLivePrivate]: WSAPIPrivateOperations;
  [WS_KEY_MAP.eeaDemoPrivate]: WSAPIPrivateOperations;

  // [WS_KEY_MAP.eeaLiveBusiness]: never;
  // [WS_KEY_MAP.eeaDemoBusiness]: never;

  // [WS_KEY_MAP.eeaLivePublic]: never;
  // [WS_KEY_MAP.eeaDemoPublic]: never;

  // US
  [WS_KEY_MAP.usLivePrivate]: WSAPIPrivateOperations;
  [WS_KEY_MAP.usDemoPrivate]: WSAPIPrivateOperations;

  // [WS_KEY_MAP.usLiveBusiness]: never;
  // [WS_KEY_MAP.usDemoBusiness]: never;

  // [WS_KEY_MAP.usLivePublic]: never;
  // [WS_KEY_MAP.usDemoPublic]: never;
}
⋮----
// Global
⋮----
// [WS_KEY_MAP.prodPublic]: never;
// [WS_KEY_MAP.prodDemoPublic]: never;
⋮----
// EEA
⋮----
// [WS_KEY_MAP.eeaLiveBusiness]: never;
// [WS_KEY_MAP.eeaDemoBusiness]: never;
⋮----
// [WS_KEY_MAP.eeaLivePublic]: never;
// [WS_KEY_MAP.eeaDemoPublic]: never;
⋮----
// US
⋮----
// [WS_KEY_MAP.usLiveBusiness]: never;
// [WS_KEY_MAP.usDemoBusiness]: never;
⋮----
// [WS_KEY_MAP.usLivePublic]: never;
// [WS_KEY_MAP.usDemoPublic]: never;
⋮----
/**
 * Request parameters expected per operation
 */
export interface WsAPITopicRequestParamMap {
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
  order: WSAPIPlaceOrderRequestV5;
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
  'batch-orders': WSAPIPlaceOrderRequestV5[];
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
  'cancel-order': OrderIdRequest;
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders
  'batch-cancel-orders': OrderIdRequest[];
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
  'amend-order': WSAPIAmendOrderRequestV5;
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
  'batch-amend-orders': WSAPIAmendOrderRequestV5[];
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
  'mass-cancel': WSAPIMassCancelOrdersRequestV5;
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order
  'sprd-order': WSAPIPlaceSpreadOrderRequestV5;
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order
  'sprd-amend-order': WSAPIAmendSpreadOrderRequestV5;
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
  'sprd-cancel-order': WSAPICancelSpreadOrderRequestV5;
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-all-orders
  'sprd-mass-cancel': WSAPISpreadMassCancelOrdersRequestV5;
}
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-all-orders
⋮----
/**
 * Response structure expected for each operation
 */
export interface WsAPIOperationResponseMap {
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
  order: WSAPIResponse<[OrderResult], 'order'>;
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
  'batch-orders': WSAPIResponse<OrderResult[], 'batch-orders'>;
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
  'cancel-order': WSAPIResponse<[WSAPICancelOrderResultV5], 'cancel-order'>;
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders
  'batch-cancel-orders': WSAPIResponse<
    WSAPICancelOrderResultV5[],
    'batch-cancel-orders'
  >;
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
  'amend-order': WSAPIResponse<[OrderResult], 'amend-order'>;
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
  'batch-amend-orders': WSAPIResponse<[OrderResult], 'batch-amend-orders'>;
  // https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
  'mass-cancel': WSAPIResponse<[{ result: boolean }], 'mass-cancel'>;
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order
  'sprd-order': WSAPIResponse<[WSAPISpreadPlaceOrderResultV5], 'sprd-order'>;
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order
  'sprd-amend-order': WSAPIResponse<
    [WSAPISpreadAmendOrderResultV5],
    'sprd-amend-order'
  >;
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
  'sprd-cancel-order': WSAPIResponse<
    [WSAPISpreadCancelOrderResultV5],
    'sprd-cancel-order'
  >;
  // https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-all-orders
  'sprd-mass-cancel': WSAPIResponse<[{ result: boolean }], 'sprd-mass-cancel'>;
}
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
⋮----
// https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
⋮----
// https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-all-orders

================
File: src/types/websockets/ws-events.ts
================
import { WsChannel } from './ws-request.js';
⋮----
export interface MessageEventLike {
  target: WebSocket;
  type: 'message';
  data: string;
}
⋮----
export function isMessageEvent(msg: unknown): msg is MessageEventLike
⋮----
export interface WsEvent {
  event:
    | 'error'
    | 'login'
    | 'subscribe'
    | 'unsubscribe'
    | 'channel-conn-count'
    | 'notice';
  code?: string;
  msg?: string;
  connId?: string;
  arg?: any;
  data?: any;
}
⋮----
export interface WsDataEvent<T = any> {
  arg: {
    channel: WsChannel;
    uid?: string;
    instId?: string;
    instFamily?: string;
    instType?: string;
  };
  data: T;
}
⋮----
export interface WsLoginEvent extends WsEvent {
  event: 'login';
}
⋮----
export interface WsChannelConnInfoEvent extends WsEvent {
  event: 'channel-conn-count';
  channel: string;
  connId: string;
  connCount: string;
}
⋮----
export type WsResponse = WsEvent;
⋮----
/**
 * Order book push for `books`, `books-l2-tbt`, `books50-l2-tbt`.
 * @see 2026-06-23 changelog — `checksum` is deprecated (fixed to 0); use `seqId`/`prevSeqId` instead.
 */
export interface WsOrderBookLevel {
  asks: [string, string, string, string][];
  bids: [string, string, string, string][];
  ts: string;
  /** @deprecated Fixed to 0 — use seqId/prevSeqId for integrity verification */
  checksum?: number;
  prevSeqId?: number;
  seqId?: number;
}
⋮----
/** @deprecated Fixed to 0 — use seqId/prevSeqId for integrity verification */
⋮----
/**
 * @see WS / ADL warning channel
 * @see 2026-06-09 changelog — several fields return "" in warning/adl state; normal state no longer pushes.
 */
export interface WsAdlWarningData {
  state: 'normal' | 'warning' | 'adl' | string;
  ccy?: string;
  maxBal?: string;
  maxBalTs?: string;
  adlType?: string;
  adlBal?: string;
  adlRecBal?: string;
  decRate?: string;
  /** @deprecated Returns "" per 2026-06-09 changelog */
  adlRate?: string;
  /** @deprecated Returns "" per 2026-06-09 changelog */
  adlRecRate?: string;
}
⋮----
/** @deprecated Returns "" per 2026-06-09 changelog */
⋮----
/** @deprecated Returns "" per 2026-06-09 changelog */

================
File: src/types/websockets/ws-request.ts
================
import type { InstrumentType } from '../rest/shared.js';
⋮----
export interface WsAuthRequestArg {
  apiKey: string;
  passphrase: string;
  timestamp: string;
  sign: string;
}
⋮----
export type WsTradeOp =
  | 'order'
  | 'batch-orders'
  | 'cancel-order'
  | 'batch-cancel-orders'
  | 'amend-order'
  | 'batch-amend-order';
⋮----
export type WsPrivateChannel =
  | 'account'
  | 'positions'
  | 'balance_and_position'
  | 'orders'
  | 'orders-algo'
  | 'algo-advance'
  | 'liquidation-warning'
  | 'adl-warning'
  | 'account-greeks'
  | 'grid-orders-spot'
  | 'grid-orders-contract'
  | 'grid-orders-moon'
  | 'grid-positions'
  | 'grid-sub-orders';
⋮----
export type WsPublicKlineChannel =
  | 'candle1Y'
  | 'candle6M'
  | 'candle3M'
  | 'candle1M'
  | 'candle1W'
  | 'candle1D'
  | 'candle2D'
  | 'candle3D'
  | 'candle5D'
  | 'candle12H'
  | 'candle6H'
  | 'candle4H'
  | 'candle2H'
  | 'candle1H'
  | 'candle30m'
  | 'candle15m'
  | 'candle5m'
  | 'candle3m'
  | 'candle1m'
  | 'candle1s'
  | 'candle1Yutc'
  | 'candle3Mutc'
  | 'candle1Mutc'
  | 'candle1Wutc'
  | 'candle1Dutc'
  | 'candle2Dutc'
  | 'candle3Dutc'
  | 'candle5Dutc'
  | 'candle12Hutc'
  | 'candle6Hutc';
⋮----
export type WsPublicMarkPriceKlineChannel =
  | 'mark-price-candle1Y'
  | 'mark-price-candle6M'
  | 'mark-price-candle3M'
  | 'mark-price-candle1M'
  | 'mark-price-candle1W'
  | 'mark-price-candle1D'
  | 'mark-price-candle2D'
  | 'mark-price-candle3D'
  | 'mark-price-candle5D'
  | 'mark-price-candle12H'
  | 'mark-price-candle6H'
  | 'mark-price-candle4H'
  | 'mark-price-candle2H'
  | 'mark-price-candle1H'
  | 'mark-price-candle30m'
  | 'mark-price-candle15m'
  | 'mark-price-candle5m'
  | 'mark-price-candle3m'
  | 'mark-price-candle1m'
  | 'mark-price-candle1Yutc'
  | 'mark-price-candle3Mutc'
  | 'mark-price-candle1Mutc'
  | 'mark-price-candle1Wutc'
  | 'mark-price-candle1Dutc'
  | 'mark-price-candle2Dutc'
  | 'mark-price-candle3Dutc'
  | 'mark-price-candle5Dutc'
  | 'mark-price-candle12Hutc'
  | 'mark-price-candle6Hutc';
⋮----
export type WsPublicIndexKlineChannel =
  | 'index-candle1Y'
  | 'index-candle6M'
  | 'index-candle3M'
  | 'index-candle1M'
  | 'index-candle1W'
  | 'index-candle1D'
  | 'index-candle2D'
  | 'index-candle3D'
  | 'index-candle5D'
  | 'index-candle12H'
  | 'index-candle6H'
  | 'index-candle4H index -candle2H'
  | 'index-candle1H'
  | 'index-candle30m'
  | 'index-candle15m'
  | 'index-candle5m'
  | 'index-candle3m'
  | 'index-candle1m'
  | 'index-candle1Yutc'
  | 'index-candle3Mutc'
  | 'index-candle1Mutc'
  | 'index-candle1Wutc'
  | 'index-candle1Dutc'
  | 'index-candle2Dutc'
  | 'index-candle3Dutc'
  | 'index-candle5Dutc'
  | 'index-candle12Hutc'
  | 'index-candle6Hutc';
⋮----
export type WsPublicOrderBooksChannel =
  | 'books'
  | 'books5'
  | 'bbo-tbt'
  | 'books-l2-tbt'
  | 'books50-l2-tpt';
⋮----
export type WsPublicChannel =
  | 'instruments'
  | 'tickers'
  | 'open-interest'
  | WsPublicKlineChannel
  | WsPublicMarkPriceKlineChannel
  | WsPublicIndexKlineChannel
  | 'trades'
  | 'estimated-price'
  | 'mark-price'
  | 'price-limit'
  | WsPublicOrderBooksChannel
  | 'opt-summary'
  | 'funding-rate'
  | 'index-tickers'
  | 'status'
  | 'liquidation-orders'
  | 'event-contract-markets';
⋮----
export type WsBusinessPrivateChannel =
  | 'orders-algo'
  | 'algo-advance'
  | 'deposit-info'
  | 'withdrawal-info'
  | 'grid-orders-spot'
  | 'grid-orders-contract'
  | 'grid-orders-moon'
  | 'grid-positions'
  | 'grid-sub-orders'
  | 'algo-recurring-buy';
⋮----
export type WsBusinessPublicChannel =
  | WsPublicKlineChannel
  | WsPublicMarkPriceKlineChannel
  | WsPublicIndexKlineChannel;
⋮----
export type WsBusinessChannel =
  | WsBusinessPrivateChannel
  | WsBusinessPublicChannel;
⋮----
export type WsChannel = WsPublicChannel | WsPrivateChannel | WsBusinessChannel;
⋮----
/** Used to trigger order actions over websockets (e.g. placing & cancelling orders) */
export interface WsTradeBaseRequest {
  op: WsTradeOp;
  id: string;
  args: any[];
}
⋮----
export interface WsBaseRequestArg {
  channel: WsChannel;
}
⋮----
/**
 *
 * Args to be sent with top level requests
 *
 */
⋮----
export interface WsPrivateChannelArgTickers extends WsBaseRequestArg {
  channel: 'tickers';
  instId: string;
}
⋮----
export interface WsPrivateChannelArgWithCcy extends WsBaseRequestArg {
  channel: 'account' | 'account-greeks' | 'withdrawal-info';
  ccy?: string;
}
⋮----
/** `ANY` is used by some private subscription args; instruments channel uses `EVENTS` for event contracts. */
export type WsChannelArgInstType = InstrumentType | 'ANY';
⋮----
export interface WsPrivateChannelArgWithInstFamily extends WsBaseRequestArg {
  channel: 'positions' | 'orders' | 'orders-algo' | 'liquidation-warning';
  instType: WsChannelArgInstType;
  instFamily?: string;
  instId?: string;
}
⋮----
export interface WsPrivateChannelArgAlgo extends WsBaseRequestArg {
  channel: 'algo-advance';
  instType: WsChannelArgInstType;
  instId?: string;
  algoId?: string;
}
⋮----
export interface WsPrivateChannelArgBalanceAndPosition
  extends WsBaseRequestArg {
  channel: 'balance_and_position';
}
⋮----
export interface WsPrivateChannelArgGridOrders extends WsBaseRequestArg {
  channel: 'grid-orders-spot' | 'grid-orders-contract' | 'grid-orders-moon';
  instType: 'SPOT' | 'ANY';
  instId?: string;
  algoId?: string;
}
⋮----
export interface WsPrivateChannelArgGridOther extends WsBaseRequestArg {
  channel: 'grid-positions' | 'grid-sub-orders';
  algoId: string;
}
⋮----
export interface WsPublicChannelArgInstType extends WsBaseRequestArg {
  channel: 'instruments';
  instType: WsChannelArgInstType;
}
⋮----
export interface WsPublicChannelArgInstId extends WsBaseRequestArg {
  channel:
    | 'tickers'
    | 'open-interest'
    | WsPublicKlineChannel
    | WsPublicMarkPriceKlineChannel
    | WsPublicIndexKlineChannel
    | 'trades'
    | 'mark-price'
    | 'price-limit'
    | WsPublicOrderBooksChannel
    | 'funding-rate'
    | 'index-tickers';
  instId: string;
}
⋮----
export type WsPublicChannelArgInstIdOrFamily = {
  channel: 'estimated-price';
  instType: 'OPTION' | 'FUTURES' | 'SWAP' | 'EVENTS';
} & (
  | {
      instId: string;
    }
  | {
      instFamily: string;
    }
);
⋮----
export interface WsPublicChannelArgOptionSummary extends WsBaseRequestArg {
  channel: 'opt-summary';
  instFamily: string;
}
⋮----
export interface WsPublicChannelArgStatus extends WsBaseRequestArg {
  channel: 'status';
}
⋮----
export interface WsPublicChannelArgLiquidationOrders extends WsBaseRequestArg {
  channel: 'liquidation-orders';
  instType: 'SWAP' | 'FUTURES';
}
⋮----
/** Event contract market status & floor strikes. @see public WS `event-contract-markets` */
export interface WsPublicChannelArgEventContractMarkets
  extends WsBaseRequestArg {
  channel: 'event-contract-markets';
  instType: 'EVENTS';
}
⋮----
export type WsChannelSubUnSubRequestArg =
  | WsPrivateChannelArgTickers
  | WsPrivateChannelArgWithCcy
  | WsPrivateChannelArgWithInstFamily
  | WsPrivateChannelArgAlgo
  | WsPrivateChannelArgBalanceAndPosition
  | WsPrivateChannelArgGridOrders
  | WsPrivateChannelArgGridOther
  | WsPublicChannelArgInstType
  | WsPublicChannelArgInstId
  | WsPublicChannelArgInstIdOrFamily
  | WsPublicChannelArgOptionSummary
  | WsPublicChannelArgStatus
  | WsPublicChannelArgLiquidationOrders
  | WsPublicChannelArgEventContractMarkets;

================
File: src/websocket-client-legacy.ts
================
/* eslint-disable @typescript-eslint/no-unused-vars */
/* eslint-disable @typescript-eslint/no-unsafe-declaration-merging */
import { EventEmitter } from 'events';
import WebSocket from 'isomorphic-ws';
⋮----
import { APICredentials } from './types/shared.js';
import {
  WsAuthRequest,
  WsSubRequest,
  WsUnsubRequest,
} from './types/websockets/ws-api.js';
import { WsDataEvent } from './types/websockets/ws-events.js';
import {
  WebsocketClientOptions,
  WSClientConfigurableOptions,
} from './types/websockets/ws-general.js';
import {
  WsAuthRequestArg,
  WsChannelSubUnSubRequestArg,
} from './types/websockets/ws-request.js';
import { WSClientEventMap } from './util/BaseWSClient.js';
import { DefaultLogger } from './util/logger.js';
import {
  isConnCountEvent,
  isWsDataEvent,
  isWsErrorEvent,
  isWsLoginEvent,
  isWsSubscribeEvent,
  isWsUnsubscribeEvent,
} from './util/typeGuards.js';
import { signMessage } from './util/webCryptoAPI.js';
import {
  getMaxTopicsPerSubscribeEventForMarket,
  getWsKeyForMarket,
  getWsKeyForTopicChannel,
  getWsUrlForWsKey,
  isWsPong,
  PRIVATE_WS_KEYS,
  PUBLIC_WS_KEYS,
  safeTerminateWs,
  WS_EVENT_CODE_ENUM,
  WS_KEY_MAP,
  WS_LOGGER_CATEGORY,
  WsKey,
} from './util/websocket-util.js';
import WsStore from './util/WsStore.js';
import { WsConnectionStateEnum } from './util/WsStore.types.js';
⋮----
// Type safety for on and emit handlers: https://stackoverflow.com/a/61609010/880837
export declare interface WebsocketClientLegacy {
  on<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(
    event: U,
    listener: WSClientEventMap<WsKey>[U],
  ): this;

  emit<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(
    event: U,
    ...args: Parameters<WSClientEventMap<WsKey>[U]>
  ): boolean;
}
⋮----
on<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(
    event: U,
    listener: WSClientEventMap<WsKey>[U],
  ): this;
⋮----
emit<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(
    event: U,
    ...args: Parameters<WSClientEventMap<WsKey>[U]>
  ): boolean;
⋮----
/**
 * @deprecated This is the old WebsocketClient that was part of the SDK prior to the V3 release. This legacy WebsocketClient is temporarily included but will be removed with the next major release.
 */
export class WebsocketClientLegacy extends EventEmitter
⋮----
constructor(options: WSClientConfigurableOptions, logger?: DefaultLogger)
⋮----
// Automatically send an authentication op/request after a connection opens, for private connections.
⋮----
// Individual requests do not require a signature, so this is disabled.
⋮----
/**
   * Subscribe to topics & track/persist them. They will be automatically resubscribed to if the connection drops/reconnects.
   * @param wsEvents topic or list of topics
   * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
   */
public subscribe(
    wsEvents: WsChannelSubUnSubRequestArg[] | WsChannelSubUnSubRequestArg,
    isPrivateTopic?: boolean,
)
⋮----
// Persist topic for reconnects
⋮----
// if connected, send subscription request
⋮----
// start connection process if it hasn't yet begun. Topics are automatically subscribed to on-connect
⋮----
/**
   * Unsubscribe from topics & remove them from memory. They won't be re-subscribed to if the connection reconnects.
   * @param wsTopics topic or list of topics
   * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
   */
public unsubscribe(
    wsTopics: WsChannelSubUnSubRequestArg[] | WsChannelSubUnSubRequestArg,
    isPrivateTopic?: boolean,
)
⋮----
// Remove topic from persistence for reconnects
⋮----
// unsubscribe request only necessary if active connection exists
⋮----
/** Get the WsStore that tracks websocket & topic state */
public getWsStore(): WsStore<WsKey, WsChannelSubUnSubRequestArg>
⋮----
public close(wsKey: WsKey, force?: boolean)
⋮----
public closeAll(force?: boolean)
⋮----
/**
   * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
   */
public connectAll(): Promise<WebSocket | undefined>[]
⋮----
public connectPublic(
    businessEndpoint?: boolean,
): Promise<WebSocket | undefined>
⋮----
public connectPrivate(
    businessEndpoint?: boolean,
): Promise<WebSocket | undefined>
⋮----
private async connect(wsKey: WsKey): Promise<WebSocket | undefined>
⋮----
private parseWsError(context: string, error: any, wsKey: WsKey)
⋮----
/**
   * Return params required to make authorized request
   */
private async getWsAuthRequest(
    wsKey: WsKey,
): Promise<Omit<WsAuthRequest, 'id'> | undefined>
⋮----
// Filter out failed accounts
⋮----
private async getWsAuthSignature(
    wsKey: WsKey,
    credentials: APICredentials,
): Promise<
⋮----
// const signatureExpiresAt = timestamp + 5;
⋮----
private async sendAuthRequest(wsKey: WsKey): Promise<void>
⋮----
private reconnectWithDelay(wsKey: WsKey, connectionDelayMs: number)
⋮----
private ping(wsKey: WsKey)
⋮----
/**
   * Closes a connection, if it's even open. If open, this will trigger a reconnect asynchronously.
   * If closed, trigger a reconnect immediately.
   */
private executeReconnectableClose(wsKey: WsKey, reason: string)
⋮----
private clearTimers(wsKey: WsKey)
⋮----
// Send a ping at intervals
private clearPingTimer(wsKey: WsKey)
⋮----
// Expect a pong within a time limit
private clearPongTimer(wsKey: WsKey)
⋮----
private clearReconnectTimer(wsKey: WsKey)
⋮----
/**
   * @private Use the `subscribe(topics)` method to subscribe to topics. Send WS message to subscribe to topics.
   */
private requestSubscribeTopics(
    wsKey: WsKey,
    topics: WsChannelSubUnSubRequestArg[],
)
⋮----
/**
   * @private Use the `unsubscribe(topics)` method to unsubscribe from topics. Send WS message to unsubscribe from topics.
   */
private requestUnsubscribeTopics(
    wsKey: WsKey,
    topics: WsChannelSubUnSubRequestArg[],
)
⋮----
public tryWsSend(wsKey: WsKey, wsMessage: string): void
⋮----
private connectToWsUrl(url: string, wsKey: WsKey): WebSocket
⋮----
private async onWsOpen(
    event: WebSocket.Event,
    wsKey: WsKey,
    url: string,
    ws: WebSocket,
)
⋮----
// Private websockets require an auth packet to be sent after opening the connection
⋮----
// Any requested private topics will be subscribed to once authentication succeeds (in onWsMessage handler)
⋮----
// Private topics will be subscribed to once authentication is confirmed as successful
⋮----
// Public topics can be subscribed to immediately
⋮----
// Since public channels have their own ws key, these topics must be public ones already
⋮----
private onWsMessage(event: any, wsKey: WsKey, _ws: WebSocket)
⋮----
// any message can clear the pong timer - wouldn't get a message if the ws dropped
⋮----
// Successfully authenticated
⋮----
// Since private topics have a dedicated WsKey, these are automatically all private topics (no filtering required before the subscribe call)
⋮----
// this.logger.trace(`Ws subscribe reply:`, { ...msg, wsKey });
⋮----
private onWsClose(event: any, wsKey: WsKey)

================
File: webpack/webpack.config.cjs
================
function generateConfig(name)
⋮----
// Add '.ts' and '.tsx' as resolvable extensions.
⋮----
// Node.js core modules not available in browsers
// The REST client's https.Agent (for keepAlive) is Node.js-only and won't work in browsers
⋮----
// Code is already transpiled from TypeScript, no additional loaders needed

================
File: examples/Rest/rest-private-trade.ts
================
/* eslint-disable @typescript-eslint/no-unused-vars */
import { RestClient } from '../../src/index.js';
import { OrderRequest } from '../../src/types/rest/request/trade.js';
⋮----
// or
// import { SpotClient } from 'okx-api';
⋮----
// read from environmental variables
⋮----
// If running from CLI in unix, you can pass env vars as such:
// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/rest-private-trade.ts
⋮----
// note the single quotes, preventing special characters such as $ from being incorrectly passed
⋮----
// apiKey: 'apiKeyHere',
⋮----
// apiSecret: 'apiSecretHere',
⋮----
// apiPass: 'apiPassHere',
⋮----
// const wsClient = new WebsocketClient({
//   apiKey: API_KEY,
//   apiSecret: API_SECRET,
//   apiPass: API_PASS,
// });
⋮----
function logWSEvent(type: string, data: any)
⋮----
// simple sleep function
function promiseSleep(milliseconds: number)
⋮----
// WARNING: for sensitive math you should be using a library such as decimal.js!
function roundDown(value: any, decimals: number)
⋮----
/** This is a simple script wrapped in a immediately invoked function expression, designed to check for any available BTC balance and immediately sell the full amount for USDT */
⋮----
// // Add event listeners to log websocket events on account
// wsClient.on('update', (data) => logWSEvent('update', data));
// wsClient.on('open', (data) => logWSEvent('open', data));
// wsClient.on('response', (data) => logWSEvent('response', data));
// wsClient.on('reconnect', (data) => logWSEvent('reconnect', data));
// wsClient.on('reconnected', (data) => logWSEvent('reconnected', data));
// wsClient.on('authenticated', (data) => logWSEvent('authenticated', data));
// wsClient.on('exception', (data) => logWSEvent('exception', data));
⋮----
// // Subscribe to private account topics
// wsClient.subscribeTopic('SPBL', 'account');
// wsClient.subscribeTopic('SPBL', 'orders');
⋮----
// wait briefly for ws to be ready (could also use the response or authenticated events, to make sure topics are subscribed to before starting)
⋮----
// const balances = allBalances.filter((bal) => Number(bal.available) != 0);
⋮----
// console.log('balance: ', JSON.stringify(balances, null, 2));
⋮----
// example to find minimum allowed size for a symbol and place an order with it
/*  const symbol = 'BTC-USDT-SWAP';

    const symbolsResult = await client.getInstruments({
      instType: 'SWAP',
    });
    const btcRules = symbolsResult.find((rule) => rule.instId === symbol);
    console.log('btc trading rules: ', btcRules);
    if (!btcRules) {
      return console.log('no rules found for trading ' + symbol);
    }

    const minSize = Number(btcRules.minSz);

    const order = {
      instId: symbol,
      tdMode: 'cross',
      ordType: 'market',
      side: 'sell',
      sz: String(minSize),
    } as const;

    console.log('submitting order: ', order);

    const sellResult = await client.submitOrder(order);

    console.log('sell result: ', sellResult); */

================
File: examples/Websocket/WS-API/ws-api-client.ts
================
import { DefaultLogger, WebsocketAPIClient } from '../../../src/index.js';
⋮----
// or use the module installed via `npm install okx-api`:
// import { WebsocketClient, DefaultLogger } from 'okx-api';
⋮----
// or if you're not using typescript (e.g. pure nodejs), change the "import" to "require":
// const { WebsocketClient, DefaultLogger } = require('okx-api');
⋮----
// function attachEventHandlers<TWSClient extends WebsocketClient>(
//   wsClient: TWSClient,
// ): void {
//   wsClient.on('update', (data) => {
//     console.log('raw message received ', JSON.stringify(data));
//   });
//   wsClient.on('open', (data) => {
//     console.log('ws connected', data.wsKey);
//   });
//   wsClient.on('reconnect', ({ wsKey }) => {
//     console.log('ws automatically reconnecting.... ', wsKey);
//   });
//   wsClient.on('reconnected', (data) => {
//     console.log('ws has reconnected ', data?.wsKey);
//   });
//   wsClient.on('authenticated', (data) => {
//     console.log('ws has authenticated ', data?.wsKey);
//   });
// }
⋮----
// For private events, all 3 of the following are required (per account):
⋮----
// If running from CLI in unix, you can pass env vars as such:
// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/ws-private.ts
⋮----
// For Global users (www.okx.com), you don't need to set the market.
// It will use global by default.
// Not needed: market: 'GLOBAL',
⋮----
// For EEA users (my.okx.com), set market to "EEA":
// market: 'EEA',
⋮----
// For US users (app.okx.com), set market to "US":
// market: 'US',
⋮----
// For private topics, include one or more accounts in an array. Otherwise only public topics will work
⋮----
// Optional, see above "attachEventListeners". Attach basic event handlers, so nothing is left unhandled
// attachEventHandlers(wsClient.getWSClient());
⋮----
// Optional: prepare the WebSocket API connection in advance.
// This happens automatically but you can do this early before making any API calls, to prevent delays from a cold start.
// await wsClient.connectWSAPI();
⋮----
/**
   * OKX's WebSocket API be used like a REST API, through this SDK's WebsocketAPIClient. The WebsocketAPIClient is a utility class wrapped around WebsocketClient's sendWSAPIRequest() capabilities.
   *
   * Each request sent via the WebsocketAPIClient will automatically:
   * - route via the active WS API connection
   * - return a Promise, which automatically resolves/rejects when a matching response is received
   */
⋮----
/**
   * Place Order
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
   */
⋮----
/**
      const res = {
        id: '2',
        op: 'order',
        code: '1',
        msg: '',
        data: [
          {
            tag: '159881cb7207BCDE',
            ts: '1753714603721',
            ordId: '',
            clOrdId: '',
            sCode: '51008',
            sMsg: 'Order failed. Insufficient USDT balance in account.'
          }
        ],
        inTime: '1753714603720755',
        outTime: '1753714603721942',
        wsKey: 'prodPrivate',
        isWSAPIResponse: false
      }

      const res =  {
        id: '2',
        op: 'order',
        code: '1',
        msg: '',
        data: [
          {
            tag: '159881cb7207BCDE',
            ts: '1753714567149',
            ordId: '',
            clOrdId: '',
            sCode: '51010',
            sMsg: "You can't complete this request under your current account mode."
          }
        ],
        inTime: '1753714567149196',
        outTime: '1753714567149913',
        wsKey: 'prodPrivate',
        isWSAPIResponse: false
      }
     */
⋮----
/**
   * Submit multiple orders in a batch
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
   */

================
File: examples/Websocket/WS-API/ws-api-trade-raw.ts
================
// If you cloned the repo and are using typescript, you can import from src directly:
import {
  DefaultLogger,
  WebsocketClient,
  WS_KEY_MAP,
} from '../../../src/index.js';
⋮----
// or use the module installed via `npm install okx-api`:
// import { WebsocketClient, DefaultLogger } from 'okx-api';
⋮----
// or if you're not using typescript (e.g. pure nodejs), change the "import" to "require":
// const { WebsocketClient, DefaultLogger } = require('okx-api');
⋮----
// For private events, all 3 of the following are required (per account):
⋮----
// If running from CLI in unix, you can pass env vars as such:
// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/ws-private.ts
⋮----
// For private topics, include one or more accounts in an array. Otherwise only public topics will work
⋮----
// console.log('WS raw message received ', JSON.stringify(data, null, 2));
⋮----
// prodPrivate is for the www.okx.com /ws/v5/private channel
⋮----
// prodBusiness is for the www.okx.com /ws/v5/business channel
// const OKX_GLOBAL_BUSINESS_CHANNEL = WS_KEY_MAP.prodBusiness;
⋮----
/**
   * OKX's WebSocket API can be used via the sendWSAPIRequest() method.
   *
   * The correct WS Key depends on where you registered (www.okx.com vs app.okx.com vs my.okx.com), and whether you are using book trading (uses private connection) or spread trading (uses business connection) functionality.
   *
   * Note: for a better user experience, it is recommended to use the WebsocketAPIClient.
   */
⋮----
/**
   * Place Order
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
   */
⋮----
/**
      const res = {
        id: '2',
        op: 'order',
        code: '1',
        msg: '',
        data: [
          {
            tag: '159881cb7207BCDE',
            ts: '1753714603721',
            ordId: '',
            clOrdId: '',
            sCode: '51008',
            sMsg: 'Order failed. Insufficient USDT balance in account.'
          }
        ],
        inTime: '1753714603720755',
        outTime: '1753714603721942',
        wsKey: 'prodPrivate',
        isWSAPIResponse: false
      }

      const res =  {
        id: '2',
        op: 'order',
        code: '1',
        msg: '',
        data: [
          {
            tag: '159881cb7207BCDE',
            ts: '1753714567149',
            ordId: '',
            clOrdId: '',
            sCode: '51010',
            sMsg: "You can't complete this request under your current account mode."
          }
        ],
        inTime: '1753714567149196',
        outTime: '1753714567149913',
        wsKey: 'prodPrivate',
        isWSAPIResponse: false
      }

     */
⋮----
/**
   * Cancel Order
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
   */
⋮----
/**
      const res = {
        id: '2',
        op: 'cancel-order',
        code: '1',
        msg: '',
        data: [
          {
            ts: '1753714393003',
            ordId: '2510789768709120',
            clOrdId: '',
            sCode: '51400',
            sMsg: 'Order cancellation failed as the order has been filled, canceled or does not exist.'
          }
        ],
        inTime: '1753714393003190',
        outTime: '1753714393004074',
        wsKey: 'prodPrivate',
        isWSAPIResponse: false
      }
     */

================
File: src/types/rest/response/private-funding.ts
================
import { ASSET_BILL_TYPE } from '../../../constants/funding.js';
⋮----
export interface FundingCurrency {
  ccy: string; // Currency code (e.g., "BTC")
  name: string; // Currency name
  logoLink: string; // Currency logo URL
  chain: string; // Chain name (e.g., "BTC-Bitcoin")
  ctAddr: string; // Contract address
  canDep: boolean; // Deposit availability
  canWd: boolean; // Withdrawal availability
  canInternal: boolean; // Internal transfer availability
  depEstOpenTime: string; // Estimated deposit opening time (timestamp)
  wdEstOpenTime: string; // Estimated withdrawal opening time (timestamp)
  minDep: string; // Minimum deposit amount
  minWd: string; // Minimum withdrawal amount
  minInternal: string; // Minimum internal transfer amount
  maxWd: string; // Maximum withdrawal amount per transaction
  wdTickSz: string; // Withdrawal precision (decimal places)
  wdQuota: string; // 24h withdrawal limit in USD
  usedWdQuota: string; // Used withdrawal quota in USD
  fee: string; // Fixed withdrawal fee
  minFee: string; // Minimum withdrawal fee (deprecated)
  maxFee: string; // Maximum withdrawal fee (deprecated)
  minFeeForCtAddr: string; // Minimum contract address withdrawal fee (deprecated)
  maxFeeForCtAddr: string; // Maximum contract address withdrawal fee (deprecated)
  burningFeeRate: string; // Burning fee rate (e.g., "0.05" for 5%)
  mainNet: boolean; // Is main network
  needTag: boolean; // Requires tag/memo for withdrawal
  minDepArrivalConfirm: string; // Min confirmations for deposit credit
  minWdUnlockConfirm: string; // Min confirmations for withdrawal unlock
  depQuotaFixed: string; // Fixed deposit limit in USD
  usedDepQuotaFixed: string; // Used fixed deposit quota in USD
  depQuoteDailyLayer2: string; // Layer2 daily deposit limit
}
⋮----
ccy: string; // Currency code (e.g., "BTC")
name: string; // Currency name
logoLink: string; // Currency logo URL
chain: string; // Chain name (e.g., "BTC-Bitcoin")
ctAddr: string; // Contract address
canDep: boolean; // Deposit availability
canWd: boolean; // Withdrawal availability
canInternal: boolean; // Internal transfer availability
depEstOpenTime: string; // Estimated deposit opening time (timestamp)
wdEstOpenTime: string; // Estimated withdrawal opening time (timestamp)
minDep: string; // Minimum deposit amount
minWd: string; // Minimum withdrawal amount
minInternal: string; // Minimum internal transfer amount
maxWd: string; // Maximum withdrawal amount per transaction
wdTickSz: string; // Withdrawal precision (decimal places)
wdQuota: string; // 24h withdrawal limit in USD
usedWdQuota: string; // Used withdrawal quota in USD
fee: string; // Fixed withdrawal fee
minFee: string; // Minimum withdrawal fee (deprecated)
maxFee: string; // Maximum withdrawal fee (deprecated)
minFeeForCtAddr: string; // Minimum contract address withdrawal fee (deprecated)
maxFeeForCtAddr: string; // Maximum contract address withdrawal fee (deprecated)
burningFeeRate: string; // Burning fee rate (e.g., "0.05" for 5%)
mainNet: boolean; // Is main network
needTag: boolean; // Requires tag/memo for withdrawal
minDepArrivalConfirm: string; // Min confirmations for deposit credit
minWdUnlockConfirm: string; // Min confirmations for withdrawal unlock
depQuotaFixed: string; // Fixed deposit limit in USD
usedDepQuotaFixed: string; // Used fixed deposit quota in USD
depQuoteDailyLayer2: string; // Layer2 daily deposit limit
⋮----
export interface FundingBalance {
  availBal: string;
  bal: string;
  ccy: string;
  frozenBal: string;
}
⋮----
export interface AccountAssetValuation {
  details: {
    classic: string;
    earn: string;
    funding: string;
    trading: string;
  };
  totalBal: string;
  ts: string;
}
⋮----
export interface FundTransferResult {
  transId: string;
  ccy: string;
  clientId: string;
  from: string;
  amt: string;
  to: string;
}
export interface FundTransferState {
  amt: string;
  ccy: string;
  clientId: string;
  from: string;
  instId: never; // deprecated
  state: string;
  subAcct: string;
  to: string;
  toInstId: never; // deprecated
  transId: string;
  type: string;
}
⋮----
instId: never; // deprecated
⋮----
toInstId: never; // deprecated
⋮----
export interface AssetBillDetails {
  billId: string;
  ccy: string;
  clientId: string;
  balChg: string;
  bal: string;
  type: `${ASSET_BILL_TYPE}`;
  notes: string;
  ts: string;
}
⋮----
export interface WithdrawResponse {
  ccy: string;
  chain: string;
  amt: string;
  wdId: string;
  clientId: string;
}
⋮----
export interface NonTradableAsset {
  ccy: string;
  name: string;
  logoLink: string;
  bal: string;
  canWd: boolean;
  chain: string;
  minWd: string;
  wdAll: boolean;
  fee: string;
  ctAddr: string;
  wdTickSz: string;
  needTag: boolean;
  burningFeeRate: string;
  feeCcy: string;
}
⋮----
export interface DepositHistory {
  ccy: string; // Currency, e.g. BTC
  chain: string; // Chain name
  amt: string; // Deposit amount
  from: string; // Deposit account. If the deposit comes from internal transfer, displays account info (phone/email, masked). Returns "" otherwise.
  areaCodeFrom: string; // If from is a phone number, this parameter returns area code of the phone number
  to: string; // Deposit address. If the deposit comes from on-chain, displays the on-chain address. Returns "" otherwise.
  txId: string; // Hash record of the deposit
  ts: string; // Timestamp that the deposit record is created, Unix timestamp format in milliseconds, e.g. 1655251200000
  state: string; // Status of deposit: 0=waiting for confirmation, 1=deposit credited, 2=deposit successful, 8=pending due to temp suspension, 11=match blacklist, 12=account/deposit frozen, 13=sub-account deposit interception, 14=KYC limit
  depId: string; // Deposit ID
  fromWdId: string; // Internal transfer initiator's withdrawal ID. If deposit comes from internal transfer, displays the withdrawal ID, returns "" otherwise
  actualDepBlkConfirm: string; // The actual amount of blockchain confirmed in a single deposit
}
⋮----
ccy: string; // Currency, e.g. BTC
chain: string; // Chain name
amt: string; // Deposit amount
from: string; // Deposit account. If the deposit comes from internal transfer, displays account info (phone/email, masked). Returns "" otherwise.
areaCodeFrom: string; // If from is a phone number, this parameter returns area code of the phone number
to: string; // Deposit address. If the deposit comes from on-chain, displays the on-chain address. Returns "" otherwise.
txId: string; // Hash record of the deposit
ts: string; // Timestamp that the deposit record is created, Unix timestamp format in milliseconds, e.g. 1655251200000
state: string; // Status of deposit: 0=waiting for confirmation, 1=deposit credited, 2=deposit successful, 8=pending due to temp suspension, 11=match blacklist, 12=account/deposit frozen, 13=sub-account deposit interception, 14=KYC limit
depId: string; // Deposit ID
fromWdId: string; // Internal transfer initiator's withdrawal ID. If deposit comes from internal transfer, displays the withdrawal ID, returns "" otherwise
actualDepBlkConfirm: string; // The actual amount of blockchain confirmed in a single deposit

================
File: src/types/rest/client.ts
================
import { APIMarket } from '../shared.js';
⋮----
export interface RestClientOptions {
  apiKey?: string;
  apiSecret?: string;
  apiPass?: string;

  /**
   * The API group this client should connect to:
   * - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services
   * - market: 'OPENAPI_GLOBAL' // OKX Global REST at https://openapi.okx.com
   * - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
   * - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
   */
  market?: APIMarket;

  /**
   * Set to `true` to use OKX's demo trading functionality
   */
  demoTrading?: boolean;

  // Default: false. If true, we'll throw errors if any params are undefined
  strict_param_validation?: boolean;

  // Optionally override REST API base URL (e.g. 'https://www.okx.com' or 'https://openapi.okx.com').
  // Note: to use my.okx or app.okx or eea.okx or us.okx, use the "market" parameter
  // e.g 'https://eea.okx.com'
  baseUrl?: string;

  // Default: true. whether to try and post-process request exceptions.
  parse_exceptions?: boolean;

  /**
   * Enable keep alive for REST API requests (via axios).
   */
  keepAlive?: boolean;

  /**
   * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000.
   * Only relevant if keepAlive is set to true.
   * Default: 1000 (defaults comes from https agent)
   */
  keepAliveMsecs?: number;

  /**
   * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
   *
   * Look in the examples folder for a demonstration on using node's createHmac instead.
   */
  customSignMessageFn?: (message: string, secret: string) => Promise<string>;
}
⋮----
/**
   * The API group this client should connect to:
   * - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services
   * - market: 'OPENAPI_GLOBAL' // OKX Global REST at https://openapi.okx.com
   * - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
   * - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
   */
⋮----
/**
   * Set to `true` to use OKX's demo trading functionality
   */
⋮----
// Default: false. If true, we'll throw errors if any params are undefined
⋮----
// Optionally override REST API base URL (e.g. 'https://www.okx.com' or 'https://openapi.okx.com').
// Note: to use my.okx or app.okx or eea.okx or us.okx, use the "market" parameter
// e.g 'https://eea.okx.com'
⋮----
// Default: true. whether to try and post-process request exceptions.
⋮----
/**
   * Enable keep alive for REST API requests (via axios).
   */
⋮----
/**
   * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000.
   * Only relevant if keepAlive is set to true.
   * Default: 1000 (defaults comes from https agent)
   */
⋮----
/**
   * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
   *
   * Look in the examples folder for a demonstration on using node's createHmac instead.
   */

================
File: src/types/rest/shared.ts
================
export type numberInString<T = string> = T;
⋮----
export interface APIResponse<T> {
  code: '0';
  msg: '';
  data: T;
}
⋮----
export type AlgoOrderType =
  | 'conditional'
  | 'oco'
  | 'trigger'
  | 'move_order_stop'
  | 'iceberg'
  | 'twap'
  | 'chase';
⋮----
export type AlgoOrderState =
  | 'live'
  | 'pause'
  | 'partially_effective'
  | 'effective'
  | 'canceled'
  | 'order_failed'
  | 'partially_failed';
⋮----
export type AlgoPositionSide = 'long' | 'short';
⋮----
export type ContractGridDirection = 'long' | 'short' | 'neutral';
⋮----
export type GridAlgoSubOrderType = 'live' | 'filled';
⋮----
export type InstrumentType =
  | 'SPOT'
  | 'MARGIN'
  | 'SWAP'
  | 'FUTURES'
  | 'OPTION'
  | 'EVENTS';
⋮----
export type MarginMode = 'cross' | 'isolated';
⋮----
export type OrderSide = 'buy' | 'sell';
⋮----
export type OrderType =
  | 'market'
  | 'limit'
  | 'post_only'
  | 'fok'
  | 'ioc'
  | 'optimal_limit_ioc'
  | 'mmp'
  | 'mmp_and_post_only'
  | 'elp';
⋮----
export type OrderState =
  | 'canceled'
  | 'live'
  | 'partially_filled'
  | 'filled'
  | 'mmp_canceled';
⋮----
export type PositionSide = 'net' | 'long' | 'short';
⋮----
export type PriceTriggerType = 'last' | 'index' | 'mark';
⋮----
export interface RFQLeg {
  instId: string;
  sz: string;
  side: OrderSide;
  tgtCcy?: string;
}
⋮----
export interface RFQQuoteLegExtended {
  px: string;
  sz: string;
  instId: string;
  side: string;
  fee: string;
  feeCcy: string;
  tradeId: string;
}
⋮----
export type TradeMode = 'cross' | 'isolated' | 'cash' | 'spot_isolated';
⋮----
export interface TimestampObject {
  ts: numberInString;
}
⋮----
export interface Pagination {
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export type PosMode = 'long_short_mode' | 'net_mode';
⋮----
export type AccountLevel = '1' | '2' | '3' | '4';
⋮----
export type WithdrawState =
  | '-3'
  | '-2'
  | '-1'
  | '0'
  | '1'
  | '2'
  | '4'
  | '5'
  | '6'
  | '8'
  | '9'
  | '10'
  | '12';

================
File: src/types/shared.ts
================
export interface APICredentials {
  apiKey: string;
  apiSecret: string;
  apiPass: string;
}
⋮----
/**
 * The API Market represents the OKX Domain that you have signed up for. At this time, there are 4 supported domain groups:
 *
 * - GLOBAL, otherwise known as "www.okx.com".
 * - OPENAPI_GLOBAL, OKX Global REST at openapi.okx.com (same WS as GLOBAL).
 * - EEA, otherwise known as "my.okx.com".
 * - US, otherwise known as "app.okx.com".
 */
export type APIMarket =
  | 'prod' // same as GLOBAL. Kept for some backwards compatibility
  // also known as "www.okx.com" or OKX Global: https://www.okx.com/docs-v5/en/#overview-production-trading-services
  | 'GLOBAL'
  // OKX Global REST at https://openapi.okx.com. WebSocket URLs unchanged (same as GLOBAL).
  | 'OPENAPI_GLOBAL'
  // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
  | 'EEA'
  // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
  | 'US';
⋮----
| 'prod' // same as GLOBAL. Kept for some backwards compatibility
// also known as "www.okx.com" or OKX Global: https://www.okx.com/docs-v5/en/#overview-production-trading-services
⋮----
// OKX Global REST at https://openapi.okx.com. WebSocket URLs unchanged (same as GLOBAL).
⋮----
// also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
⋮----
// also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services

================
File: src/index.ts
================
// Top level REST types
⋮----
// REST/request
⋮----
// REST/response
⋮----
//

================
File: src/websocket-api-client.ts
================
import { OrderIdRequest } from './types/rest/request/trade.js';
import { OrderResult } from './types/rest/response/private-trade.js';
import { WSAPIResponse } from './types/websockets/ws-api.js';
import {
  WSAPIAmendOrderRequestV5,
  WSAPIAmendSpreadOrderRequestV5,
  WSAPICancelSpreadOrderRequestV5,
  WSAPIMassCancelOrdersRequestV5,
  WSAPIPlaceOrderRequestV5,
  WSAPIPlaceSpreadOrderRequestV5,
  WSAPISpreadMassCancelOrdersRequestV5,
} from './types/websockets/ws-api-request.js';
import {
  WSAPICancelOrderResultV5,
  WSAPISpreadAmendOrderResultV5,
  WSAPISpreadCancelOrderResultV5,
  WSAPISpreadPlaceOrderResultV5,
} from './types/websockets/ws-api-response.js';
import { WSClientConfigurableOptions } from './types/websockets/ws-general.js';
import { DefaultLogger } from './util/logger.js';
import { WebsocketClient } from './websocket-client.js';
⋮----
/**
 * Configurable options specific to only the REST-like WebsocketAPIClient
 */
export interface WSAPIClientConfigurableOptions {
  /**
   * Default: true
   *
   * Attach default event listeners, which will console log any high level
   * events (opened/reconnecting/reconnected/etc).
   *
   * If you disable this, you should set your own event listeners
   * on the embedded WS Client `wsApiClient.getWSClient().on(....)`.
   */
  attachEventListeners: boolean;
}
⋮----
/**
   * Default: true
   *
   * Attach default event listeners, which will console log any high level
   * events (opened/reconnecting/reconnected/etc).
   *
   * If you disable this, you should set your own event listeners
   * on the embedded WS Client `wsApiClient.getWSClient().on(....)`.
   */
⋮----
/**
 * This is a minimal Websocket API wrapper around the WebsocketClient. It allows you to use the WebSocket API in a promise-driven way, send a request and await the response.
 *
 * Note: You can also directly use the sendWSAPIRequest() method to make WS API calls, but some
 * may find the below methods slightly more intuitive.
 *
 * Refer to the WS API promises example for a more detailed example on using sendWSAPIRequest() directly:
 * https://github.com/tiagosiebler/okx-api/blob/master/examples/ws-api-trade-raw.ts
 */
export class WebsocketAPIClient
⋮----
constructor(
    options?: WSClientConfigurableOptions &
      Partial<WSAPIClientConfigurableOptions>,
    logger?: DefaultLogger,
)
⋮----
public getWSClient(): WebsocketClient
⋮----
public setTimeOffsetMs(newOffset: number): void
⋮----
/**
   *
   *
   * OKX WebSocket API Methods
   *
   *
   */
⋮----
/**
   * Submit a new order
   *
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
   */
submitNewOrder(
    params: WSAPIPlaceOrderRequestV5,
): Promise<WSAPIResponse<[OrderResult], 'order'>>
⋮----
/**
   * Submit multiple orders in a batch
   *
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
   */
submitMultipleOrders(
    params: WSAPIPlaceOrderRequestV5[],
): Promise<WSAPIResponse<OrderResult[], 'batch-orders'>>
⋮----
/**
   * Cancel a single order
   *
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order
   */
cancelOrder(
    params: OrderIdRequest,
): Promise<WSAPIResponse<[WSAPICancelOrderResultV5], 'cancel-order'>>
⋮----
/**
   * Cancel multiple orders
   *
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-multiple-orders
   */
cancelMultipleOrders(
    params: OrderIdRequest[],
): Promise<WSAPIResponse<WSAPICancelOrderResultV5[], 'batch-cancel-orders'>>
⋮----
/**
   * Amend a single order
   *
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order
   */
amendOrder(
    params: WSAPIAmendOrderRequestV5,
): Promise<WSAPIResponse<[OrderResult], 'amend-order'>>
⋮----
/**
   * Amend multiple orders
   *
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-multiple-orders
   */
amendMultipleOrders(
    params: WSAPIAmendOrderRequestV5[],
): Promise<WSAPIResponse<[OrderResult], 'batch-amend-orders'>>
⋮----
/**
   * Mass cancel orders
   *
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-mass-cancel-order
   */
massCancelOrders(
    params: WSAPIMassCancelOrdersRequestV5,
): Promise<WSAPIResponse<[
⋮----
/**
   * Submit a new spread order
   *
   * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-place-order
   */
submitSpreadOrder(
    params: WSAPIPlaceSpreadOrderRequestV5,
): Promise<WSAPIResponse<[WSAPISpreadPlaceOrderResultV5], 'sprd-order'>>
⋮----
/**
   * Amend a spread order
   *
   * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-amend-order
   */
amendSpreadOrder(
    params: WSAPIAmendSpreadOrderRequestV5,
  ): Promise<
    WSAPIResponse<[WSAPISpreadAmendOrderResultV5], 'sprd-amend-order'>
  > {
    return this.wsClient.sendWSAPIRequest(
      this.getWSClient().getMarketWsKey('business'),
      'sprd-amend-order',
      params,
    );
⋮----
/**
   * Cancel a spread order
   *
   * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-order
   */
cancelSpreadOrder(
    params: WSAPICancelSpreadOrderRequestV5,
  ): Promise<
    WSAPIResponse<[WSAPISpreadCancelOrderResultV5], 'sprd-cancel-order'>
  > {
    return this.wsClient.sendWSAPIRequest(
      this.getWSClient().getMarketWsKey('business'),
      'sprd-cancel-order',
      params,
    );
⋮----
/**
   * Mass cancel spread orders
   *
   * https://www.okx.com/docs-v5/en/#spread-trading-websocket-trade-api-ws-cancel-all-orders
   */
massCancelSpreadOrders(
    params: WSAPISpreadMassCancelOrdersRequestV5,
): Promise<WSAPIResponse<[
⋮----
/**
   *
   *
   *
   *
   *
   *
   *
   * Private methods for handling some of the convenience/automation provided by the WS API Client
   *
   *
   *
   *
   *
   *
   *
   */
⋮----
public connectWSAPI()
⋮----
private setupDefaultEventListeners()
⋮----
/**
       * General event handlers for monitoring the WebsocketClient
       */
⋮----
// Blind JSON.stringify can fail on circular references
⋮----
// JSON.stringify({ ...data, target: 'WebSocket' }),

================
File: .gitignore
================
!.gitkeep
.DS_STORE
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
pids
*.pid
*.seed
*.pid.lock
node_modules/
.npm
.eslintcache
.node_repl_history
*.tgz
.yarn-integrity
.env
.env.test
.cache
lib
dist
bundleReport.html
.history/
.idea
privaterepotracker
restClientRegex.ts
testfile.ts
localtest.sh
coverage/

repomix.sh

================
File: src/types/rest/request/account.ts
================
import {
  InstrumentType,
  MarginMode,
  PositionSide,
  WithdrawState,
} from '../shared.js';
⋮----
export interface SetLeverageRequest {
  instId?: string;
  ccy?: string;
  lever: string;
  mgnMode: MarginMode;
  posSide?: 'long' | 'short';
}
⋮----
export interface ChangePositionMarginRequest {
  instId: string;
  posSide: PositionSide;
  type: 'add' | 'reduce';
  amt: string;
  ccy?: string;
  auto?: boolean;
  loanTrans?: boolean;
}
⋮----
export interface GetPositionsParams {
  instType?: InstrumentType;
  instId?: string;
  posId?: string;
}
⋮----
export interface GetHistoricPositionParams {
  instType?: InstrumentType;
  instId?: string;
  mgnMode?: string;
  type?: string;
  posId?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface WithdrawalHistoryRequest {
  ccy?: string;
  wdId?: string;
  clientId?: string;
  txId?: string;
  type?: '3' | '4';
  state?: WithdrawState;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GetInstrumentsRequest {
  instType: 'SPOT' | 'MARGIN' | 'SWAP' | 'FUTURES' | 'OPTION' | 'EVENTS';
  /** Required when `instType` is EVENTS, e.g. BTC-ABOVE-DAILY. */
  seriesId?: string;
  uly?: string;
  instFamily?: string;
  instId?: string;
}
⋮----
/** Required when `instType` is EVENTS, e.g. BTC-ABOVE-DAILY. */
⋮----
export interface QuickMarginBorrowRepayRequest {
  instId: string;
  ccy: string;
  side: 'borrow' | 'repay';
  amt: string;
  posSide?: 'long' | 'short';
}
⋮----
export interface GetQuickMarginBorrowRepayHistoryRequest {
  instId?: string;
  ccy?: string;
  side?: 'borrow' | 'repay';
  after?: string;
  before?: string;
  begin?: string;
  end?: string;
  limit?: string;
}
⋮----
export interface GetVIPInterestRequest {
  ccy?: string;
  ordId?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GetVIPLoanOrderListRequest {
  ordId?: string;
  state?: '1' | '2' | '3' | '4' | '5';
  ccy?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GetVIPLoanOrderDetailRequest {
  ordId: string;
  ccy?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface GetFixedLoanBorrowQuoteRequest {
  type: 'normal' | 'reborrow';
  ccy?: string;
  amt?: string;
  maxRate?: string;
  term?: string;
  ordId?: string;
}
⋮----
export interface SubmitFixedLoanBorrowingOrderRequest {
  ccy: string;
  amt: string;
  maxRate: string;
  term: string;
  reborrow?: boolean;
  reborrowRate?: string;
}
⋮----
export interface UpdateFixedLoanBorrowingOrderRequest {
  ordId: string;
  reborrow?: boolean;
  renewMaxRate?: string;
}
⋮----
export interface GetFixedLoanBorrowingOrdersListRequest {
  ordId?: string;
  ccy?: string;
  state?: string;
  after?: string;
  before?: string;
  limit?: string;
  term?: string;
}
⋮----
export interface GetBorrowRepayHistoryRequest {
  ccy?: string;
  type?: 'auto_borrow' | 'auto_repay' | 'manual_borrow' | 'manual_repay';
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface PositionBuilderRequest {
  inclRealPosAndEq?: boolean;
  spotOffsetType?: '1' | '2' | '3';
  simPos?: {
    instId: string;
    pos: string;
  }[];
  simAsset?: {
    ccy: string;
    amt: string;
  }[];
  greeksType?: 'BS' | 'PA' | 'CASH';
}
⋮----
export interface SetMMPConfigRequest {
  instFamily: string;
  timeInterval: string;
  frozenInterval: string;
  qtyLimit: string;
}
⋮----
export interface SetSettleCurrencyRequest {
  settleCcy: string;
}
⋮----
export interface SetFeeTypeRequest {
  feeType: '0' | '1';
}
⋮----
export interface SetTradingConfigRequest {
  type: 'stgyType'; // Trading config type
  stgyType?: '0' | '1'; // Strategy type: 0=general strategy, 1=delta neutral strategy. Only applicable when type is stgyType
}
⋮----
type: 'stgyType'; // Trading config type
stgyType?: '0' | '1'; // Strategy type: 0=general strategy, 1=delta neutral strategy. Only applicable when type is stgyType
⋮----
export interface PrecheckSetDeltaNeutralRequest {
  stgyType: '0' | '1'; // Strategy type: 0=general strategy, 1=delta neutral strategy
}
⋮----
stgyType: '0' | '1'; // Strategy type: 0=general strategy, 1=delta neutral strategy
⋮----
export interface GetAccountBillSubtypesRequest {
  /** Comma-separated bill type ids, e.g. 1,2,3. If omitted, all types. */
  type?: string;
}
⋮----
/** Comma-separated bill type ids, e.g. 1,2,3. If omitted, all types. */
⋮----
export interface BillsHistoryArchiveRequest {
  year: string;
  quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
  /** Comma-separated bill type ids, e.g. 1,2,3. If omitted, all types. */
  type?: string;
}
⋮----
/** Comma-separated bill type ids, e.g. 1,2,3. If omitted, all types. */
⋮----
export interface MovePositionLegFrom {
  posId: string;
  side: 'buy' | 'sell';
  sz: string;
}
⋮----
export interface MovePositionLegTo {
  tdMode?: 'cross' | 'isolated';
  posSide?: PositionSide;
  ccy?: string;
}
⋮----
export interface MovePositionLeg {
  from: MovePositionLegFrom;
  to: MovePositionLegTo;
}
⋮----
/**
 * @see POST /api/v5/account/move-positions
 */
export interface MovePositionsRequest {
  fromAcct: string;
  toAcct: string;
  legs: MovePositionLeg[];
  clientId: string;
}
⋮----
/**
 * @see GET /api/v5/account/move-positions-history
 */
export interface GetMovePositionsHistoryRequest {
  blockTdId?: string;
  clientId?: string;
  beginTs?: string;
  endTs?: string;
  limit?: string;
  state?: 'filled' | 'pending';
}

================
File: src/types/rest/request/funding.ts
================
export interface FundsTransferRequest {
  ccy: string;
  amt: string;
  from: '6' | '18';
  to: '6' | '18';
  subAcct?: string;
  type?: '0' | '1' | '2' | '3' | '4';
  loanTrans?: boolean;
  clientId?: string;
  omitPosRisk?: string;
}
⋮----
export interface WithdrawRequest {
  ccy: string;
  amt: string;
  dest: '3' | '4';
  toAddr: string;
  /**
   * Address type:
   * - 1: wallet address, email, phone, or login account name
   * - 2: UID (only for whitelisted users; applicable only when dest=3)
   */
  toAddrType?: '1' | '2';
  chain?: string;
  areaCode?: string;
  clientId?: string;
  // Recipient information for specific entity users doing on-chain/lightning withdrawal
  rcvrInfo?: {
    // Required: 'exchange' for exchange wallet, 'private' for private wallet
    walletType: 'exchange' | 'private';
    // Exchange ID (required if walletType = 'exchange'). Use '0' if exchange not in list
    exchId?: string;
    // Receiver's first name (required if walletType = 'exchange')
    rcvrFirstName?: string;
    // Receiver's last name (required if walletType = 'exchange')
    rcvrLastName?: string;
    // Recipient's country - English name or ISO 3166-1 two-letter code
    rcvrCountry?: string;
    // State/Province of the recipient
    rcvrCountrySubDivision?: string;
    // Town/city where the recipient is located
    rcvrTownName?: string;
    // Recipient's street address
    rcvrStreetName?: string;
  };
}
⋮----
/**
   * Address type:
   * - 1: wallet address, email, phone, or login account name
   * - 2: UID (only for whitelisted users; applicable only when dest=3)
   */
⋮----
// Recipient information for specific entity users doing on-chain/lightning withdrawal
⋮----
// Required: 'exchange' for exchange wallet, 'private' for private wallet
⋮----
// Exchange ID (required if walletType = 'exchange'). Use '0' if exchange not in list
⋮----
// Receiver's first name (required if walletType = 'exchange')
⋮----
// Receiver's last name (required if walletType = 'exchange')
⋮----
// Recipient's country - English name or ISO 3166-1 two-letter code
⋮----
// State/Province of the recipient
⋮----
// Town/city where the recipient is located
⋮----
// Recipient's street address
⋮----
/**
 * @see GET /api/v5/public/funding-rate
 * `instId` may be a specific instrument, or the literal `ANY` for all perpetuals and X-Perp (FUTURES) contracts.
 */
export interface GetFundingRateRequest {
  instId: string;
}
⋮----
export interface FundingRateRequest {
  /** Perpetual or X-Perp FUTURES instrument id (not `ANY` on this route). */
  instId: string;
  before?: string;
  after?: string;
  limit?: string;
}
⋮----
/** Perpetual or X-Perp FUTURES instrument id (not `ANY` on this route). */
⋮----
export interface GetDepositWithdrawStatusRequest {
  wdId?: string;
  txId?: string;
  ccy?: string;
  to?: string;
  chain?: string;
}
⋮----
export interface GetDepositHistoryRequest {
  ccy?: string; // Currency, e.g. BTC
  depId?: string; // Deposit ID
  fromWdId?: string; // Internal transfer initiator's withdrawal ID
  txId?: string; // Hash record of the deposit
  type?: '3' | '4'; // Deposit Type: 3=internal transfer, 4=deposit from chain
  state?: '0' | '1' | '2' | '8' | '11' | '12' | '13' | '14' | '17'; // Status of deposit
  after?: string; // Pagination of data to return records earlier than the requested ts (Unix timestamp in milliseconds)
  before?: string; // Pagination of data to return records newer than the requested ts (Unix timestamp in milliseconds)
  limit?: string; // Number of results per request. Max is 100; default is 100
}
⋮----
ccy?: string; // Currency, e.g. BTC
depId?: string; // Deposit ID
fromWdId?: string; // Internal transfer initiator's withdrawal ID
txId?: string; // Hash record of the deposit
type?: '3' | '4'; // Deposit Type: 3=internal transfer, 4=deposit from chain
state?: '0' | '1' | '2' | '8' | '11' | '12' | '13' | '14' | '17'; // Status of deposit
after?: string; // Pagination of data to return records earlier than the requested ts (Unix timestamp in milliseconds)
before?: string; // Pagination of data to return records newer than the requested ts (Unix timestamp in milliseconds)
limit?: string; // Number of results per request. Max is 100; default is 100

================
File: src/types/websockets/ws-api-request.ts
================
import type {
  AmendAttachedTrailingStop,
  AttachAlgoOrdRequest,
} from '../rest/request/trade.js';
import {
  numberInString,
  OrderSide,
  OrderType,
  PositionSide,
  TradeMode,
} from '../rest/shared.js';
⋮----
export interface WSAPIPlaceOrderRequestV5 {
  /** Instrument ID. Deprecated March 2026; use instIdCode for lower latency. */
  instId?: string;
  /** Instrument ID code. Takes precedence over instId if both provided. Use Get instruments to map. */
  instIdCode?: number;
  tdMode: TradeMode;
  ccy?: string;
  clOrdId?: string;
  tag?: string;
  side: OrderSide;
  posSide?: PositionSide;
  ordType: OrderType;
  /** Quantity to buy or sell */
  sz: numberInString;
  px?: numberInString;
  pxUsd?: numberInString;
  pxVol?: numberInString;
  reduceOnly?: boolean;
  /** A spot buy on BTC-USDT with "base_ccy" would mean the QTY (sz) is in USDT */
  tgtCcy?: 'base_ccy' | 'quote_ccy';
  /**
   * Maximum acceptable slippage for spot and spot margin market-side orders, where tgtCcy is the received currency (base_ccy for buy, quote_ccy for sell).
   * Range: 0 to 0.05 (0% to 5%, inclusive). Up to 2 decimal places, e.g. 0.01 (1%) and 0.0123 (1.23%). Defaults to 0.00% if not specified.
   * Only applicable to SPOT and SPOT margin market orders. Cannot be amended on an existing order.
   */
  slippagePct?: string;
  banAmend?: boolean;
  tradeQuoteCcy?: string;
  stpMode?: 'cancel_maker' | 'cancel_taker' | 'cancel_both';
  /** ELP taker access. true = can trade with ELP orders (speed bump applied). Default false. Only applicable to ioc orders */
  isElpTakerAccess?: boolean;
  /** EVENTS: `"1"` for non-`post_only` orders when required (error 54086 if missing). */
  speedBump?: string;
  /** EVENTS: `yes` or `no`. */
  outcome?: string;
  attachAlgoOrds?: AttachAlgoOrdRequest[];
}
⋮----
/** Instrument ID. Deprecated March 2026; use instIdCode for lower latency. */
⋮----
/** Instrument ID code. Takes precedence over instId if both provided. Use Get instruments to map. */
⋮----
/** Quantity to buy or sell */
⋮----
/** A spot buy on BTC-USDT with "base_ccy" would mean the QTY (sz) is in USDT */
⋮----
/**
   * Maximum acceptable slippage for spot and spot margin market-side orders, where tgtCcy is the received currency (base_ccy for buy, quote_ccy for sell).
   * Range: 0 to 0.05 (0% to 5%, inclusive). Up to 2 decimal places, e.g. 0.01 (1%) and 0.0123 (1.23%). Defaults to 0.00% if not specified.
   * Only applicable to SPOT and SPOT margin market orders. Cannot be amended on an existing order.
   */
⋮----
/** ELP taker access. true = can trade with ELP orders (speed bump applied). Default false. Only applicable to ioc orders */
⋮----
/** EVENTS: `"1"` for non-`post_only` orders when required (error 54086 if missing). */
⋮----
/** EVENTS: `yes` or `no`. */
⋮----
export interface WSAPIAmendOrderRequestV5 {
  /**
   * If set, ignored  for `amend-order` / `batch-amend-orders` — use `ordId`/`clOrdId` to identify the order.
   * Map codes via Get instruments as needed.
   */
  instId?: string;
  /** Use Get instruments to map. */
  instIdCode?: number;
  cxlOnFail?: boolean;
  ordId?: string;
  clOrdId?: string;
  reqId?: string;
  newSz?: string;
  newPx?: string;
  newPxUsd?: string;
  newPxVol?: string;
  speedBump?: string;
  attachAlgoOrds?: AmendAttachedTrailingStop[];
}
⋮----
/**
   * If set, ignored  for `amend-order` / `batch-amend-orders` — use `ordId`/`clOrdId` to identify the order.
   * Map codes via Get instruments as needed.
   */
⋮----
/** Use Get instruments to map. */
⋮----
export interface WSAPIMassCancelOrdersRequestV5 {
  instType: string;
  instFamily: string;
  lockInterval?: string;
}
⋮----
export interface WSAPIPlaceSpreadOrderRequestV5 {
  sprdId: string;
  clOrdId?: string;
  tag?: string;
  side: OrderSide;
  ordType: OrderType;
  sz: numberInString;
  px?: numberInString;
}
⋮----
export interface WSAPIAmendSpreadOrderRequestV5 {
  ordId?: string;
  clOrdId?: string;
  reqId?: string;
  newSz?: string;
  newPx?: string;
}
⋮----
export interface WSAPICancelSpreadOrderRequestV5 {
  ordId?: string;
  clOrdId?: string;
}
⋮----
export interface WSAPISpreadMassCancelOrdersRequestV5 {
  sprdId?: string;
}

================
File: src/types/websockets/ws-general.ts
================
import type { ClientRequestArgs } from 'http';
import WebSocket from 'isomorphic-ws';
⋮----
import { RestClientOptions } from '../rest/client.js';
import { APICredentials, APIMarket } from '../shared.js';
⋮----
export interface WSClientConfigurableOptions {
  accounts?: APICredentials[];

  /**
   * The API group this client should connect to:
   * - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services
   * - market: 'OPENAPI_GLOBAL' // OKX Global REST at https://openapi.okx.com (WS same as GLOBAL)
   * - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
   * - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
   */
  market?: APIMarket;

  /**
   * Set to `true` to use OKX's demo trading functionality
   */
  demoTrading?: boolean;

  // Disable ping/pong ws heartbeat mechanism (not recommended).
  // Not supported for OKX
  disableHeartbeat?: boolean;

  /** How often to check if the connection is alive */
  pingInterval?: number;

  /** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
  pongTimeout?: number;

  /** Delay in milliseconds before respawning the connection */
  reconnectTimeout?: number;

  requestOptions?: RestClientOptions;

  wsOptions?: {
    protocols?: string[];
    agent?: any;
  } & Partial<WebSocket.ClientOptions | ClientRequestArgs>;
  wsUrl?: string;

  /**
   * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
   *
   * Look in the examples folder for a demonstration on using node's createHmac instead.
   */
  customSignMessageFn?: (message: string, secret: string) => Promise<string>;
}
⋮----
/**
   * The API group this client should connect to:
   * - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services
   * - market: 'OPENAPI_GLOBAL' // OKX Global REST at https://openapi.okx.com (WS same as GLOBAL)
   * - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
   * - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
   */
⋮----
/**
   * Set to `true` to use OKX's demo trading functionality
   */
⋮----
// Disable ping/pong ws heartbeat mechanism (not recommended).
// Not supported for OKX
⋮----
/** How often to check if the connection is alive */
⋮----
/** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
⋮----
/** Delay in milliseconds before respawning the connection */
⋮----
/**
   * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
   *
   * Look in the examples folder for a demonstration on using node's createHmac instead.
   */
⋮----
export interface WebsocketClientOptions extends WSClientConfigurableOptions {
  market: APIMarket;
  pongTimeout: number;
  pingInterval: number;
  reconnectTimeout: number;
  authPrivateConnectionsOnConnect: boolean;
  authPrivateRequests: boolean;

  /**
   * Whether to use native WebSocket ping/pong frames for heartbeats
   */
  useNativeHeartbeats: boolean;
}
⋮----
/**
   * Whether to use native WebSocket ping/pong frames for heartbeats
   */
⋮----
export type WsEventInternalSrc = 'event' | 'function';

================
File: src/websocket-client.ts
================
/* eslint-disable @typescript-eslint/no-unsafe-declaration-merging */
⋮----
import { APICredentials } from './types/shared.js';
import {
  WsAPIOperationResponseMap,
  WSAPIRequestFlags,
  WSAPIRequestOKX,
  WsAPITopicRequestParamMap,
  WsAPIWsKeyTopicMap,
  WsAuthRequest,
  WSOperation,
  WsRequestOperationOKX,
} from './types/websockets/ws-api.js';
import { MessageEventLike, WsDataEvent } from './types/websockets/ws-events.js';
import { WSClientConfigurableOptions } from './types/websockets/ws-general.js';
import {
  WsAuthRequestArg,
  WsChannelSubUnSubRequestArg,
} from './types/websockets/ws-request.js';
import {
  BaseWebsocketClient,
  EmittableEvent,
  MidflightWsRequestEvent,
  WSClientEventMap,
} from './util/BaseWSClient.js';
import { DefaultLogger } from './util/logger.js';
import {
  isConnCountEvent,
  isWSAPIResponse,
  isWsDataEvent,
  isWsErrorEvent,
  isWsLoginEvent,
  isWsSubscribeEvent,
  isWsUnsubscribeEvent,
  neverGuard,
} from './util/typeGuards.js';
import {
  SignAlgorithm,
  SignEncodeMethod,
  signMessage,
} from './util/webCryptoAPI.js';
import {
  getDemoWsKey,
  getPromiseRefForWSAPIRequest,
  getWsKeyForMarket,
  getWsKeyForTopicChannel,
  getWsUrlForWsKey,
  isWsPong,
  PRIVATE_WS_KEYS,
  PUBLIC_WS_KEYS,
  requiresWSAPITag,
  validateWSAPITag,
  WS_EVENT_CODE_ENUM,
  WS_KEY_MAP,
  WS_LOGGER_CATEGORY,
  WsKey,
  WsTopicRequest,
} from './util/websocket-util.js';
import { WSConnectedResult } from './util/WsStore.types.js';
⋮----
// Type safety for on and emit handlers: https://stackoverflow.com/a/61609010/880837
export declare interface WebsocketClient {
  on<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(
    event: U,
    listener: WSClientEventMap<WsKey>[U],
  ): this;

  emit<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(
    event: U,
    ...args: Parameters<WSClientEventMap<WsKey>[U]>
  ): boolean;
}
⋮----
on<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(
    event: U,
    listener: WSClientEventMap<WsKey>[U],
  ): this;
⋮----
emit<U extends keyof WSClientEventMap<WsKey, WsDataEvent>>(
    event: U,
    ...args: Parameters<WSClientEventMap<WsKey>[U]>
  ): boolean;
⋮----
export class WebsocketClient extends BaseWebsocketClient<
⋮----
constructor(options?: WSClientConfigurableOptions, logger?: DefaultLogger)
⋮----
/**
   * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
   */
public connectAll(): Promise<WSConnectedResult | undefined>[]
⋮----
public connectPublic(
    businessEndpoint?: boolean,
): Promise<WSConnectedResult | undefined>
⋮----
public connectPrivate(
    businessEndpoint?: boolean,
): Promise<WSConnectedResult | undefined>
⋮----
/**
   * Ensures the WS API connection is active and ready.
   *
   * You do not need to call this, but if you call this before making any WS API requests,
   * it can accelerate the first request (by preparing the connection in advance).
   */
public connectWSAPI(): Promise<unknown[]>
⋮----
/** This call automatically ensures the connection is active AND authenticated before resolving */
⋮----
/**
   * Subscribe to topics & track/persist them. They will be automatically resubscribed to if the connection drops/reconnects.
   * @param wsEvents topic or list of topics
   * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
   */
public subscribe(
    wsEvents: WsChannelSubUnSubRequestArg[] | WsChannelSubUnSubRequestArg,
    isPrivateTopic?: boolean,
): Promise<unknown>[]
⋮----
// Format and batch topic requests by WsKey (resolved dynamically)
⋮----
// Arrange into per-wsKey sorted lists
⋮----
/**
   * Unsubscribe from topics & remove them from memory. They won't be re-subscribed to if the connection reconnects.
   * @param wsTopics topic or list of topics
   * @param isPrivateTopic optional - the library will try to detect private topics, you can use this to mark a topic as private (if the topic isn't recognised yet)
   */
public unsubscribe(
    wsEvents: WsChannelSubUnSubRequestArg[] | WsChannelSubUnSubRequestArg,
    isPrivateTopic?: boolean,
)
⋮----
// Format and batch topic requests by WsKey (resolved dynamically)
⋮----
// Arrange into per-wsKey sorted lists
⋮----
/**
   *
   *
   * Internal methods required to integrate with the BaseWSClient
   *
   *
   */
⋮----
public getMarketWsKey(type: 'private' | 'business'): WsKey
⋮----
// returns private or business ws key for the active api market
// defaults to global
// automatically resolves to demo trading wsKeys under the hood (WSClient)
⋮----
protected sendPingEvent(wsKey: WsKey): void
⋮----
protected sendPongEvent(wsKey: WsKey): void
⋮----
protected isWsPing(data: any): boolean
⋮----
protected isWsPong(data: any): boolean
⋮----
protected isPrivateTopicRequest(
    _request: WsTopicRequest<string>,
    wsKey: WsKey,
): boolean
⋮----
protected getPrivateWSKeys(): WsKey[]
⋮----
protected isAuthOnConnectWsKey(wsKey: WsKey): boolean
⋮----
protected async getWsUrl(wsKey: WsKey): Promise<string>
⋮----
protected getMaxTopicsPerSubscribeEvent(): number | null
⋮----
/**
   * @returns one or more correctly structured request events for performing a operations over WS. This can vary per exchange spec.
   */
protected async getWsRequestEvents(
    operation: WSOperation,
    requests: WsTopicRequest<string, object>[],
): Promise<MidflightWsRequestEvent<WsRequestOperationOKX<object>>[]>
⋮----
// Previously used to track topics in a request. Keeping this for subscribe/unsubscribe requests, no need for incremental values
⋮----
/**
      {
        "op":"subscribe",
        "args":[
            {
              "channel": "tickers",
              "instId": "BTC-USDT"
            },
            {
              "channel": "tickers",
              "instId": "BTC-USDT"
            }
        ]
      }
    */
⋮----
// const request = {
//   topic: 'tickers',
//   payload: { instId: 'BTC-USDT' },
// };
// becomes:
// const request = {
//   channel: 'ticker',
//   instId: 'BTC-USDT',
// };
⋮----
private async signMessage(
    paramsStr: string,
    secret: string,
    method: SignEncodeMethod,
    algorithm: SignAlgorithm,
): Promise<string>
⋮----
protected async getWsAuthRequestEvent(
    wsKey: WsKey,
    skipIsPublicWsKeyCheck: boolean,
): Promise<WsRequestOperationOKX<WsAuthRequestArg> | null>
⋮----
// Filter out failed accounts
⋮----
private async getWsAuthSignature(
    wsKey: WsKey,
    credentials: APICredentials,
): Promise<
⋮----
// const signatureExpiresAt = timestamp + 5;
⋮----
/**
   * Abstraction called to sort ws events into emittable event types (response to a request, data update, etc)
   */
protected resolveEmittableEvents(
    wsKey: WsKey,
    event: MessageEventLike,
): EmittableEvent[]
⋮----
/**
       * WS API response handling
       */
⋮----
// const eg1 = {
//   id: '2',
//   op: 'order',
//   code: '1',
//   msg: '',
//   data: [
//     {
//       tag: '159881cb7207BCDE',
//       ts: '1753783406701',
//       ordId: '',
//       clOrdId: '',
//       sCode: '51008',
//       sMsg: 'Order failed. Insufficient USDT balance in account.',
//     },
//   ],
//   inTime: '1753783406701275',
//   outTime: '1753783406702251',
//   wsKey: 'prodPrivate',
// };
⋮----
// check getPromiseRefForWSAPIRequest
⋮----
// WS API Success
⋮----
// messageType: typeof msg,
// messageString: JSON.stringify(msg),
⋮----
// Successfully authenticated
⋮----
// this.logger.trace(`Ws subscribe reply:`, { ...msg, wsKey });
⋮----
// Queue immediate reconnection workflow
⋮----
// Emit notice to client for visibility
⋮----
// messageType: typeof msg,
// messageString: JSON.stringify(msg),
⋮----
// fallback emit anyway
⋮----
/**
   * OKX supports order placement via WebSockets. This is the WS API:
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
   *
   * For convenient promise-wrapped usage of the WS API, instance the WebsocketAPIClient class exported by this SDK.
   *
   * For demo trading, set demoTrading:true in the WS Client config.
   *
   * @returns a promise that resolves/rejects when a matching response arrives
   */
async sendWSAPIRequest<
    TWSKey extends keyof WsAPIWsKeyTopicMap,
    TWSOperation extends WsAPIWsKeyTopicMap[TWSKey],
    TWSParams extends WsAPITopicRequestParamMap[TWSOperation],
    TWSAPIResponse extends
      WsAPIOperationResponseMap[TWSOperation] = WsAPIOperationResponseMap[TWSOperation],
  >(
    rawWsKey: WsKey,
    operation: TWSOperation,
    params: TWSParams & { signRequest?: boolean },
    requestFlags?: WSAPIRequestFlags,
): Promise<TWSAPIResponse>
⋮----
// If demo trading, enforce demo wskey for WS API calls
⋮----
// Ensure "args" is always wrapped as array
⋮----
// Store deferred promise, resolved within the "resolveEmittableEvents" method while parsing incoming events
⋮----
// Enriched WS API response includes wsKey & the request that was connected to the response
type DeferredWSAPIResponse = TWSAPIResponse & {
      request: WSAPIRequestOKX<object> & { wsKey: WsKey };
    };
⋮----
// Enrich returned promise with request context for easier debugging
⋮----
// throw e;
⋮----
// Send event
⋮----
// Return deferred promise, so caller can await this call

================
File: src/types/rest/response/public-data.ts
================
import { InstrumentType, numberInString } from '../shared.js';
⋮----
export interface Ticker {
  instType: InstrumentType;
  instId: string;
  last: numberInString;
  lastSz: numberInString;
  askPx: numberInString;
  askSz: numberInString;
  bidPx: numberInString;
  bidSz: numberInString;
  open24h: numberInString;
  high24h: numberInString;
  low24h: numberInString;
  volCcy24h: numberInString;
  vol24h: numberInString;
  sodUtc0: numberInString;
  sodUtc8: numberInString;
  ts: numberInString;
}
⋮----
export interface IndexTicker {
  instId: string;
  idxPx: string;
  high24h: string;
  sodUtc0: string;
  open24h: string;
  low24h: string;
  sodUtc8: string;
  ts: string;
}
⋮----
type OBPrice = string;
type OBAssetQty = string;
type OBOrderCount = string;
type OrderBookLevel = [OBPrice, OBAssetQty, '0', OBOrderCount];
⋮----
export interface OrderBook {
  asks: OrderBookLevel[];
  bids: OrderBookLevel[];
  ts: string;
}
⋮----
type timestamp = string;
type openPrice = string;
type highPrice = string;
type lowPrice = string;
type closePrice = string;
type vol = string;
type volCcy = string;
type volCcyQuote = string;
type confirm = string;
⋮----
export type Candle = [
  timestamp,
  openPrice,
  highPrice,
  lowPrice,
  closePrice,
  vol,
  volCcy,
  volCcyQuote,
  confirm,
];
⋮----
export type CandleNoVolume = [
  timestamp,
  openPrice,
  highPrice,
  lowPrice,
  closePrice,
];
⋮----
export interface Trade {
  instId: string;
  side: string;
  sz: string;
  px: string;
  tradeId: string;
  ts: string;
  source?: string;
}
⋮----
export interface InstrumentUpcomingParamChange {
  param: 'tickSz' | 'minSz' | 'maxMktSz' | string;
  newValue: string;
  effTime: string;
}
⋮----
export interface Instrument {
  instType: InstrumentType;
  /** Series id for EVENTS, e.g. BTC-ABOVE-DAILY. */
  seriesId?: string;
  instId: string;
  uly: string;
  instFamily: string;
  category: string;
  baseCcy: string;
  quoteCcy: string;
  settleCcy: string;
  ctVal: string;
  ctMult: string;
  ctValCcy: string;
  optType: string;
  stk: string;
  listTime: string;
  contTdSwTime?: string; // Continuous trading switch time. The switch time from call auction/prequote to continuous trading. Unix timestamp format in milliseconds.
  preMktSwTime?: string; // The time premarket swap switched to normal swap. Unix timestamp format in milliseconds. Only applicable to premarket SWAP.
  expTime: string;
  lever: string;
  tickSz: string;
  lotSz: string;
  minSz: string;
  ctType: string;
  /**
   * FUTURES contract label (deprecated — prefer `expTime` for delivery time; removal planned).
   * Includes `this_five_years` / `next_five_years` (X-Perps / 5Y-style contracts).
   */
  alias: string;
  /**
   * Instrument status: live, suspend, rebase (SWAP only), post_only (SWAP only), preopen, test, expired, settling (EVENTS), …
   */
  state: string;
  openType?: string; // Open type: fix_price (fix price opening), pre_quote (pre-quote), call_auction (call auction). Only applicable to SPOT/MARGIN.
  maxLmtSz: string;
  maxLmtAmt?: string; // Max USD amount for a single limit order
  maxMktSz: string;
  maxMktAmt?: string; // Max USD amount for a single market order. Only applicable to SPOT/MARGIN.
  maxTwapSz: string;
  maxIcebergSz: string;
  maxTriggerSz: string;
  maxStopSz: string;
  /**
   * e.g. `normal`, `pre_market`, `rebase_contract`, `xperp` (perpetual-style expiry futures, some FUTURES only).
   */
  ruleType: string;
  auctionEndTime: string;
  futureSettlement?: boolean; // Whether daily settlement for expiry feature is enabled. Applicable to FUTURES cross.
  tradeQuoteCcyList?: string[]; // List of quote currencies available for trading, e.g. ["USD", "USDC"]
  instIdCode?: number; // Instrument ID code. For simple binary encoding, must use instIdCode instead of instId.
  /**
   * Asset category of the instrument's base asset (first segment of `instId`). E.g. BTC-USDT-SWAP → category of BTC.
   * 1: Crypto, 3: Stocks, 4: Commodities, 5: Forex, 6: Bonds, "": not available
   */
  instCategory?: string;
  posLmtAmt?: string; // Maximum position value (USD) for this instrument at the user level. Applicable to SWAP/FUTURES.
  posLmtPct?: string; // Maximum position ratio (e.g., 30 for 30%) a user may hold relative to platform's current total position value. Applicable to SWAP/FUTURES.
  longPosRemainingQuota?: string;
  shortPosRemainingQuota?: string;
  maxPlatOILmt?: string; // Platform-wide maximum position value (USD) for this instrument. Applicable to SWAP/FUTURES.
  groupId?: string; // Instrument trading fee group ID
  upcChg?: InstrumentUpcomingParamChange[];
}
⋮----
/** Series id for EVENTS, e.g. BTC-ABOVE-DAILY. */
⋮----
contTdSwTime?: string; // Continuous trading switch time. The switch time from call auction/prequote to continuous trading. Unix timestamp format in milliseconds.
preMktSwTime?: string; // The time premarket swap switched to normal swap. Unix timestamp format in milliseconds. Only applicable to premarket SWAP.
⋮----
/**
   * FUTURES contract label (deprecated — prefer `expTime` for delivery time; removal planned).
   * Includes `this_five_years` / `next_five_years` (X-Perps / 5Y-style contracts).
   */
⋮----
/**
   * Instrument status: live, suspend, rebase (SWAP only), post_only (SWAP only), preopen, test, expired, settling (EVENTS), …
   */
⋮----
openType?: string; // Open type: fix_price (fix price opening), pre_quote (pre-quote), call_auction (call auction). Only applicable to SPOT/MARGIN.
⋮----
maxLmtAmt?: string; // Max USD amount for a single limit order
⋮----
maxMktAmt?: string; // Max USD amount for a single market order. Only applicable to SPOT/MARGIN.
⋮----
/**
   * e.g. `normal`, `pre_market`, `rebase_contract`, `xperp` (perpetual-style expiry futures, some FUTURES only).
   */
⋮----
futureSettlement?: boolean; // Whether daily settlement for expiry feature is enabled. Applicable to FUTURES cross.
tradeQuoteCcyList?: string[]; // List of quote currencies available for trading, e.g. ["USD", "USDC"]
instIdCode?: number; // Instrument ID code. For simple binary encoding, must use instIdCode instead of instId.
/**
   * Asset category of the instrument's base asset (first segment of `instId`). E.g. BTC-USDT-SWAP → category of BTC.
   * 1: Crypto, 3: Stocks, 4: Commodities, 5: Forex, 6: Bonds, "": not available
   */
⋮----
posLmtAmt?: string; // Maximum position value (USD) for this instrument at the user level. Applicable to SWAP/FUTURES.
posLmtPct?: string; // Maximum position ratio (e.g., 30 for 30%) a user may hold relative to platform's current total position value. Applicable to SWAP/FUTURES.
⋮----
maxPlatOILmt?: string; // Platform-wide maximum position value (USD) for this instrument. Applicable to SWAP/FUTURES.
groupId?: string; // Instrument trading fee group ID
⋮----
export interface EconomicCalendarData {
  calendarId: string;
  date: string;
  region: string;
  category: string;
  event: string;
  refDate: string;
  actual: string;
  previous: string;
  forecast: string;
  dateSpan: string;
  importance: string;
  uTime: string;
  prevInitial: string;
  ccy: string;
  unit: string;
}
⋮----
export interface UnitConvertData {
  type: '1' | '2';
  instId: string;
  px: string;
  sz: string;
  unit: 'coin' | 'usds';
}
⋮----
/**
 * @see GET /api/v5/public/funding-rate
 * `instType` is `SWAP` (perp) or `FUTURES` (X-Perp) when applicable.
 */
export interface PublicFundingRate {
  instType: string;
  instId: string;
  method: string;
  formulaType: string;
  fundingRate: string;
  nextFundingRate: string;
  fundingTime: string;
  nextFundingTime: string;
  minFundingRate: string;
  maxFundingRate: string;
  interestRate: string;
  impactValue: string;
  settState: string;
  settFundingRate: string;
  premium: string;
  ts: string;
}
⋮----
/**
 * @see GET /api/v5/public/insurance-fund (Get security fund)
 */
export interface InsuranceFundDetail {
  ccy?: string;
  bal?: string;
  amt?: string;
  type?: string;
  maxBal?: string;
  maxBalTs?: string;
  decRate?: string;
  adlType?: string;
  adlBal?: string;
  adlRecBal?: string;
  /** @deprecated Returns "" per 2026-06-09 changelog */
  adlRate?: string;
  /** @deprecated Returns "" per 2026-06-09 changelog */
  adlRecRate?: string;
}
⋮----
/** @deprecated Returns "" per 2026-06-09 changelog */
⋮----
/** @deprecated Returns "" per 2026-06-09 changelog */
⋮----
export interface InsuranceFund {
  instType?: string;
  details: InsuranceFundDetail[];
}
⋮----
export interface FundingRateHistory {
  /** Perpetual (`SWAP`) or X-Perp (`FUTURES`). */
  instType: string;
  instId: string;
  fundingRate: string;
  realizedRate: string;
  fundingTime: string;
  method: string;
  formulaType?: string;
}
⋮----
/** Perpetual (`SWAP`) or X-Perp (`FUTURES`). */
⋮----
export interface SystemTime {
  ts: string;
}
⋮----
/**
 * @see GET /api/v5/public/estimated-price
 */
export interface EstimatedDeliveryExercisePrice {
  instType: string;
  instId: string;
  settlePx: string;
  ts: string;
}
⋮----
export interface OptionsTradeInfo {
  instId: string;
  tradeId: string;
  px: string;
  sz: string;
  side: 'buy' | 'sell';
  ts: string;
}
⋮----
export interface OptionTrade {
  vol24h: string;
  optType: 'C' | 'P';
  tradeInfo: OptionsTradeInfo[];
}
⋮----
export interface OptionTrades {
  instId: string;
  instFamily: string;
  tradeId: string;
  px: string;
  sz: string;
  side: 'buy' | 'sell';
  optType: 'C' | 'P';
  fillVol: string;
  fwdPx: string;
  idxPx: string;
  markPx: string;
  ts: string;
}
⋮----
export interface Announcement {
  annType: string;
  pTime: string; // The actual time the announcement was first published. Unix timestamp format in milliseconds, e.g. 1597026383085
  businessPTime: string; // The time displayed on the announcement page for user reference. Unix timestamp format in milliseconds, e.g. 1597026383085
  title: string;
  url: string;
}
⋮----
pTime: string; // The actual time the announcement was first published. Unix timestamp format in milliseconds, e.g. 1597026383085
businessPTime: string; // The time displayed on the announcement page for user reference. Unix timestamp format in milliseconds, e.g. 1597026383085
⋮----
/** Public borrow history record (GET /api/v5/finance/savings/lending-rate-history) */
export interface PublicBorrowHistoryRecord {
  ccy: string; // Currency, e.g. BTC
  amt: string; // Lending amount (deprecated)
  rate: string; // Annual borrowing interest rate
  lendingRate: string; // Annual lending interest rate
  ts: string; // Unix timestamp format in milliseconds
}
⋮----
ccy: string; // Currency, e.g. BTC
amt: string; // Lending amount (deprecated)
rate: string; // Annual borrowing interest rate
lendingRate: string; // Annual lending interest rate
ts: string; // Unix timestamp format in milliseconds
⋮----
export interface BasicInterestRate {
  ccy: string; // Currency
  rate: string; // Daily borrowing rate
  quota: string; // Max borrow
}
⋮----
ccy: string; // Currency
rate: string; // Daily borrowing rate
quota: string; // Max borrow
⋮----
export interface VIPInterestInfo {
  level: string; // VIP Level, e.g. VIP1
  loanQuotaCoef: string; // Loan quota coefficient. Loan quota = quota * level
  irDiscount: string; // Interest rate discount (Deprecated)
}
⋮----
level: string; // VIP Level, e.g. VIP1
loanQuotaCoef: string; // Loan quota coefficient. Loan quota = quota * level
irDiscount: string; // Interest rate discount (Deprecated)
⋮----
export interface RegularUserInterestInfo {
  level: string; // Regular user Level, e.g. Lv1
  loanQuotaCoef: string; // Loan quota coefficient. Loan quota = quota * level
  irDiscount: string; // Interest rate discount (Deprecated)
}
⋮----
level: string; // Regular user Level, e.g. Lv1
loanQuotaCoef: string; // Loan quota coefficient. Loan quota = quota * level
irDiscount: string; // Interest rate discount (Deprecated)
⋮----
export interface ConfigCcyItem {
  ccy: string; // Currency
  rate: string; // Daily rate
}
⋮----
ccy: string; // Currency
rate: string; // Daily rate
⋮----
export interface LoanQuotaConfig {
  ccy: string; // Currency
  stgyType: string; // Strategy type: 0=general strategy, 1=delta neutral strategy. If only 0 is returned, loan quota is shared between strategies
  quota: string; // Loan quota in absolute value
  level: string; // VIP level
}
⋮----
ccy: string; // Currency
stgyType: string; // Strategy type: 0=general strategy, 1=delta neutral strategy. If only 0 is returned, loan quota is shared between strategies
quota: string; // Loan quota in absolute value
level: string; // VIP level
⋮----
export interface InterestRateAndLoanQuota {
  basic: BasicInterestRate[];
  vip: VIPInterestInfo[];
  regular: RegularUserInterestInfo[];
  configCcyList: ConfigCcyItem[]; // Currencies that have loan quota configured using customized absolute value
  config: LoanQuotaConfig[]; // The currency details of loan quota configured using customized absolute value
}
⋮----
configCcyList: ConfigCcyItem[]; // Currencies that have loan quota configured using customized absolute value
config: LoanQuotaConfig[]; // The currency details of loan quota configured using customized absolute value
⋮----
/**
 * @see GET /api/v5/public/market-data-history
 */
export interface MarketDataHistoryFileGroup {
  dateTs: string;
  filename: string;
  sizeMB: string;
  url: string;
}
⋮----
export interface MarketDataHistoryGroupDetail {
  instId: string;
  instFamily: string;
  instType: string;
  dateRangeStart: string;
  dateRangeEnd: string;
  groupSizeMB: string;
  groupDetails: MarketDataHistoryFileGroup[];
}
⋮----
export interface MarketDataHistoryResult {
  dateAggrType: string;
  details: MarketDataHistoryGroupDetail[];
  totalSizeMB: string;
  ts: string;
}
⋮----
/** @see GET /api/v5/finance/staking-defi/eth/product-info */
export interface EthStakingProductInfo {
  fastRedemptionDailyLimit: string;
  rate: string;
  redemptDays: string;
  minAmt: string;
}
⋮----
/** @see GET /api/v5/finance/staking-defi/sol/product-info */
export interface SolStakingProductInfo {
  fastRedemptionAvail: string;
  fastRedemptionDailyLimit: string;
  rate: string;
  redemptDays: string;
  minAmt: string;
}
⋮----
/**
 * @see GET /api/v5/public/event-contract/series
 */
export interface EventContractSettlement {
  method: string;
  closeEarly: boolean;
  srcName: string;
  underlying: string;
}
⋮----
export interface EventContractSeries {
  seriesId: string;
  freq: string;
  title: string;
  category: string;
  settlement: EventContractSettlement;
}
⋮----
/**
 * @see GET /api/v5/public/event-contract/events
 */
export interface EventContractEvent {
  seriesId: string;
  eventId: string;
  expTime: string;
  state: string;
  fixTime?: string;
}
⋮----
/**
 * @see GET /api/v5/public/event-contract/markets
 */
export interface EventContractMarket {
  seriesId: string;
  eventId: string;
  instId: string;
  listTime: string;
  expTime: string;
  state: string;
  fixTime: string;
  outcome: string;
  floorStrike: string;
  settleValue: string;
  disputed: boolean;
}

================
File: src/types/rest/request/trade.ts
================
import {
  AlgoOrderState,
  AlgoOrderType,
  AlgoPositionSide,
  InstrumentType,
  MarginMode,
  numberInString,
  OrderSide,
  OrderType,
  PositionSide,
  PriceTriggerType,
  TradeMode,
} from '../shared.js';
⋮----
export interface AlgoRecentHistoryRequest {
  ordType: AlgoOrderType;
  algoId?: string;
  instType?: InstrumentType;
  instId?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
export interface AlgoLongHistoryRequest {
  ordType: AlgoOrderType;
  state?: AlgoOrderState;
  algoId?: string;
  instType?: InstrumentType;
  instId?: string;
  after?: string;
  before?: string;
  limit?: string;
}
⋮----
/**
 * When amending an attached trailing stop via amend algo / attach block (2026-04-13).
 * Only one of newCallbackRatio or newCallbackSpread.
 */
export interface AmendAttachedTrailingStop {
  newCallbackRatio?: string;
  newCallbackSpread?: string;
  newActivePx?: string;
}
⋮----
interface AlgoTriggerOrder {
  newTpTriggerPx?: string;
  newTpTriggerPxType?: 'last' | 'index' | 'mark';
  newTpOrdPx?: string;
  newSlTriggerPx?: string;
  newSlTriggerPxType?: 'last' | 'index' | 'mark';
  newSlOrdPx?: string;
  newCallbackRatio?: string;
  newCallbackSpread?: string;
  newActivePx?: string;
}
⋮----
/**
 * TP/SL and trailing (move_order_stop) attached to a parent `order` (2026-04-13: callbackRatio | callbackSpread, activePx).
 */
export interface AttachAlgoOrdRequest {
  attachAlgoClOrdId?: string;
  tpTriggerPx?: string;
  /** Only one of tpTriggerPx and tpTriggerRatio (FUTURES/SWAP). */
  tpTriggerRatio?: string;
  tpOrdPx?: string;
  tpOrdKind?: 'condition' | 'limit';
  slTriggerPx?: string;
  slTriggerRatio?: string;
  slOrdPx?: string;
  tpTriggerPxType?: 'last' | 'index' | 'mark';
  slTriggerPxType?: 'last' | 'index' | 'mark';
  sz?: string;
  amendPxOnTriggerType?: '0' | '1';
  /**
   * Trailing stop: one of `callbackRatio` or `callbackSpread` when attached ordType is `move_order_stop`.
   * e.g. 0.05 = 5%
   */
  callbackRatio?: string;
  /** Trailing: price distance (alternative to callbackRatio). */
  callbackSpread?: string;
  /** Trailing: activation; omit = activate immediately. */
  activePx?: string;
}
⋮----
/** Only one of tpTriggerPx and tpTriggerRatio (FUTURES/SWAP). */
⋮----
/**
   * Trailing stop: one of `callbackRatio` or `callbackSpread` when attached ordType is `move_order_stop`.
   * e.g. 0.05 = 5%
   */
⋮----
/** Trailing: price distance (alternative to callbackRatio). */
⋮----
/** Trailing: activation; omit = activate immediately. */
⋮----
export interface AlgoOrderRequest {
  instId: string;
  tdMode: TradeMode;
  ccy?: string;
  side: OrderSide;
  posSide?: AlgoPositionSide;
  ordType: AlgoOrderType;
  algoClOrdId?: string;
  sz: numberInString;
  tag?: string;
  reduceOnly?: boolean;
  tgtCcy?: string;
  tpTriggerPx?: numberInString;
  tpTriggerPxType?: PriceTriggerType;
  tpOrdPx?: numberInString;
  tpOrdKind?: string;
  slTriggerPx?: numberInString;
  slTriggerPxType?: PriceTriggerType;
  slOrdPx?: numberInString;
  cxlOnClosePos?: boolean;
  triggerPx?: numberInString;
  triggerPxType?: PriceTriggerType;
  orderPx?: numberInString;
  chaseType?: string;
  chaseVal?: numberInString;
  maxChaseType?: string;
  maxChaseVal?: numberInString;
  callbackRatio?: numberInString;
  callbackSpread?: numberInString;
  activePx?: numberInString;
  pxVar?: numberInString;
  pxSpread?: numberInString;
  szLimit?: numberInString;
  pxLimit?: numberInString;
  timeInterval?: string;
  quickMgnType?: string;
  closeFraction?: numberInString;
  advanceOrdType?: 'fok' | 'ioc' | '';
  attachAlgoOrds?: AttachAlgoOrdRequest[];
}
⋮----
export interface AmendOrderRequest {
  instId: string;
  cxlOnFail?: boolean;
  ordId?: string;
  clOrdId?: string;
  reqId?: string;
  newSz?: string;
  newPx?: string;
  /** EVENTS: `"1"` for non-`post_only` amends when applicable. */
  speedBump?: string;
  /**
   * Amend attached trailing stop (or related attach algo) — only one of newCallbackRatio / newCallbackSpread per item (2026-04-13).
   */
  attachAlgoOrds?: AmendAttachedTrailingStop[];
}
⋮----
/** EVENTS: `"1"` for non-`post_only` amends when applicable. */
⋮----
/**
   * Amend attached trailing stop (or related attach algo) — only one of newCallbackRatio / newCallbackSpread per item (2026-04-13).
   */
⋮----
export type AlgoOrderDetailsRequest =
  | {
      algoId: string;
    }
  | {
      algoClOrdId: string;
    };
⋮----
export interface AmendAlgoOrderRequest {
  instId: string;
  algoId?: string;
  algoClOrdId?: string;
  cxlOnFail?: boolean;
  reqId?: string;
  newSz?: string;
  newTpTriggerPx?: string;
  newTpOrdPx?: string;
  newSlTriggerPx?: string;
  newSlOrdPx?: string;
  newTpTriggerPxType?: 'last' | 'index' | 'mark';
  newSlTriggerPxType?: 'last' | 'index' | 'mark';
  newTriggerPx: string;
  newOrdPx: string;
  newTriggerPxType?: 'last' | 'index' | 'mark';
  attachAlgoOrds?: AlgoTriggerOrder[];
}
⋮----
export interface CancelAlgoOrderRequest {
  instId: string;
  algoId?: string;
  algoClOrdId?: string;
}
⋮----
export interface ClosePositionRequest {
  instId: string;
  posSide?: PositionSide;
  mgnMode: MarginMode;
  ccy?: string;
  autoCxl?: boolean;
  clOrdId?: string;
  tag?: string;
}
⋮----
export interface FillsHistoryRequest {
  instType?: InstrumentType;
  uly?: string;
  instId?: string;
  ordId?: string;
  after?: string;
  before?: string;
  begin?: string;
  end?: string;
  limit?: string;
}
⋮----
export interface OrderIdRequest {
  /**
   * REST: use as in trade docs. WebSocket `cancel-order` / `batch-cancel-orders`: deprecated (2026-04-07) — if sent, ignored; use
   * `ordId` or `clOrdId`. Optional `instIdCode` may still be used to map the instrument.
   */
  instId?: string;
  /**
   * Where supported, may take precedence over `instId` if both are present. Get instruments to map.
   */
  instIdCode?: number;
  ordId?: string;
  clOrdId?: string;
}
⋮----
/**
   * REST: use as in trade docs. WebSocket `cancel-order` / `batch-cancel-orders`: deprecated (2026-04-07) — if sent, ignored; use
   * `ordId` or `clOrdId`. Optional `instIdCode` may still be used to map the instrument.
   */
⋮----
/**
   * Where supported, may take precedence over `instId` if both are present. Get instruments to map.
   */
⋮----
export interface OrderHistoryRequest {
  instType: InstrumentType;
  uly?: string;
  instId?: string;
  ordType?: OrderType;
  state?: string;
  category?: string;
  after?: string;
  before?: string;
  begin?: string;
  end?: string;
  limit?: string;
}
⋮----
export interface OrderRequest {
  instId: string;
  tdMode: TradeMode;
  ccy?: string;
  clOrdId?: string;
  tag?: string;
  side: OrderSide;
  posSide?: PositionSide;
  ordType: OrderType;
  /** Quantity to buy or sell */
  sz: numberInString;
  px?: string;
  /** Place options orders in USD. Only applicable to options. One of px/pxUsd/pxVol must be filled for option orders */
  pxUsd?: string;
  /** Place options orders based on implied volatility, where 1 represents 100%. Only applicable to options */
  pxVol?: string;
  reduceOnly?: boolean;
  /** A spot buy on BTC-USDT with "base_ccy" would mean the QTY (sz) is in USDT */
  tgtCcy?: 'base_ccy' | 'quote_ccy';
  /**
   * Maximum acceptable slippage for spot and spot margin market-side orders, where tgtCcy is the received currency (base_ccy for buy, quote_ccy for sell).
   * Range: 0 to 0.05 (0% to 5%, inclusive). Up to 2 decimal places, e.g. 0.01 (1%) and 0.0123 (1.23%). Defaults to 0.00% if not specified.
   * Only applicable to SPOT and SPOT margin market orders. Cannot be amended on an existing order.
   */
  slippagePct?: string;
  banAmend?: boolean;
  /** Price amendment type: "0" = do not allow amendment, "1" = allow amendment within price limit. Default is "0" */
  pxAmendType?: '0' | '1';
  /** Quote currency used for trading. Only applicable to SPOT. Default is quote currency of instId */
  tradeQuoteCcy?: string;
  /** Self trade prevention mode: cancel_maker, cancel_taker, cancel_both. Default is cancel_maker */
  stpMode?: 'cancel_maker' | 'cancel_taker' | 'cancel_both';
  /** ELP taker access. true = can trade with ELP orders (speed bump applied). Default false. Only applicable to ioc orders */
  isElpTakerAccess?: boolean;
  /**
   * EVENTS: set to `"1"` for non-`post_only` orders. Error 54086 if missing when required.
   */
  speedBump?: string;
  /** EVENTS: `yes` or `no`. */
  outcome?: string;
  /** Take Profit & Stop Loss params */
  tpTriggerPx?: string;
  tpOrdPx?: string;
  slTriggerPx?: string;
  slOrdPx?: string;
  tpTriggerPxType?: PriceTriggerType;
  slTriggerPxType?: PriceTriggerType;
  /** TP/SL / trailing (attach) when placing the parent order */
  attachAlgoOrds?: AttachAlgoOrdRequest[];
  /** Quick margin type */
  quickMgnType?: 'manual' | 'auto_borrow' | 'auto_repay';
}
⋮----
/** Quantity to buy or sell */
⋮----
/** Place options orders in USD. Only applicable to options. One of px/pxUsd/pxVol must be filled for option orders */
⋮----
/** Place options orders based on implied volatility, where 1 represents 100%. Only applicable to options */
⋮----
/** A spot buy on BTC-USDT with "base_ccy" would mean the QTY (sz) is in USDT */
⋮----
/**
   * Maximum acceptable slippage for spot and spot margin market-side orders, where tgtCcy is the received currency (base_ccy for buy, quote_ccy for sell).
   * Range: 0 to 0.05 (0% to 5%, inclusive). Up to 2 decimal places, e.g. 0.01 (1%) and 0.0123 (1.23%). Defaults to 0.00% if not specified.
   * Only applicable to SPOT and SPOT margin market orders. Cannot be amended on an existing order.
   */
⋮----
/** Price amendment type: "0" = do not allow amendment, "1" = allow amendment within price limit. Default is "0" */
⋮----
/** Quote currency used for trading. Only applicable to SPOT. Default is quote currency of instId */
⋮----
/** Self trade prevention mode: cancel_maker, cancel_taker, cancel_both. Default is cancel_maker */
⋮----
/** ELP taker access. true = can trade with ELP orders (speed bump applied). Default false. Only applicable to ioc orders */
⋮----
/**
   * EVENTS: set to `"1"` for non-`post_only` orders. Error 54086 if missing when required.
   */
⋮----
/** EVENTS: `yes` or `no`. */
⋮----
/** Take Profit & Stop Loss params */
⋮----
/** TP/SL / trailing (attach) when placing the parent order */
⋮----
/** Quick margin type */
⋮----
export interface GetTransactionDetailsArchiveRequest {
  year: string;
  quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
}
⋮----
export interface OrderPrecheckRequest {
  instId: string;
  tdMode: string;
  side: string;
  posSide?: string;
  ordType: string;
  sz: string;
  px?: string;
  reduceOnly?: boolean;
  tgtCcy?: string;
  /** EVENTS: `yes` / `no`. */
  outcome?: string;
  attachAlgoOrds?: AttachAlgoOrdRequest[];
}
⋮----
/** EVENTS: `yes` / `no`. */

================
File: src/types/rest/response/private-account.ts
================
import {
  AccountLevel,
  MarginMode,
  PositionSide,
  WithdrawState,
} from '../shared.js';
import type { InstrumentUpcomingParamChange } from './public-data.js';
⋮----
export interface AccountBalanceDetail {
  availBal: string;
  availEq: string;
  cashBal: string;
  ccy: string;
  crossLiab: string;
  disEq: string;
  eq: string;
  eqUsd: string;
  frozenBal: string;
  interest: string;
  isoEq: string;
  isoLiab: string;
  isoUpl: string;
  liab: string;
  maxLoan: string;
  mgnRatio: string;
  notionalLever: string;
  ordFrozen: string;
  twap: string;
  uTime: string;
  upl: string;
  uplLiab: string;
  stgyEq: string;
  spotBal: string; // Spot balance. The unit is currency, e.g. BTC.
  openAvgPx: string[]; // Spot average cost price. The unit is USD.
  accAvgPx: string[]; // Spot accumulated cost price. The unit is USD.
  spotUpl: string; // Spot unrealized profit and loss. The unit is USD.
  spotUplRatio: string; // Spot unrealized profit and loss ratio.
  totalPnl: string; // Spot accumulated profit and loss. The unit is USD.
  totalPnlRatio: string; // Spot accumulated profit and loss ratio.
}
⋮----
spotBal: string; // Spot balance. The unit is currency, e.g. BTC.
openAvgPx: string[]; // Spot average cost price. The unit is USD.
accAvgPx: string[]; // Spot accumulated cost price. The unit is USD.
spotUpl: string; // Spot unrealized profit and loss. The unit is USD.
spotUplRatio: string; // Spot unrealized profit and loss ratio.
totalPnl: string; // Spot accumulated profit and loss. The unit is USD.
totalPnlRatio: string; // Spot accumulated profit and loss ratio.
⋮----
export interface AccountBalance {
  adjEq: string;
  details: AccountBalanceDetail[];
  imr: string;
  isoEq: string;
  mgnRatio: string;
  mmr: string;
  notionalUsd: string;
  notionalUsdForBorrow: string;
  notionalUsdForFutures: string;
  notionalUsdForOption: string;
  notionalUsdForSwap: string;
  ordFroz: string;
  totalEq: string;
  uTime: string;
  spotCopyTradingEq: string;
  upl: string;
  frpType?: string;
  // Delta neutral strategy fields
  delta: string; // Delta (USD)
  deltaLever: string; // Delta neutral strategy account level delta leverage (deltaLever = delta / totalEq)
  deltaNeutralStatus: string; // Delta risk status: 0=normal, 1=transfer restricted, 2=delta reducing
}
⋮----
// Delta neutral strategy fields
delta: string; // Delta (USD)
deltaLever: string; // Delta neutral strategy account level delta leverage (deltaLever = delta / totalEq)
deltaNeutralStatus: string; // Delta risk status: 0=normal, 1=transfer restricted, 2=delta reducing
⋮----
export interface AccountPosition {
  adl: string;
  availPos: string;
  avgPx: string;
  cTime: string;
  ccy: string;
  deltaBS: string;
  deltaPA: string;
  gammaBS: string;
  gammaPA: string;
  imr: string;
  instId: string;
  instType: string;
  interest: string;
  usdPx: string;
  last: string;
  lever: string;
  liab: string;
  liabCcy: string;
  liqPx: string;
  markPx: string;
  margin: string;
  mgnMode: MarginMode;
  mgnRatio: string;
  mmr: string;
  notionalUsd: string;
  optVal: string;
  pTime: string;
  pos: string;
  hedgedPos: string; // Hedged position size. Only returned for accounts in delta neutral strategy (stgyType:1). Returns "" for accounts in general strategy.
  posCcy: string;
  posId: string;
  posSide: PositionSide;
  thetaBS: string;
  thetaPA: string;
  tradeId: string;
  uTime: string;
  upl: string;
  uplRatio: string;
  vegaBS: string;
  vegaPA: string;
}
⋮----
hedgedPos: string; // Hedged position size. Only returned for accounts in delta neutral strategy (stgyType:1). Returns "" for accounts in general strategy.
⋮----
export interface HistoricAccountPosition {
  cTime: string;
  ccy: string;
  closeAvgPx: string;
  closeTotalPos: string;
  instId: string;
  instType: string;
  lever: string;
  mgnMode: MarginMode;
  openAvgPx: string;
  openMaxPos: string;
  pnl: string;
  pnlRatio: string;
  posId: string;
  posSide: PositionSide;
  triggerPx: string;
  type: string;
  uTime: string;
  uly: string;
}
⋮----
export interface AccountBalanceRiskData {
  ccy: string;
  disEq: string;
  eq: string;
}
⋮----
export interface AccountPositionRiskData {
  baseBal: string;
  ccy: string;
  instId: string;
  instType: string;
  mgnMode: MarginMode;
  notionalCcy: string;
  notionalUsd: string;
  pos: string;
  posCcy: string;
  posId: string;
  posSide: PositionSide;
  quoteBal: string;
}
⋮----
export interface AccountPositionRisk {
  adjEq: string;
  balData: AccountBalanceRiskData[];
  posData: AccountPositionRiskData[];
  ts: string;
}
⋮----
export interface AccountBill {
  bal: string;
  balChg: string;
  billId: string;
  ccy: string;
  execType: string;
  fee: string;
  from: string;
  instId: string;
  instType: string;
  mgnMode: MarginMode;
  notes: string;
  ordId: string;
  pnl: string;
  posBal: string;
  posBalChg: string;
  subType: string;
  sz: string;
  to: string;
  ts: string;
  type: string;
  earnAmt?: string;
  earnApr?: string;
}
⋮----
export interface BillSubTypeDetail {
  subType: string;
  subTypeDesc: string;
}
⋮----
/**
 * @see GET /api/v5/account/subtypes
 */
export interface AccountBillTypeDefinition {
  type: string;
  typeDesc: string;
  subTypeDetails: BillSubTypeDetail[];
}
⋮----
/**
 * Apply (POST) may return { result, ts }; get link (GET) may return { fileHref, state, ts }.
 */
export interface AccountHistoryBill {
  fileHref?: string;
  result?: string;
  state?: 'finished' | 'ongoing' | 'failed' | string;
  ts: string;
}
⋮----
export interface AccountConfiguration {
  acctLv: string;
  autoLoan: boolean;
  ctIsoMode: string;
  greeksType: string;
  level: string;
  levelTmp: string;
  mgnIsoMode: string;
  posMode: string;
  spotOffsetType: string;
  stgyType: string; // Strategy type: 0=general strategy, 1=delta neutral strategy
  uid: string;
  label: string;
  roleType: string;
  traderInsts: any[];
  spotRoleType: string;
  spotTraderInsts: any[];
  opAuth: string;
  kycLv: string;
  ip: string;
  perm: string;
  mainUid: string;
  discountType: '0' | '1';
  enableSpotBorrow: boolean;
  spotBorrowAutoRepay: boolean;
  feeType: string;
  settleCcy: string;
  settleCcyList: string[];
}
⋮----
stgyType: string; // Strategy type: 0=general strategy, 1=delta neutral strategy
⋮----
export interface AccountPositionModeResult {
  posMode: string;
}
⋮----
export interface AccountModeResult {
  acctLv: AccountLevel;
}
⋮----
export interface AutoLoanResult {
  autoLoan: boolean;
}
⋮----
export interface AccountLeverageResult {
  lever: string;
  mgnMode: MarginMode;
  instId: string;
  posSide: PositionSide;
}
⋮----
export interface AccountMaxOrderAmount {
  ccy: string;
  instId: string;
  maxBuy: string;
  maxSell: string;
}
⋮----
export interface AccountMaxTradableAmount {
  instId: string;
  availBuy: string;
  availSell: string;
}
⋮----
export interface AccountChangeMarginResult {
  amt: string;
  ccy: string;
  instId: string;
  leverage: string;
  posSide: PositionSide;
  type: string;
}
⋮----
export interface AccountLeverage {
  instId: string;
  mgnMode: MarginMode;
  posSide: PositionSide;
  lever: string;
}
⋮----
export interface AccountMaxLoan {
  instId: string;
  mgnMode: MarginMode;
  mgnCcy: string;
  maxLoan: string;
  ccy: string;
  side: string;
}
⋮----
export interface FeeGroup {
  taker: string;
  maker: string;
  groupId: string;
  /** ELP Maker effective fee rate. Returns "" if ELP is not applicable to the instrument. @see 2026-05-20 changelog */
  elpMaker?: string;
}
⋮----
/** ELP Maker effective fee rate. Returns "" if ELP is not applicable to the instrument. @see 2026-05-20 changelog */
⋮----
export interface AccountFeeRate {
  category: never;
  delivery: string;
  exercise: string;
  instType: string;
  level: string;
  maker: string;
  makerU: string;
  taker: string;
  takerU: string;
  settle?: string;
  ts: string;
  ruleType: string;
  feeGroup?: FeeGroup[]; // Fee groups. Applicable to SPOT/MARGIN/SWAP/FUTURES/OPTION
}
⋮----
feeGroup?: FeeGroup[]; // Fee groups. Applicable to SPOT/MARGIN/SWAP/FUTURES/OPTION
⋮----
export interface AccountIsolatedMode {
  isoMode: 'autonomy' | 'automatic';
}
⋮----
export interface AdjustLeverageInfo {
  estAvailQuoteTrans: string;
  estAvailTrans: string;
  estLiqPx: string;
  estMgn: string;
  estQuoteMgn: string;
  estMaxAmt: string;
  estQuoteMaxAmt: string;
  existOrd: boolean;
  maxLever: string;
  minLever: string;
}
⋮----
export interface InterestAccrued {
  type: '1' | '2';
  ccy: string;
  instId: string;
  mgnMode: MarginMode;
  interest: string;
  interestRate: string;
  liab: string;
  ts: string;
}
⋮----
export interface InterestRate {
  interestRate: string;
  ccy: string;
}
⋮----
export interface Greeks {
  greeksType: string;
}
⋮----
export interface MaxWithdrawal {
  ccy: string;
  maxWd: string;
  maxWdEx: string;
  spotOffsetMaxWd: string;
  spotOffsetMaxWdEx: string;
}
⋮----
export interface AccountRiskState {
  atRisk: string;
  atRiskIdx: string;
  atRiskMgn: string;
  ts: string;
}
⋮----
export interface WithdrawalHistory {
  ccy: string;
  chain: string;
  nonTradableAsset: boolean;
  amt: string;
  ts: string;
  from: string;
  areaCodeFrom: string;
  to: string;
  areaCodeTo: string;
  tag: string;
  pmtId: string;
  memo: string;
  addrExt: any;
  txId: string;
  fee: string;
  feeCcy: string;
  state: WithdrawState;
  wdId: string;
  clientId: string;
}
⋮----
export interface AccountInstrument {
  baseCcy: string;
  ctMult: string;
  ctType: string;
  ctVal: string;
  ctValCcy: string;
  expTime: string;
  instFamily: string;
  instId: string;
  instType: string;
  seriesId?: string;
  uly?: string;
  /**
   * FUTURES label (deprecated: prefer `expTime`; may include this_five_years, next_five_years, ...).
   */
  alias?: string;
  /** Deprecated; see `instCategory` on public `Instrument` where used. */
  category?: string;
  lever: string;
  listTime: string;
  contTdSwTime: string; // Continuous trading switch time. The switch time from call auction/prequote to continuous trading. Unix timestamp format in milliseconds.
  preMktSwTime: string; // The time premarket swap switched to normal swap. Unix timestamp format in milliseconds. Only applicable to premarket SWAP.
  lotSz: string;
  maxIcebergSz: string;
  maxLmtAmt: string;
  maxLmtSz: string;
  maxMktAmt: string;
  maxMktSz: string;
  maxStopSz: string;
  maxTriggerSz: string;
  maxTwapSz: string;
  minSz: string;
  optType: string;
  openType: string; // Open type: fix_price (fix price opening), pre_quote (pre-quote), call_auction (call auction). Only applicable to SPOT/MARGIN.
  quoteCcy: string;
  tradeQuoteCcyList: string[]; // List of quote currencies available for trading, e.g. ["USD", "USDC"]
  settleCcy: string;
  /** Instrument status: live, suspend, rebase (SWAP only), post_only (SWAP only), preopen, test */
  state: string;
  stk: string;
  tickSz: string;
  /** Trading rule types: normal, pre_market, rebase_contract */
  ruleType: string;
  auctionEndTime: string;
  futureSettlement: boolean; // Whether daily settlement for expiry feature is enabled. Applicable to FUTURES cross.
  instIdCode: number; // Instrument ID code. For simple binary encoding, must use instIdCode instead of instId.
  /**
   * Asset category of the instrument's base asset (see public `Instrument.instCategory` for values).
   * 1: Crypto, 3: Stocks, 4: Commodities, 5: Forex, 6: Bonds, "": not available
   */
  instCategory?: string;
  posLmtAmt: string; // Maximum position value (USD) for this instrument at the user level. Applicable to SWAP/FUTURES.
  posLmtPct: string; // Maximum position ratio (e.g., 30 for 30%) a user may hold relative to platform's current total position value. Applicable to SWAP/FUTURES.
  maxPlatOILmt: string; // Platform-wide maximum position value (USD) for this instrument. Applicable to SWAP/FUTURES.
  /** Platform-wide maximum position value (coins) for this instrument. Applicable to SWAP/FUTURES. @see 2026-05-19 changelog */
  maxPlatOICoinLmt?: string;
  /** Remaining long position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES. */
  longPosRemainingQuota?: string;
  /** Remaining short position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES. */
  shortPosRemainingQuota?: string;
  groupId?: string; // Instrument trading fee group ID
  /** ELP maker permission. "0" = not enabled, "1" = enabled but no permission, "2" = enabled with permission */
  elp?: string;
  upcChg?: InstrumentUpcomingParamChange[];
}
⋮----
/**
   * FUTURES label (deprecated: prefer `expTime`; may include this_five_years, next_five_years, ...).
   */
⋮----
/** Deprecated; see `instCategory` on public `Instrument` where used. */
⋮----
contTdSwTime: string; // Continuous trading switch time. The switch time from call auction/prequote to continuous trading. Unix timestamp format in milliseconds.
preMktSwTime: string; // The time premarket swap switched to normal swap. Unix timestamp format in milliseconds. Only applicable to premarket SWAP.
⋮----
openType: string; // Open type: fix_price (fix price opening), pre_quote (pre-quote), call_auction (call auction). Only applicable to SPOT/MARGIN.
⋮----
tradeQuoteCcyList: string[]; // List of quote currencies available for trading, e.g. ["USD", "USDC"]
⋮----
/** Instrument status: live, suspend, rebase (SWAP only), post_only (SWAP only), preopen, test */
⋮----
/** Trading rule types: normal, pre_market, rebase_contract */
⋮----
futureSettlement: boolean; // Whether daily settlement for expiry feature is enabled. Applicable to FUTURES cross.
instIdCode: number; // Instrument ID code. For simple binary encoding, must use instIdCode instead of instId.
/**
   * Asset category of the instrument's base asset (see public `Instrument.instCategory` for values).
   * 1: Crypto, 3: Stocks, 4: Commodities, 5: Forex, 6: Bonds, "": not available
   */
⋮----
posLmtAmt: string; // Maximum position value (USD) for this instrument at the user level. Applicable to SWAP/FUTURES.
posLmtPct: string; // Maximum position ratio (e.g., 30 for 30%) a user may hold relative to platform's current total position value. Applicable to SWAP/FUTURES.
maxPlatOILmt: string; // Platform-wide maximum position value (USD) for this instrument. Applicable to SWAP/FUTURES.
/** Platform-wide maximum position value (coins) for this instrument. Applicable to SWAP/FUTURES. @see 2026-05-19 changelog */
⋮----
/** Remaining long position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES. */
⋮----
/** Remaining short position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES. */
⋮----
groupId?: string; // Instrument trading fee group ID
/** ELP maker permission. "0" = not enabled, "1" = enabled but no permission, "2" = enabled with permission */
⋮----
export interface QuickMarginBorrowRepayResult {
  instId: string;
  ccy: string;
  side: 'borrow' | 'repay';
  amt: string;
  posSide: string;
  ts: string;
}
⋮----
export interface QuickMarginBorrowRepayRecord {
  instId: string;
  ccy: string;
  side: 'borrow' | 'repay';
  accBorrowed: string;
  amt: string;
  refId: string;
  ts: string;
}
⋮----
export interface VIPInterest {
  ordId: string;
  ccy: string;
  interest: string;
  interestRate: string;
  liab: string;
  ts: string;
}
⋮----
export interface VIPLoanOrder {
  ts: string;
  nextRefreshTime: string;
  ccy: string;
  ordId: string;
  state: '1' | '2' | '3' | '4' | '5';
  origRate: string;
  curRate: string;
  dueAmt: string;
  borrowAmt: string;
  repayAmt: string;
}
⋮----
export interface VIPLoanOrderDetail {
  amt: string;
  ccy: string;
  failReason: string;
  rate: string;
  ts: string;
  type: '1' | '2' | '3' | '4';
}
⋮----
export interface FixedLoanBorrowingLimitDetail {
  ccy: string;
  used: string;
  borrowed: string;
  availBorrow: string;
  minBorrow: string;
  term: string;
}
⋮----
export interface FixedLoanBorrowingLimit {
  totalBorrowLmt: string;
  totalAvailBorrow: string;
  borrowed: string;
  used: string;
  availRepay: string;
  details: FixedLoanBorrowingLimitDetail[];
  ts: string;
}
⋮----
export interface FixedLoanBorrowQuote {
  ccy: string;
  term: string;
  estAvailBorrow: string;
  estRate: string;
  estInterest: string;
  penaltyInterest: string;
  ts: string;
}
⋮----
export interface SetMMPConfigResult {
  instFamily: string;
  timeInterval: string;
  frozenInterval: string;
  qtyLimit: string;
}
⋮----
export interface MMPConfig {
  frozenInterval: string;
  instFamily: string;
  mmpFrozen: boolean;
  mmpFrozenUntil: string;
  qtyLimit: string;
  timeInterval: string;
}
⋮----
export interface BorrowRepayHistoryItem {
  ccy: string;
  type: 'auto_borrow' | 'auto_repay' | 'manual_borrow' | 'manual_repay';
  amt: string;
  accBorrowed: string;
  ts: string;
}
⋮----
export interface SetCollateralAssetsResult {
  type: 'all' | 'custom';
  ccyList: string[];
  collateralEnabled: boolean;
}
⋮----
export interface GetCollateralAssetsResult {
  ccy: string;
  collateralEnabled: boolean;
}
⋮----
export interface SetSettleCurrencyResult {
  settleCcy: string;
}
⋮----
export interface SetFeeTypeResult {
  feeType: string;
}
⋮----
export interface SetTradingConfigResult {
  type: string; // Trading config type
  stgyType: string; // Strategy type
}
⋮----
type: string; // Trading config type
stgyType: string; // Strategy type
⋮----
export interface UnmatchedInfo {
  type: string; // Unmatched information type: spot_mode, futures_mode, isolated_margin, isolated_contract, positions_options, isolated_pending_orders, pending_orders_options, trading_bot, repay_borrowings, loan, delta_risk, collateral_all, risk_unit_type
  deltaLever?: string; // Delta leverage. Applicable when type is delta_risk
  ordList?: string[]; // Unmatched order list, order ID. Applicable when type is isolated_pending_orders/pending_orders_options
  posList?: string[]; // Unmatched position list, position ID. Applicable when type is isolated_margin/isolated_contract/positions_options
}
⋮----
type: string; // Unmatched information type: spot_mode, futures_mode, isolated_margin, isolated_contract, positions_options, isolated_pending_orders, pending_orders_options, trading_bot, repay_borrowings, loan, delta_risk, collateral_all, risk_unit_type
deltaLever?: string; // Delta leverage. Applicable when type is delta_risk
ordList?: string[]; // Unmatched order list, order ID. Applicable when type is isolated_pending_orders/pending_orders_options
posList?: string[]; // Unmatched position list, position ID. Applicable when type is isolated_margin/isolated_contract/positions_options
⋮----
export interface PrecheckSetDeltaNeutralResult {
  unmatchedInfoCheck: UnmatchedInfo[];
}
⋮----
export interface MovePositionLegResultFrom {
  posId: string;
  instId: string;
  px: string;
  side: string;
  sz: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface MovePositionLegResultTo {
  instId: string;
  px: string;
  side: string;
  sz: string;
  tdMode: string;
  posSide: string;
  ccy: string;
  sCode: string;
  sMsg: string;
}
⋮----
export interface MovePositionLegResult {
  from: MovePositionLegResultFrom;
  to: MovePositionLegResultTo;
}
⋮----
/**
 * @see POST /api/v5/account/move-positions
 * @see GET /api/v5/account/move-positions-history
 */
export interface MovePositionsResult {
  clientId: string;
  blockTdId: string;
  state: 'filled' | 'failed' | 'pending' | string;
  ts: string;
  fromAcct: string;
  toAcct: string;
  legs: MovePositionLegResult[];
}

================
File: src/rest-client.ts
================
import { ASSET_BILL_TYPE } from './constants/funding.js';
import {
  BillsHistoryArchiveRequest,
  ChangePositionMarginRequest,
  GetAccountBillSubtypesRequest,
  GetBorrowRepayHistoryRequest,
  GetFixedLoanBorrowingOrdersListRequest,
  GetFixedLoanBorrowQuoteRequest,
  GetHistoricPositionParams,
  GetInstrumentsRequest,
  GetMovePositionsHistoryRequest,
  GetPositionsParams,
  GetQuickMarginBorrowRepayHistoryRequest,
  GetVIPInterestRequest,
  GetVIPLoanOrderDetailRequest,
  GetVIPLoanOrderListRequest,
  MovePositionsRequest,
  PositionBuilderRequest,
  PrecheckSetDeltaNeutralRequest,
  QuickMarginBorrowRepayRequest,
  SetFeeTypeRequest,
  SetLeverageRequest,
  SetMMPConfigRequest,
  SetSettleCurrencyRequest,
  SetTradingConfigRequest,
  SubmitFixedLoanBorrowingOrderRequest,
  UpdateFixedLoanBorrowingOrderRequest,
  WithdrawalHistoryRequest,
} from './types/rest/request/account.js';
import {
  GetAffiliateCoInviterLinkListRequest,
  GetAffiliateInviteeListRequest,
  GetAffiliateLinkListRequest,
  GetAffiliatePerformanceSummaryRequest,
  GetAffiliateSubAffiliateListRequest,
  GetInviteeDetailRequest,
} from './types/rest/request/affiliate.js';
import {
  CancelBlockQuoteRequest,
  CancelBlockRFQRequest,
  CancelMultipleBlockQuoteRequest,
  CancelMultipleBlockRFQRequest,
  CreateBlockQuoteRequest,
  CreateBlockRFQRequest,
  ExecuteBlockQuoteRequest,
  GetBlockQuoteParams,
  GetBlockRFQSParams,
  SetMmpConfigRequest,
  SetQuoteProductsRequest,
} from './types/rest/request/block-trading.js';
import {
  ConvertQuoteEstimateRequest,
  ConvertTradeRequest,
} from './types/rest/request/convert.js';
import {
  CloseSubpositionRequest,
  CopySettingsRequest,
  GetCopyTradersRequest,
  GetCTBatchLeverageInfoRequest,
  GetCTHistoryLeadTradersRequest,
  GetCTProfitDetailsRequest,
  GetCurrentSubpositionsRequest,
  GetLeadTraderPositionsRequest,
  GetLeadTraderRanksRequest,
  GetLeadTraderStatsRequest,
  GetPrivateLeadTraderRanksRequest,
  GetSubpositionsHistoryRequest,
  PlaceCTAlgoOrderRequest,
  SetCTBatchLeverageRequest,
} from './types/rest/request/copy-trading.js';
import {
  GetDcdOrderHistoryRequest,
  GetDcdOrderStatusRequest,
  GetDcdProductsRequest,
  RequestDcdQuoteRequest,
  RequestDcdRedeemQuoteRequest,
  SubmitDcdRedeemRequest,
  SubmitDcdTradeRequest,
} from './types/rest/request/dual-investment.js';
import {
  FundingRateRequest,
  FundsTransferRequest,
  GetDepositHistoryRequest,
  GetDepositWithdrawStatusRequest,
  GetFundingRateRequest,
  WithdrawRequest,
} from './types/rest/request/funding.js';
import {
  CloseContractGridPositionRequest,
  GetGridAlgoOrdersRequest,
  GetRSIBackTestingRequest,
  GridAlgoOrderRequest,
  GridAlgoOrderType,
  MaxGridQuantityRequest,
  StopGridAlgoOrderRequest,
} from './types/rest/request/grid-trading.js';
import {
  CandleRequest,
  EconomicCalendarRequest,
  GetContractOpenInterestHistoryRequest,
  GetContractTakerVolumeRequest,
  GetEventContractEventsRequest,
  GetEventContractMarketsRequest,
  GetEventContractSeriesRequest,
  GetHistoricalMarketDataRequest,
  GetInsuranceFundRequest,
  GetOptionTradesRequest,
  GetPremiumHistoryRequest,
  GetTopTradersContractLongShortRatioRequest,
  UnitConvertRequest,
} from './types/rest/request/public.js';
import {
  AmendRecurringBuyOrderRequest,
  GetRecurringBuyOrderListRequest,
  PlaceRecurringBuyOrderRequest,
} from './types/rest/request/recurring-buy.js';
import { PaginatedSymbolRequest } from './types/rest/request/shared.js';
import {
  AdjustMarginBalanceRequest,
  AmendTPSLRequest,
  CancelSubOrderRequest,
  CreateSignalBotRequest,
  CreateSignalRequest,
  GetSignalBotEventHistoryRequest,
  GetSignalBotPositionHistoryRequest,
  GetSignalBotRequest,
  GetSignalBotSubOrdersRequest,
  GetSignalsRequest,
  PlaceSubOrderRequest,
  SetSignalInstrumentsRequest,
} from './types/rest/request/signal-bot.js';
import {
  GetLendingOrderListRequest,
  GetLendingSubOrderListRequest,
  LendingOrder,
} from './types/rest/request/simple-earn.js';
import {
  GetActiveSpreadOrdersRequest,
  GetSpreadCandlesRequest,
  GetSpreadOrderHistoryArchiveRequest,
  GetSpreadOrderHistoryRequest,
  GetSpreadsRequest,
  GetSpreadTradesRequest,
  PlaceSpreadOrderRequest,
  UpdateSpreadOrderRequest,
} from './types/rest/request/spread-trading.js';
import {
  GetStableRewardsApyHistoryRequest,
  GetStableRewardsBalanceRequest,
  GetStableRewardsProductInfoRequest,
  GetStableRewardsSubscribeRedeemHistoryRequest,
  RequestStableRewardsQuoteRequest,
  SubmitStableRewardsTradeRequest,
} from './types/rest/request/stable-rewards.js';
import {
  GetManagedSubAccountTransferHistoryRequest,
  GetSubAccountMaxWithdrawalsRequest,
  SetSubAccountLoanAllocationRequest,
  SubAccountTransferRequest,
} from './types/rest/request/subaccount.js';
import {
  AlgoLongHistoryRequest,
  AlgoOrderDetailsRequest,
  AlgoOrderRequest,
  AlgoRecentHistoryRequest,
  AmendAlgoOrderRequest,
  AmendOrderRequest,
  CancelAlgoOrderRequest,
  ClosePositionRequest,
  FillsHistoryRequest,
  OrderHistoryRequest,
  OrderIdRequest,
  OrderPrecheckRequest,
  OrderRequest,
} from './types/rest/request/trade.js';
import {
  AccountBalance,
  AccountBill,
  AccountBillTypeDefinition,
  AccountChangeMarginResult,
  AccountConfiguration,
  AccountFeeRate,
  AccountHistoryBill,
  AccountInstrument,
  AccountIsolatedMode,
  AccountLeverage,
  AccountLeverageResult,
  AccountMaxLoan,
  AccountMaxOrderAmount,
  AccountMaxTradableAmount,
  AccountModeResult,
  AccountPosition,
  AccountPositionModeResult,
  AccountPositionRisk,
  AccountRiskState,
  AdjustLeverageInfo,
  AutoLoanResult,
  BorrowRepayHistoryItem,
  FixedLoanBorrowingLimit,
  FixedLoanBorrowQuote,
  Greeks,
  HistoricAccountPosition,
  InterestAccrued,
  InterestRate,
  MaxWithdrawal,
  MMPConfig,
  MovePositionsResult,
  PrecheckSetDeltaNeutralResult,
  QuickMarginBorrowRepayRecord,
  QuickMarginBorrowRepayResult,
  SetFeeTypeResult,
  SetMMPConfigResult,
  SetSettleCurrencyResult,
  SetTradingConfigResult,
  VIPInterest,
  VIPLoanOrder,
  VIPLoanOrderDetail,
} from './types/rest/response/private-account.js';
import {
  AffiliateCoInviterLinkListItem,
  AffiliateInviteeListItem,
  AffiliateLinkListItem,
  AffiliatePerformanceSummary,
  AffiliateSubAffiliateListItem,
  InviteeDetail,
} from './types/rest/response/private-affiliate.js';
import {
  BlockCounterParty,
  BlockMakerInstrumentSettings,
  BlockMMPConfig,
  BlockRFQResult,
  BlockTradeResult,
  CancelBlockQuoteResult,
  CancelBlockRFQResult,
  CreateBlockQuoteResult,
  CreateRFQResult,
  ExecuteBlockQuoteResult,
  GetBlockQuoteResult,
  PublicBlockTrade,
  SetMmpConfigResult,
} from './types/rest/response/private-block-trading.js';
import {
  CurrentSubposition,
  GetAccountConfigurationResult,
  GetCopySettingsResult,
  GetCopyTradersResult,
  GetCopyTradingConfigResult,
  GetCTBatchLeverageInfoResult,
  GetCTHistoryLeadTradersResult,
  GetCTMyLeadTradersResult,
  GetCTProfitDetailsResult,
  GetCTTotalProfitResult,
  GetCTUnrealizedProfitResult,
  GetLeadTraderRanksResult,
  GetPrivateLeadTraderRanksResult,
  LeadTraderCurrentPosition,
  LeadTraderPnl,
  LeadTraderPositionHistory,
  LeadTraderPreference,
  LeadTraderStats,
  PlaceCTAlgoOrderResult,
  SetCTBatchLeverageResult,
  SubpositionsHistory,
} from './types/rest/response/private-copy-trading.js';
import {
  DcdCurrencyPair,
  DcdOrderHistoryItem,
  DcdOrderStatus,
  DcdProduct,
  DcdQuote,
  DcdRedeemQuote,
  DcdRedeemResult,
  DcdTradeResult,
} from './types/rest/response/private-dual-investment.js';
import {
  AccruedInterestItem,
  AccruedInterestRequest,
  AdjustCollateralRequest,
  CollateralAssetsResponse,
  GetFlexibleLoanCollateralAssetsRequest,
  GetLoanInfoRequest,
  LoanHistoryItem,
  LoanHistoryRequest,
  LoanInfo,
  MaxLoanRequest,
  MaxLoanResponse,
} from './types/rest/response/private-flexible-loan.js';
import {
  AccountAssetValuation,
  AssetBillDetails,
  DepositHistory,
  FundingBalance,
  FundingCurrency,
  FundTransferResult,
  FundTransferState,
  NonTradableAsset,
  WithdrawResponse,
} from './types/rest/response/private-funding.js';
import {
  RecurringBuyOrder,
  RecurringBuyOrderResult,
  RecurringBuySubOrder,
} from './types/rest/response/private-recurring-buy.js';
import {
  CancelSignalBotsResult,
  CreateSignalBotResult,
  CreateSignalResult,
  GetSignalsResult,
} from './types/rest/response/private-signal-bot.js';
import {
  CancelSpreadOrderResponse,
  PlaceSpreadOrderResponse,
  PublicSpreadTrade,
  SpreadCandle,
  SpreadDetails,
  SpreadOrder,
  SpreadOrderBook,
  SpreadTicker,
  SpreadTrade,
  UpdateSpreadOrderResponse,
} from './types/rest/response/private-spread-trading.js';
import {
  StableRewardsApyHistoryItem,
  StableRewardsBalance,
  StableRewardsProductInfo,
  StableRewardsQuote,
  StableRewardsSubscribeRedeemHistoryItem,
  StableRewardsTradeResult,
} from './types/rest/response/private-stable-rewards.js';
import {
  ManagedSubAccountTransfer,
  SubAccount,
  SubAccountAPIReset,
  SubAccountBalances,
  SubAccountMaxWithdrawal,
  SubAccountTransferResult,
} from './types/rest/response/private-subaccount.js';
import {
  AlgoOrderDetailsResult,
  AlgoOrderListItem,
  AlgoOrderResult,
  AmendAlgoOrderResult,
  AmendedOrder,
  CancelAllAfterResponse,
  CancelledOrderResult,
  ClosedPositions,
  HistoricAlgoOrder,
  HistoricOrder,
  OrderDetails,
  OrderFill,
  OrderListItem,
  OrderResult,
} from './types/rest/response/private-trade.js';
import {
  Announcement,
  Candle,
  CandleNoVolume,
  EconomicCalendarData,
  EstimatedDeliveryExercisePrice,
  EthStakingProductInfo,
  EventContractEvent,
  EventContractMarket,
  EventContractSeries,
  FundingRateHistory,
  IndexTicker,
  Instrument,
  InsuranceFund,
  InterestRateAndLoanQuota,
  MarketDataHistoryResult,
  OptionTrade,
  OptionTrades,
  OrderBook,
  PublicBorrowHistoryRecord,
  PublicFundingRate,
  SolStakingProductInfo,
  SystemTime,
  Ticker,
  Trade,
  UnitConvertData,
} from './types/rest/response/public-data.js';
import {
  AccountLevel,
  APIResponse,
  ContractGridDirection,
  GridAlgoSubOrderType,
  InstrumentType,
  MarginMode,
  numberInString,
  Pagination,
  PositionSide,
  PosMode,
  TimestampObject,
} from './types/rest/shared.js';
import BaseRestClient from './util/BaseRestClient.js';
⋮----
export class RestClient extends BaseRestClient
⋮----
/**
   *
   * Custom SDK functions
   *
   */
⋮----
/**
   * This method is used to get the latency and time sync between the client and the server.
   * This is not official API endpoint and is only used for internal testing purposes.
   * Use this method to check the latency and time sync between the client and the server.
   * Final values might vary slightly, but it should be within few ms difference.
   * If you have any suggestions or improvements to this measurement, please create an issue or pull request on GitHub.
   */
async fetchLatencySummary(): Promise<any>
⋮----
// Adjust server time by adding estimated one-way latency
⋮----
// Calculate time difference between adjusted server time and local time
⋮----
/**
   *
   * OKX misc endpoints
   *
   */
⋮----
async getServerTime(): Promise<number>
⋮----
/**
   *
   * Trading account endpoints
   *
   */
⋮----
getAccountInstruments(
    params: GetInstrumentsRequest,
): Promise<AccountInstrument[]>
⋮----
getBalance(params?:
⋮----
getPositions(params?: GetPositionsParams): Promise<AccountPosition[]>
⋮----
getPositionsHistory(
    params?: GetHistoricPositionParams,
): Promise<HistoricAccountPosition[]>
⋮----
getAccountPositionRisk(params?: {
    instType?: Omit<'SPOT', InstrumentType>;
}): Promise<AccountPositionRisk[]>
⋮----
/** Up to last 7 days */
getBills(params?: any): Promise<AccountBill[]>
⋮----
/** Last 3 months */
getBillsArchive(params?: any): Promise<AccountBill[]>
⋮----
/**
   * Bill type ids and subTypes (unified account bill CSV columns reference `type` / `subType`).
   * @see GET /api/v5/account/subtypes
   */
getAccountBillSubtypes(
    params?: GetAccountBillSubtypesRequest,
): Promise<AccountBillTypeDefinition[]>
⋮----
/**
   * Apply for bill data since 1 February, 2021 except for the current quarter.
   * Check the "Get bills details (since 2021)" endpoint in about 2 hours for the download link; in peak load it may take longer, and if still missing after 3 hours contact support.
   * It is only applicable to the data from the unified account.
   *
   * This endpoint submits a request for bill data. You can then use getRequestedBillsHistoryLink to get the link to the bill data.
   * It may take some time to generate the data.
   */
requestBillsHistoryDownloadLink(
    params: BillsHistoryArchiveRequest,
): Promise<AccountHistoryBill[]>
⋮----
/**
   * This endpoint returns the link to the bill data which you can request using requestBillsHistoryDownloadLink.
   */
getRequestedBillsHistoryLink(
    params: BillsHistoryArchiveRequest,
): Promise<AccountHistoryBill[]>
⋮----
getAccountConfiguration(): Promise<AccountConfiguration[]>
⋮----
setPositionMode(params: {
    posMode: PosMode;
}): Promise<AccountPositionModeResult[]>
⋮----
setSettleCurrency(
    params: SetSettleCurrencyRequest,
): Promise<SetSettleCurrencyResult[]>
⋮----
setFeeType(params: SetFeeTypeRequest): Promise<SetFeeTypeResult[]>
⋮----
setLeverage(params: SetLeverageRequest): Promise<AccountLeverageResult[]>
⋮----
/** Max buy/sell amount or open amount */
getMaxBuySellAmount(params: {
    instId: string;
    tdMode: 'cross' | 'isolated' | 'cash';
    ccy?: string;
    px?: string;
    leverage?: string;
    unSpotOffset?: boolean;
    /** EVENTS: `yes` / `no` (required for max size when applicable). */
    outcome?: string;
}): Promise<AccountMaxOrderAmount[]>
⋮----
/** EVENTS: `yes` / `no` (required for max size when applicable). */
⋮----
getMaxAvailableTradableAmount(params: {
    instId: string;
    ccy?: string;
    tdMode: 'cross' | 'isolated' | 'cash';
    reduceOnly?: boolean;
    unSpotOffset?: boolean;
}): Promise<AccountMaxTradableAmount[]>
⋮----
changePositionMargin(
    params: ChangePositionMarginRequest,
): Promise<AccountChangeMarginResult[]>
⋮----
/**
   * Move positions between accounts under the same master account (VIP6+).
   * TradeFi positions are not supported (error 70004).
   * @see POST /api/v5/account/move-positions — 2026-05-15 changelog
   */
movePositions(params: MovePositionsRequest): Promise<MovePositionsResult[]>
⋮----
/**
   * Move position history for the last 3 days (VIP6+).
   * @see GET /api/v5/account/move-positions-history
   */
getMovePositionsHistory(
    params?: GetMovePositionsHistoryRequest,
): Promise<MovePositionsResult[]>
⋮----
getLeverage(params: {
    instId?: string;
    ccy?: string;
    mgnMode: MarginMode;
}): Promise<AccountLeverage[]>
⋮----
/**
   * @deprecated - will be removed in next major release
   * Use getLeverage() instead
   */
getLeverageV2(params: {
    instId?: string;
    ccy?: string;
    mgnMode: MarginMode;
}): Promise<AccountLeverage[]>
⋮----
getLeverageEstimatedInfo(params: {
    instType: string;
    mgnMode: MarginMode;
    lever: string;
    instId?: string;
    ccy?: string;
    posSide: PositionSide;
}): Promise<AdjustLeverageInfo[]>
⋮----
getMaxLoan(params: {
    instId: string;
    mgnMode: MarginMode;
    mgnCcy?: string;
    ccy?: string;
}): Promise<AccountMaxLoan[]>
⋮----
getFeeRates(params: {
    instType: InstrumentType;
    instId?: string;
    uly?: string;
    instFamily?: string;
    groupId?: string;
    ruleType?: string;
}): Promise<AccountFeeRate[]>
⋮----
getInterestAccrued(params?: {
    type?: '1' | '2';
    ccy?: string;
    instId?: string;
    mgnMode?: MarginMode;
    after?: string;
    before?: string;
    limit?: string;
}): Promise<InterestAccrued[]>
⋮----
getInterestRate(params?:
⋮----
setGreeksDisplayType(params:
⋮----
setIsolatedMode(params: {
    isoMode: 'automatic' | 'autonomy';
    type: 'MARGIN' | 'CONTRACTS';
}): Promise<AccountIsolatedMode[]>
⋮----
getMaxWithdrawals(params?:
⋮----
getAccountRiskState(): Promise<AccountRiskState[]>
⋮----
setAccountCollateralAssets(params: {
    type: 'all' | 'custom';
    collateralEnabled: boolean;
    ccyList?: string[];
  }): Promise<
    {
      type: string;
      ccyList: string[];
      collateralEnabled: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/account/set-collateral-assets', params);
⋮----
getAccountCollateralAssets(params?: {
    ccy?: string;
    collateralEnabled?: boolean;
  }): Promise<
    {
      ccy: string;
      collateralEnabled: boolean;
    }[]
  > {
    return this.getPrivate('/api/v5/account/collateral-assets', params);
⋮----
submitQuickMarginBorrowRepay(
    params: QuickMarginBorrowRepayRequest,
): Promise<QuickMarginBorrowRepayResult[]>
⋮----
getQuickMarginBorrowRepayHistory(
    params: GetQuickMarginBorrowRepayHistoryRequest,
): Promise<QuickMarginBorrowRepayRecord[]>
⋮----
borrowRepayVIPLoan(params: {
    ccy: string;
    side: 'borrow' | 'repay';
    amt: numberInString;
    ordId?: string;
}): Promise<any[]>
⋮----
getVIPLoanBorrowRepayHistory(params?: any): Promise<any[]>
⋮----
getVIPInterestAccrued(params: GetVIPInterestRequest): Promise<VIPInterest[]>
⋮----
getVIPInterestDeducted(
    params: GetVIPInterestRequest,
): Promise<VIPInterest[]>
⋮----
getVIPLoanOrders(
    params: GetVIPLoanOrderListRequest,
): Promise<VIPLoanOrder[]>
⋮----
getVIPLoanOrder(
    params: GetVIPLoanOrderDetailRequest,
): Promise<VIPLoanOrderDetail[]>
⋮----
getBorrowInterestLimits(params?: {
    type?: '1' | '2';
    ccy?: string;
}): Promise<any[]>
⋮----
getFixedLoanBorrowLimit(): Promise<FixedLoanBorrowingLimit[]>
⋮----
getFixedLoanBorrowQuote(
    params: GetFixedLoanBorrowQuoteRequest,
): Promise<FixedLoanBorrowQuote[]>
⋮----
submitFixedLoanBorrowOrder(
    params: SubmitFixedLoanBorrowingOrderRequest,
  ): Promise<
    {
      ordId: string;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/account/fixed-loan/borrowing-order',
      params,
    );
⋮----
updateFixedLoanBorrowOrder(
    params: UpdateFixedLoanBorrowingOrderRequest,
  ): Promise<
    {
      ordId: string;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/account/fixed-loan/amend-borrowing-order',
      params,
    );
⋮----
manualRenewFixedLoanBorrowOrder(params: {
    ordId: string;
    maxRate: string;
  }): Promise<
    {
      ordId: string;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/account/fixed-loan/manual-reborrow',
      params,
    );
⋮----
repayFixedLoanBorrowOrder(params: { ordId: string }): Promise<
    {
      ordId: string;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/account/fixed-loan/repay-borrowing-order',
      params,
    );
⋮----
convertFixedLoanToMarketLoan(params: { ordId: string }): Promise<
    {
      ordId: string;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/account/fixed-loan/convert-to-market-loan',
      params,
    );
⋮----
reduceFixedLoanLiabilities(params: {
    ordId: string;
    pendingRepay: boolean;
  }): Promise<
    {
      ordId: string;
      pendingRepay: boolean;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/account/fixed-loan/reduce-liabilities',
      params,
    );
⋮----
getFixedLoanBorrowOrders(
    params: GetFixedLoanBorrowingOrdersListRequest,
): Promise<any[]>
⋮----
manualBorrowRepay(params: {
    ccy: string;
    side: 'borrow' | 'repay';
    amt: string;
  }): Promise<
    {
      ccy: string;
      side: 'borrow' | 'repay';
      amt: string;
    }[]
  > {
    return this.postPrivate('/api/v5/account/spot-manual-borrow-repay', params);
⋮----
setAutoRepay(params: { autoRepay: boolean }): Promise<
    {
      autoRepay: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/account/set-auto-repay', params);
⋮----
getBorrowRepayHistory(
    params?: GetBorrowRepayHistoryRequest,
): Promise<BorrowRepayHistoryItem[]>
⋮----
positionBuilder(params: PositionBuilderRequest): Promise<any[]>
⋮----
updateRiskOffsetAmount(params: {
    ccy: string;
    clSpotInUseAmt: string;
  }): Promise<
    {
      ccy: string;
      clSpotInUseAmt: string;
    }[]
  > {
    return this.postPrivate('/api/v5/account/set-riskOffset-amt', params);
⋮----
getGreeks(params?:
⋮----
getPMLimitation(params: {
    instType: 'SWAP' | 'FUTURES' | 'OPTION';
    uly?: string;
    instFamily?: string;
}): Promise<any[]>
⋮----
updateRiskOffsetType(params: { type: '1' | '2' | '3' | '4' }): Promise<
    {
      type: '1' | '2' | '3' | '4';
    }[]
  > {
    return this.postPrivate('/api/v5/account/set-riskOffset-type', params);
⋮----
activateOption(): Promise<
    {
      ts: string;
    }[]
  > {
    return this.postPrivate('/api/v5/account/activate-option');
⋮----
setAutoLoan(params:
⋮----
presetAccountLevelSwitch(params: {
    acctLv: '2' | '3' | '4';
    lever?: string;
    riskOffsetType?: '1' | '2' | '3' | '4';
}): Promise<any[]>
⋮----
getAccountSwitchPrecheck(params: {
    acctLv: '1' | '2' | '3' | '4';
}): Promise<any[]>
⋮----
setAccountMode(params: {
    acctLv: AccountLevel;
}): Promise<AccountModeResult[]>
⋮----
resetMMPStatus(params: { instType?: 'OPTION'; instFamily: string }): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/account/mmp-reset', params);
⋮----
setMMPConfig(params: SetMMPConfigRequest): Promise<SetMMPConfigResult[]>
⋮----
getMMPConfig(params?:
⋮----
setTradingConfig(
    params: SetTradingConfigRequest,
): Promise<SetTradingConfigResult[]>
⋮----
precheckSetDeltaNeutral(
    params: PrecheckSetDeltaNeutralRequest,
): Promise<PrecheckSetDeltaNeutralResult[]>
⋮----
/**
   *
   * Orderbook trading - trade endpoints
   *
   */
⋮----
submitOrder(params: OrderRequest): Promise<OrderResult[]>
⋮----
submitMultipleOrders(params: OrderRequest[]): Promise<OrderResult[]>
⋮----
cancelOrder(params: OrderIdRequest): Promise<CancelledOrderResult[]>
⋮----
cancelMultipleOrders(
    params: OrderIdRequest[],
): Promise<CancelledOrderResult[]>
⋮----
amendOrder(params: AmendOrderRequest): Promise<AmendedOrder[]>
⋮----
amendMultipleOrders(params: AmendOrderRequest[]): Promise<AmendedOrder[]>
⋮----
closePositions(params: ClosePositionRequest): Promise<ClosedPositions[]>
⋮----
getOrderDetails(params: OrderIdRequest): Promise<OrderDetails[]>
⋮----
getOrderList(params?: OrderHistoryRequest): Promise<OrderListItem[]>
⋮----
/**
   * Get history for last 7 days
   */
getOrderHistory(params: OrderHistoryRequest): Promise<HistoricOrder[]>
⋮----
/**
   * Get history for last 3 months
   */
getOrderHistoryArchive(
    params: OrderHistoryRequest,
): Promise<HistoricOrder[]>
⋮----
/**
   * Get history for last 7 days
   */
getFills(params?: FillsHistoryRequest): Promise<OrderFill[]>
⋮----
/**
   * Get history for last 3 months
   */
getFillsHistory(params: FillsHistoryRequest): Promise<OrderFill[]>
⋮----
/** Get easy convert currency list */
getEasyConvertCurrencies(params?:
⋮----
/**
   *
   * Place easy convert : Convert small currencies to mainstream currencies.
   * Only applicable to the crypto balance less than $10.
   *
   * Maximum 5 currencies can be selected in one order.
   * If there are multiple currencies, separate them with commas in the "from" field.
   *
   */
submitEasyConvert(params: {
    fromCcys: string[];
    toCcy: string;
    source?: string;
}): Promise<APIResponse<any>>
⋮----
/** Get easy convert history : Get the history and status of easy convert trades. */
getEasyConvertHistory(params?: Pagination): Promise<APIResponse<any>>
⋮----
/**
   *
   * Get one-click repay currency list : Get list of debt currency data and repay currencies.
   * Debt currencies include both cross and isolated debts.
   */
getOneClickRepayCurrencyList(params?: {
    debtType?: 'cross' | 'isolated';
}): Promise<APIResponse<any>>
⋮----
/**
   * Trade one-click repay to repay cross debts.
   * Isolated debts are not applicable.
   * The maximum repayment amount is based on the remaining available balance of funding and trading accounts.
   */
submitOneClickRepay(params: {
    debtCcys: string[];
    repayCcy: string;
}): Promise<APIResponse<any>>
⋮----
/** Get the history and status of one-click repay trades. */
getOneClickRepayHistory(params?: Pagination): Promise<APIResponse<any>>
⋮----
cancelMassOrder(params: {
    instType: string;
    instFamily: string;
    lockInterval?: string;
  }): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/trade/mass-cancel', params);
⋮----
cancelAllAfter(params: {
    timeOut: string;
    tag?: string;
}): Promise<CancelAllAfterResponse[]>
⋮----
getAccountRateLimit(): Promise<any[]>
⋮----
submitOrderPrecheck(params: OrderPrecheckRequest): Promise<any[]>
⋮----
/**
   *
   * Orderbook trading - Algo trading endpoints
   *
   */
⋮----
placeAlgoOrder(params: AlgoOrderRequest): Promise<AlgoOrderResult[]>
⋮----
cancelAlgoOrder(
    params: CancelAlgoOrderRequest[],
): Promise<AlgoOrderResult[]>
⋮----
amendAlgoOrder(
    params: AmendAlgoOrderRequest,
): Promise<AmendAlgoOrderResult[]>
⋮----
cancelAdvanceAlgoOrder(
    params: CancelAlgoOrderRequest[],
): Promise<AlgoOrderResult[]>
⋮----
getAlgoOrderDetails(
    params: AlgoOrderDetailsRequest,
): Promise<AlgoOrderDetailsResult[]>
⋮----
getAlgoOrderList(
    params: AlgoRecentHistoryRequest,
): Promise<AlgoOrderListItem[]>
⋮----
getAlgoOrderHistory(
    params: AlgoLongHistoryRequest,
): Promise<HistoricAlgoOrder[]>
⋮----
/**
   *
   * Orderbook trading - Grid trading endpoints
   *
   */
⋮----
placeGridAlgoOrder(params: GridAlgoOrderRequest): Promise<any[]>
⋮----
amendGridAlgoOrder(params: {
    algoId: string;
    instId: string;
    slTriggerPx?: string;
    tpTriggerPx?: string;
    tpRatio?: string;
    slRatio?: string;
    triggerParams?: {
      triggerAction?: string;
      triggerStrategy?: string;
      triggerPx?: string;
      stopType?: string;
    }[];
}): Promise<any[]>
⋮----
stopGridAlgoOrder(orders: StopGridAlgoOrderRequest[]): Promise<any[]>
⋮----
closeGridContractPosition(
    params: CloseContractGridPositionRequest,
): Promise<any[]>
⋮----
cancelGridContractCloseOrder(params: {
    algoId: string;
    ordId: string;
}): Promise<any[]>
⋮----
instantTriggerGridAlgoOrder(params: { algoId: string }): Promise<
    {
      algoId: string;
      algoClOrdId: string;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/tradingBot/grid/order-instant-trigger',
      params,
    );
⋮----
getGridAlgoOrderList(params: GetGridAlgoOrdersRequest): Promise<any[]>
⋮----
getGridAlgoOrderHistory(params: GetGridAlgoOrdersRequest): Promise<any[]>
⋮----
getGridAlgoOrderDetails(params: {
    algoOrdType: GridAlgoOrderType;
    algoId: string;
}): Promise<any[]>
⋮----
getGridAlgoSubOrders(params: {
    algoOrdType: GridAlgoOrderType;
    algoId: string;
    type: GridAlgoSubOrderType;
    groupId?: string;
    after?: numberInString;
    before?: numberInString;
    limit?: number;
}): Promise<any[]>
⋮----
getGridAlgoOrderPositions(params: {
    algoOrdType: 'contract_grid';
    algoId: string;
}): Promise<any[]>
⋮----
spotGridWithdrawIncome(params:
⋮----
computeGridMarginBalance(params: {
    algoId: string;
    type: 'add' | 'reduce';
    amt?: numberInString;
}): Promise<any[]>
⋮----
adjustGridMarginBalance(params: {
    algoId: string;
    type: 'add' | 'reduce';
    amt?: numberInString;
    percent?: numberInString;
}): Promise<any[]>
⋮----
adjustGridInvestment(params: { algoId: string; amt: string }): Promise<
    {
      algoId: string;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/tradingBot/grid/adjust-investment',
      params,
    );
⋮----
getGridAIParameter(params: {
    algoOrdType: GridAlgoOrderType;
    instId: string;
    direction: ContractGridDirection;
    duration?: '7D' | '30D' | '180D';
}): Promise<any[]>
⋮----
computeGridMinInvestment(params: {
    amt: string;
    ccy: string;
}): Promise<any[]>
⋮----
getRSIBackTesting(params: GetRSIBackTestingRequest): Promise<
    {
      triggerNum: string;
    }[]
  > {
    return this.get('/api/v5/tradingBot/public/rsi-back-testing', params);
⋮----
getMaxGridQuantity(params: MaxGridQuantityRequest): Promise<
    {
      maxGridQty: string;
    }[]
  > {
    return this.get('/api/v5/tradingBot/grid/grid-quantity', params);
⋮----
/**
   *
   * Orderbook trading - Signal bot trading endpoints
   *
   */
⋮----
createSignal(params: CreateSignalRequest): Promise<CreateSignalResult[]>
⋮----
getSignals(params: GetSignalsRequest): Promise<GetSignalsResult[]>
⋮----
createSignalBot(
    params: CreateSignalBotRequest,
): Promise<CreateSignalBotResult[]>
⋮----
cancelSignalBots(params: {
    algoId: string;
}): Promise<CancelSignalBotsResult[]>
⋮----
updateSignalMargin(params: AdjustMarginBalanceRequest): Promise<
    {
      algoId: string;
    }[]
  > {
    return this.postPrivate('/api/v5/tradingBot/signal/margin-balance', params);
⋮----
updateSignalTPSL(params: AmendTPSLRequest): Promise<
    {
      algoId: string;
    }[]
  > {
    return this.postPrivate('/api/v5/tradingBot/signal/amendTPSL', params);
⋮----
setSignalInstruments(params: SetSignalInstrumentsRequest): Promise<
    {
      algoId: string;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/tradingBot/signal/set-instruments',
      params,
    );
⋮----
getSignalBotOrder(params: {
    algoOrdType: string;
    algoId: string;
}): Promise<any[]>
⋮----
getActiveSignalBot(params: GetSignalBotRequest): Promise<any[]>
⋮----
getSignalBotHistory(params: GetSignalBotRequest): Promise<any[]>
⋮----
getSignalBotPositions(params: {
    algoOrdType: string;
    algoId: string;
}): Promise<any[]>
⋮----
getSignalBotPositionHistory(
    params: GetSignalBotPositionHistoryRequest,
): Promise<any[]>
⋮----
closeSignalBotPosition(params: { algoId: string; instId: string }): Promise<
    {
      algoId: string;
    }[]
  > {
    return this.postPrivate('/api/v5/tradingBot/signal/close-position', params);
⋮----
placeSignalBotSubOrder(params: PlaceSubOrderRequest): Promise<any[]>
⋮----
cancelSubOrder(params: CancelSubOrderRequest): Promise<any[]>
⋮----
getSignalBotSubOrders(params: GetSignalBotSubOrdersRequest): Promise<any[]>
⋮----
getSignalBotEventHistory(
    params: GetSignalBotEventHistoryRequest,
): Promise<any[]>
⋮----
/**
   *
   * Orderbook trading - Recurring buy endpoints
   *
   */
⋮----
submitRecurringBuyOrder(
    params: PlaceRecurringBuyOrderRequest,
): Promise<RecurringBuyOrderResult[]>
⋮----
amendRecurringBuyOrder(
    params: AmendRecurringBuyOrderRequest,
): Promise<RecurringBuyOrderResult[]>
⋮----
stopRecurringBuyOrder(params: {
    algoId: string;
}): Promise<RecurringBuyOrderResult[]>
⋮----
getRecurringBuyOrders(
    params: GetRecurringBuyOrderListRequest,
): Promise<RecurringBuyOrder[]>
⋮----
getRecurringBuyOrderHistory(
    params: GetRecurringBuyOrderListRequest,
): Promise<RecurringBuyOrder[]>
⋮----
getRecurringBuyOrderDetails(params: {
    algoId: string;
}): Promise<RecurringBuyOrder[]>
⋮----
getRecurringBuySubOrders(
    params: GetRecurringBuyOrderListRequest,
): Promise<RecurringBuySubOrder[]>
⋮----
/**
   *
   * Orderbook trading - Copy trading endpoints
   *
   */
⋮----
getCopytradingSubpositions(
    params?: GetCurrentSubpositionsRequest,
): Promise<CurrentSubposition[]>
⋮----
getCopytradingSubpositionsHistory(
    params?: GetSubpositionsHistoryRequest,
): Promise<SubpositionsHistory[]>
⋮----
submitCopytradingAlgoOrder(
    params: PlaceCTAlgoOrderRequest,
): Promise<PlaceCTAlgoOrderResult[]>
⋮----
closeCopytradingSubposition(params: CloseSubpositionRequest): Promise<
    {
      subPosId: string;
      tag: string;
    }[]
  > {
    return this.postPrivate('/api/v5/copytrading/close-subposition', params);
⋮----
getCopytradingInstruments(params?: { instType?: 'SPOT' | 'SWAP' }): Promise<
    {
      instId: string;
      enabled: boolean;
    }[]
  > {
    return this.getPrivate('/api/v5/copytrading/instruments', params);
⋮----
setCopytradingInstruments(params: {
    instType?: 'SPOT' | 'SWAP';
    instId: string;
  }): Promise<
    {
      instId: string;
      enabled: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/copytrading/set-instruments', params);
⋮----
getCopytradingProfitDetails(
    params?: GetCTProfitDetailsRequest,
): Promise<GetCTProfitDetailsResult[]>
⋮----
getCopytradingTotalProfit(params?: {
    instType?: 'SPOT' | 'SWAP';
}): Promise<GetCTTotalProfitResult[]>
⋮----
getCopytradingUnrealizedProfit(params?: {
    instType?: 'SPOT' | 'SWAP';
}): Promise<GetCTUnrealizedProfitResult[]>
⋮----
getCopytradingTotalUnrealizedProfit(params?: { instType?: 'SWAP' }): Promise<
    {
      instType?: 'SWAP';
      instId: string;
    }[]
  > {
    return this.getPrivate(
      '/api/v5/copytrading/total-unrealized-profit-sharing',
      params,
    );
⋮----
applyCopytradingLeadTrading(params: {
    profitSharingTs: string;
    totalUnrealizedProfitSharingAmt: string;
  }): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/copytrading/apply-lead-trading', params);
⋮----
stopCopytradingLeadTrading(params?: { instType?: 'SWAP' }): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/copytrading/stop-lead-trading', params);
⋮----
updateCopytradingProfitSharing(params: {
    instType?: 'SWAP';
    profitSharingRatio: string;
  }): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/copytrading/amend-profit-sharing-ratio',
      params,
    );
⋮----
getCopytradingAccount(): Promise<GetAccountConfigurationResult[]>
⋮----
setCopytradingFirstCopy(params: CopySettingsRequest): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/copytrading/first-copy-settings', params);
⋮----
updateCopytradingCopySettings(params: CopySettingsRequest): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/copytrading/amend-copy-settings', params);
⋮----
stopCopytradingCopy(params: {
    instType?: 'SWAP';
    uniqueCode: string;
    subPosCloseType: 'market_close' | 'copy_close' | 'manual_close';
  }): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/copytrading/stop-copy-trading', params);
⋮----
getCopytradingCopySettings(params: {
    instType?: 'SWAP';
    uniqueCode: string;
}): Promise<GetCopySettingsResult[]>
⋮----
getCopytradingBatchLeverageInfo(
    params: GetCTBatchLeverageInfoRequest,
): Promise<GetCTBatchLeverageInfoResult[]>
⋮----
setCopytradingBatchLeverage(
    params: SetCTBatchLeverageRequest,
): Promise<SetCTBatchLeverageResult[]>
⋮----
getCopytradingMyLeadTraders(params?: {
    instType?: 'SWAP';
}): Promise<GetCTMyLeadTradersResult[]>
⋮----
getCopytradingLeadTradersHistory(
    params?: GetCTHistoryLeadTradersRequest,
): Promise<GetCTHistoryLeadTradersResult[]>
⋮----
getCopytradingConfig(params?: {
    instType?: 'SWAP';
}): Promise<GetCopyTradingConfigResult[]>
⋮----
getCopytradingLeadRanks(
    params?: GetLeadTraderRanksRequest,
): Promise<GetLeadTraderRanksResult[]>
⋮----
getCopytradingLeadWeeklyPnl(params: {
    instType?: 'SWAP';
    uniqueCode: string;
}): Promise<LeadTraderPnl[]>
⋮----
getCopytradingLeadDailyPnl(
    params: GetLeadTraderStatsRequest,
): Promise<LeadTraderPnl[]>
⋮----
getCopytradingLeadStats(
    params: GetLeadTraderStatsRequest,
): Promise<LeadTraderStats[]>
⋮----
getCopytradingLeadPreferences(params: {
    instType?: 'SWAP';
    uniqueCode: string;
}): Promise<LeadTraderPreference[]>
⋮----
getCopytradingLeadOpenPositions(
    params: GetLeadTraderPositionsRequest,
): Promise<LeadTraderCurrentPosition[]>
⋮----
getCopytradingLeadPositionHistory(
    params: GetLeadTraderPositionsRequest,
): Promise<LeadTraderPositionHistory[]>
⋮----
getCopyTraders(
    params: GetCopyTradersRequest,
): Promise<GetCopyTradersResult[]>
⋮----
getCopytradingLeadPrivateRanks(
    params?: GetPrivateLeadTraderRanksRequest,
): Promise<GetPrivateLeadTraderRanksResult[]>
⋮----
getCopytradingLeadPrivateWeeklyPnl(params: {
    instType?: 'SWAP';
    uniqueCode: string;
}): Promise<LeadTraderPnl[]>
⋮----
getCopytradingPLeadPrivateDailyPnl(
    params: GetLeadTraderStatsRequest,
): Promise<LeadTraderPnl[]>
⋮----
geCopytradingLeadPrivateStats(
    params: GetLeadTraderStatsRequest,
): Promise<LeadTraderStats[]>
⋮----
getCopytradingLeadPrivatePreferences(params: {
    instType?: 'SWAP';
    uniqueCode: string;
}): Promise<LeadTraderPreference[]>
⋮----
getCopytradingLeadPrivateOpenPositions(
    params: GetLeadTraderPositionsRequest,
): Promise<LeadTraderCurrentPosition[]>
⋮----
getCopytradingLeadPrivatePositionHistory(
    params: GetLeadTraderPositionsRequest,
): Promise<LeadTraderPositionHistory[]>
⋮----
getCopyTradersPrivate(
    params: GetCopyTradersRequest,
): Promise<GetCopyTradersResult[]>
⋮----
/**
   *
   * Orderbook trading - Market data endpoints
   *
   */
⋮----
getTickers(params: {
    instType: InstrumentType;
    uly?: string;
    instFamily?: string;
}): Promise<Ticker[]>
⋮----
getTicker(params:
⋮----
getOrderBook(params: {
    instId: string;
    sz?: numberInString;
}): Promise<OrderBook[]>
⋮----
getFullOrderBook(params: {
    instId: string;
    sz?: string;
}): Promise<OrderBook[]>
⋮----
getCandles(params: CandleRequest): Promise<Candle[]>
⋮----
getHistoricCandles(params: CandleRequest): Promise<Candle[]>
⋮----
getTrades(params:
⋮----
getHistoricTrades(params: {
    instId: string;
    after?: numberInString;
    before?: numberInString;
    limit?: numberInString;
    type?: '1' | '2';
}): Promise<Trade[]>
⋮----
getOptionTradesByInstrument(params: {
    instFamily: string;
}): Promise<OptionTrade[]>
⋮----
getOptionTrades(params: GetOptionTradesRequest): Promise<OptionTrades[]>
⋮----
get24hrTotalVolume(): Promise<any[]>
⋮----
/**
   *
   * Block trading - REST endpoints
   *
   */
⋮----
getBlockCounterParties(): Promise<BlockCounterParty[]>
⋮----
createBlockRFQ(params: CreateBlockRFQRequest): Promise<CreateRFQResult[]>
⋮----
cancelBlockRFQ(
    params: CancelBlockRFQRequest,
): Promise<CancelBlockRFQResult[]>
⋮----
cancelMultipleBlockRFQs(
    params: CancelMultipleBlockRFQRequest,
): Promise<CancelBlockRFQResult[]>
⋮----
cancelAllRFQs(): Promise<TimestampObject[]>
⋮----
executeBlockQuote(
    params: ExecuteBlockQuoteRequest,
): Promise<ExecuteBlockQuoteResult[]>
⋮----
getQuoteProducts(): Promise<BlockMakerInstrumentSettings[]>
⋮----
updateBlockQuoteProducts(params: SetQuoteProductsRequest): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/rfq/maker-instrument-settings', params);
⋮----
resetBlockMmp(): Promise<
    {
      ts: string;
    }[]
  > {
    return this.postPrivate('/api/v5/rfq/mmp-reset');
⋮----
updateBlockMmpConfig(
    params: SetMmpConfigRequest,
): Promise<SetMmpConfigResult[]>
⋮----
getBlockMmpConfig(): Promise<BlockMMPConfig[]>
⋮----
createBlockQuote(
    params: CreateBlockQuoteRequest,
): Promise<CreateBlockQuoteResult[]>
⋮----
cancelBlockQuote(
    params: CancelBlockQuoteRequest,
): Promise<CancelBlockQuoteResult[]>
⋮----
cancelMultipleBlockQuotes(
    params: CancelMultipleBlockQuoteRequest,
): Promise<CancelBlockQuoteResult[]>
⋮----
cancelAllBlockQuotes(): Promise<TimestampObject[]>
⋮----
cancelAllBlockAfter(params: { timeOut: string }): Promise<
    {
      triggerTime: string;
      ts: string;
    }[]
  > {
    return this.postPrivate('/api/v5/rfq/cancel-all-after', params);
⋮----
getBlockRFQs(params?: GetBlockRFQSParams): Promise<BlockRFQResult[]>
⋮----
getBlockQuotes(params?: GetBlockQuoteParams): Promise<GetBlockQuoteResult[]>
⋮----
getBlockTrades(params?: any): Promise<BlockTradeResult[]>
⋮----
getPublicRFQBlockTrades(params?: any): Promise<PublicBlockTrade[]>
⋮----
getBlockTickers(params: {
    instType: InstrumentType;
    uly?: string;
}): Promise<any[]>
⋮----
getBlockTicker(params:
⋮----
getBlockPublicTrades(params: {
    instId: string;
}): Promise<PublicBlockTrade[]>
⋮----
/**
   *
   * Spread trading - REST endpoints
   *
   */
⋮----
submitSpreadOrder(
    params: PlaceSpreadOrderRequest,
): Promise<PlaceSpreadOrderResponse[]>
⋮----
cancelSpreadOrder(params?: {
    ordId?: string;
    clOrdId?: string;
}): Promise<CancelSpreadOrderResponse[]>
⋮----
cancelAllSpreadOrders(params?: { sprdId?: string }): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate('/api/v5/sprd/mass-cancel', params);
⋮----
updateSpreadOrder(
    params: UpdateSpreadOrderRequest,
): Promise<UpdateSpreadOrderResponse[]>
⋮----
getSpreadOrder(params: {
    ordId?: string;
    clOrdId?: string;
}): Promise<SpreadOrder[]>
⋮----
getSpreadActiveOrders(
    params?: GetActiveSpreadOrdersRequest,
): Promise<SpreadOrder[]>
⋮----
getSpreadOrdersRecent(
    params?: GetSpreadOrderHistoryRequest,
): Promise<SpreadOrder[]>
⋮----
getSpreadOrdersArchive(
    params?: GetSpreadOrderHistoryArchiveRequest,
): Promise<SpreadOrder[]>
⋮----
getSpreadTrades(params?: GetSpreadTradesRequest): Promise<SpreadTrade[]>
⋮----
getSpreads(params?: GetSpreadsRequest): Promise<SpreadDetails[]>
⋮----
getSpreadOrderBook(params: {
    sprdId: string;
    sz?: string;
}): Promise<SpreadOrderBook[]>
⋮----
getSpreadTicker(params:
⋮----
getSpreadPublicTrades(params?: {
    sprdId?: string;
}): Promise<PublicSpreadTrade[]>
⋮----
getSpreadCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>
⋮----
getSpreadHistoryCandles(
    params: GetSpreadCandlesRequest,
): Promise<SpreadCandle[]>
⋮----
cancelSpreadAllAfter(params: { timeOut: string }): Promise<
    {
      triggerTime: string;
      ts: string;
    }[]
  > {
    return this.postPrivate('/api/v5/sprd/cancel-all-after', params);
⋮----
/**
   *
   * Public data - rest endpoints
   *
   */
⋮----
getInstruments(params: GetInstrumentsRequest): Promise<Instrument[]>
⋮----
/**
   * Prediction / event contract series. Public (no auth required since 2026-05-19).
   * @see GET /api/v5/public/event-contract/series
   */
getEventContractSeries(
    params?: GetEventContractSeriesRequest,
): Promise<EventContractSeries[]>
⋮----
/**
   * Events for a series. Public (no auth required since 2026-05-19).
   * @see GET /api/v5/public/event-contract/events
   */
getEventContractEvents(
    params: GetEventContractEventsRequest,
): Promise<EventContractEvent[]>
⋮----
/**
   * Markets for events. Public (no auth required since 2026-05-19).
   * @see GET /api/v5/public/event-contract/markets
   */
getEventContractMarkets(
    params: GetEventContractMarketsRequest,
): Promise<EventContractMarket[]>
⋮----
getDeliveryExerciseHistory(params: any): Promise<any[]>
⋮----
getOpenInterest(params: any): Promise<any[]>
⋮----
getFundingRate(params: GetFundingRateRequest): Promise<PublicFundingRate[]>
⋮----
getFundingRateHistory(
    params: FundingRateRequest,
): Promise<FundingRateHistory[]>
⋮----
getMinMaxLimitPrice(params: any): Promise<any[]>
⋮----
getOptionMarketData(params: any): Promise<any[]>
⋮----
/**
   * Estimated delivery or exercise price (FUTURES / OPTION / EVENTS; REST returns one row with `settlePx`).
   * The value is only meaningful shortly before delivery/exercise. The window used for the index mean is 30 minutes (since 2026-03-18; 200ms sampling).
   */
getEstimatedDeliveryExercisePrice(params: {
    instId: string;
}): Promise<EstimatedDeliveryExercisePrice[]>
⋮----
getDiscountRateAndInterestFreeQuota(params: any): Promise<any[]>
⋮----
getSystemTime(params: any): Promise<SystemTime[]>
⋮----
getHistoricalMarketData(
    params: GetHistoricalMarketDataRequest,
): Promise<MarketDataHistoryResult[]>
⋮----
getMarkPrice(params: any): Promise<any[]>
⋮----
getPositionTiers(params: any): Promise<any[]>
⋮----
getInterestRateAndLoanQuota(): Promise<InterestRateAndLoanQuota[]>
⋮----
getVIPInterestRateAndLoanQuota(params: any): Promise<any[]>
⋮----
getUnderlying(params: any): Promise<any[]>
⋮----
getInsuranceFund(params?: GetInsuranceFundRequest): Promise<InsuranceFund[]>
⋮----
getUnitConvert(params: UnitConvertRequest): Promise<UnitConvertData[]>
⋮----
getOptionTickBands(params: {
    instType: string;
    instFamily?: string;
}): Promise<any[]>
⋮----
getPremiumHistory(params: GetPremiumHistoryRequest): Promise<any[]>
⋮----
getIndexTickers(params?: {
    quoteCcy?: string;
    instId?: string;
}): Promise<IndexTicker[]>
⋮----
getIndexCandles(params: CandleRequest): Promise<CandleNoVolume[]>
⋮----
getHistoricIndexCandles(params: CandleRequest): Promise<CandleNoVolume[]>
⋮----
getMarkPriceCandles(params: CandleRequest): Promise<CandleNoVolume[]>
⋮----
getHistoricMarkPriceCandles(
    params: CandleRequest,
): Promise<CandleNoVolume[]>
⋮----
getOracle(): Promise<any[]>
⋮----
getExchangeRate(): Promise<any[]>
⋮----
getIndexComponents(params:
⋮----
getEconomicCalendar(
    params: EconomicCalendarRequest,
): Promise<EconomicCalendarData[]>
⋮----
getPublicBlockTrades(params:
⋮----
/**
   *
   * Trading statistics - REST endpoints
   *
   */
⋮----
getSupportCoin(): Promise<any[]>
⋮----
getOpenInterestHistory(
    params: GetContractOpenInterestHistoryRequest,
): Promise<any[]>
⋮----
getTakerVolume(params: {
    instType: string;
    ccy: string;
    period?: string;
    end?: string;
    begin?: string;
}): Promise<any[]>
⋮----
getContractTakerVolume(
    params: GetContractTakerVolumeRequest,
): Promise<any[]>
⋮----
getMarginLendingRatio(params: {
    ccy: string;
    begin?: numberInString;
    end?: numberInString;
    period: '5m' | '1H' | '1D';
}): Promise<any[]>
⋮----
getTopTradersAccountRatio(
    params: GetTopTradersContractLongShortRatioRequest,
): Promise<any[]>
⋮----
getTopTradersContractPositionRatio(
    params: GetTopTradersContractLongShortRatioRequest,
): Promise<any[]>
⋮----
getLongShortContractRatio(
    params: GetTopTradersContractLongShortRatioRequest,
): Promise<any[]>
⋮----
getLongShortRatio(params: {
    ccy: string;
    begin?: numberInString;
    end?: numberInString;
    period: '5m' | '1H' | '1D';
}): Promise<any[]>
⋮----
getContractsOpenInterestAndVolume(params: {
    ccy: string;
    begin?: numberInString;
    end?: numberInString;
    period: '5m' | '1H' | '1D';
}): Promise<any[]>
⋮----
getOptionsOpenInterestAndVolume(params: {
    ccy: string;
    period: '8H' | '1D';
}): Promise<any[]>
⋮----
getPutCallRatio(params: {
    ccy: string;
    period: '8H' | '1D';
}): Promise<any[]>
⋮----
getOpenInterestAndVolumeExpiry(params: {
    ccy: string;
    period: '8H' | '1D';
}): Promise<any[]>
⋮----
getOpenInterestAndVolumeStrike(params: {
    ccy: string;
    expTime: string;
    period: '8H' | '1D';
}): Promise<any[]>
⋮----
getTakerFlow(params:
⋮----
/**
   *
   * Funding account - REST endpoints
   *
   */
⋮----
getCurrencies(params?:
⋮----
getBalances(params?:
⋮----
getNonTradableAssets(params?:
⋮----
getAccountAssetValuation(params?: {
    ccy?: string;
}): Promise<AccountAssetValuation[]>
⋮----
fundsTransfer(params: FundsTransferRequest): Promise<FundTransferResult[]>
⋮----
/** Either parameter transId or clientId is required. */
getFundsTransferState(params?: {
    transId?: string;
    clientId?: string;
    type?: '0' | '1' | '2';
}): Promise<FundTransferState[]>
⋮----
/**
   * Query the billing record in the past month.
   */
getAssetBillsDetails(params?: {
    ccy?: string;
    type?: `${ASSET_BILL_TYPE}`;
    clientId?: string;
    /** Third-party custody type. Defaults to 1 (Copper) if not specified. */
    thirdPartyType?: '1' | '2' | '5' | '6';
    after?: numberInString;
    before?: numberInString;
    limit?: numberInString;
}): Promise<AssetBillDetails[]>
⋮----
/** Third-party custody type. Defaults to 1 (Copper) if not specified. */
⋮----
/**
   * Query the billing records of all time since 1 February, 2021.
   *
   *  ⚠️ IMPORTANT: Data updates occur every 30 seconds. Update frequency may vary based on data volume - please be aware of potential delays during high-traffic periods.
   *
   * Rate Limit: 1 Requests per second
   * @param params
   * @returns
   */
getAssetBillsHistoric(params?: {
    ccy?: string;
    type?: `${ASSET_BILL_TYPE}`;
    clientId?: string;
    /** Third-party custody type. Defaults to 1 (Copper) if not specified. @see 2026-06-05 changelog */
    thirdPartyType?: '1' | '2' | '5' | '6';
    after?: numberInString;
    before?: numberInString;
    limit?: numberInString;
    pagingType?: '0' | '1';
}): Promise<AssetBillDetails[]>
⋮----
/** Third-party custody type. Defaults to 1 (Copper) if not specified. @see 2026-06-05 changelog */
⋮----
getLightningDeposits(params: {
    ccy: string;
    amt: numberInString;
    to?: '6' | '18';
}): Promise<any[]>
⋮----
getDepositAddress(params:
⋮----
getDepositHistory(
    params?: GetDepositHistoryRequest,
): Promise<DepositHistory[]>
⋮----
submitWithdraw(params: WithdrawRequest): Promise<WithdrawResponse[]>
⋮----
submitWithdrawLightning(params: {
    ccy: string;
    invoice: string;
    memo?: string;
}): Promise<any[]>
⋮----
cancelWithdrawal(params:
⋮----
getWithdrawalHistory(params?: WithdrawalHistoryRequest): Promise<any[]>
⋮----
getDepositWithdrawStatus(
    params: GetDepositWithdrawStatusRequest,
): Promise<any[]>
⋮----
getExchanges(): Promise<any[]>
⋮----
applyForMonthlyStatement(params?:
⋮----
getMonthlyStatement(params:
⋮----
getConvertCurrencies(): Promise<any[]>
⋮----
getConvertCurrencyPair(params: {
    fromCcy: string;
    toCcy: string;
    /** 0: standard convert (default), 1: large order convert for VIP */
    convertMode?: '0' | '1';
}): Promise<any[]>
⋮----
/** 0: standard convert (default), 1: large order convert for VIP */
⋮----
estimateConvertQuote(params: ConvertQuoteEstimateRequest): Promise<any[]>
⋮----
convertTrade(params: ConvertTradeRequest): Promise<any[]>
⋮----
getConvertHistory(params?: any): Promise<any[]>
⋮----
/**
   *
   * Subaccount - REST endpoints
   *
   */
⋮----
/** View sub-account list */
getSubAccountList(params?: any): Promise<SubAccount[]>
⋮----
resetSubAccountAPIKey(params: {
    subAcct: string;
    apiKey: string;
    label?: string;
    perm?: string;
    ip?: string;
}): Promise<SubAccountAPIReset[]>
⋮----
getSubAccountBalances(params: {
    subAcct: string;
}): Promise<SubAccountBalances[]>
⋮----
getSubAccountFundingBalances(params: {
    subAcct: string;
    ccy?: string;
}): Promise<FundingBalance[]>
⋮----
getSubAccountMaxWithdrawal(
    params: GetSubAccountMaxWithdrawalsRequest,
): Promise<SubAccountMaxWithdrawal[]>
⋮----
/** History of sub-account transfer */
getSubAccountTransferHistory(params?: {
    ccy?: string;
    type?: '0' | '1';
    subAcct?: string;
    after?: string;
    before?: string;
    limit?: string;
}): Promise<any[]>
⋮----
getManagedSubAccountTransferHistory(
    params: GetManagedSubAccountTransferHistoryRequest,
): Promise<ManagedSubAccountTransfer[]>
⋮----
/** Master accounts manage the transfers between sub-accounts */
transferSubAccountBalance(
    params: SubAccountTransferRequest,
): Promise<SubAccountTransferResult[]>
⋮----
setSubAccountTransferOutPermission(params: {
    subAcct: string;
    canTransOut: boolean;
}): Promise<any[]>
⋮----
getSubAccountCustodyTradingList(params?: {
    subAcct?: string;
}): Promise<any[]>
⋮----
setSubAccountLoanAllocation(
    params: SetSubAccountLoanAllocationRequest,
  ): Promise<
    {
      result: boolean;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/account/subaccount/set-loan-allocation',
      params,
    );
⋮----
getSubAccountBorrowInterestAndLimit(params: {
    subAcct: string;
    ccy?: string;
}): Promise<any[]>
⋮----
/**
   *
   * Financial product - on chain earn endpoints
   *
   */
⋮----
/** Get earn offers */
getStakingOffers(params?: {
    productId?: string;
    protocolType?: 'staking' | 'defi';
    ccy?: string;
}): Promise<any[]>
⋮----
submitStake(params: {
    productId: string;
    investData: {
      ccy: string;
      amt: string;
    }[];
    term?: string;
}): Promise<any[]>
⋮----
redeemStake(params: {
    ordId: string;
    protocolType: 'staking' | 'defi';
    allowEarlyRedeem?: boolean;
}): Promise<any[]>
⋮----
cancelStakingRequest(params: {
    ordId: string;
    protocolType: 'staking' | 'defi';
}): Promise<any[]>
⋮----
/** Earn/staking get active orders */
getActiveStakingOrders(params?: {
    productId?: string;
    protocolType?: 'staking' | 'defi';
    ccy?: string;
    state?: '8' | '13' | '9' | '1' | '2';
}): Promise<any[]>
⋮----
/** Earn/staking get order history */
getStakingOrderHistory(params?: {
    productId?: string;
    protocolType?: string;
    ccy?: string;
    after?: string;
    before?: string;
    limit?: string;
}): Promise<any[]>
⋮----
/**
   *
   * Financial product - ETH staking endpoints
   *
   */
⋮----
getETHStakingProductInfo(): Promise<EthStakingProductInfo[]>
⋮----
getSOLStakingProductInfo(): Promise<SolStakingProductInfo>
⋮----
purchaseETHStaking(params:
⋮----
redeemETHStaking(params:
⋮----
getETHStakingBalance(): Promise<any[]>
⋮----
getETHStakingHistory(params: {
    type?: 'purchase' | 'redeem';
    status?: 'pending' | 'success' | 'failed' | 'cancelled';
    after?: string;
    before?: string;
    limit?: string;
}): Promise<any[]>
⋮----
cancelRedeemETHStaking(params: { ordId: string }): Promise<
    {
      ordId: string;
    }[]
  > {
    return this.postPrivate(
      '/api/v5/finance/staking-defi/eth/cancel-redeem',
      params,
    );
⋮----
getAPYHistory(params:
⋮----
/**
   *
   * Financial product - simple earn flexible endpoints
   *
   */
⋮----
getSavingBalance(params?:
⋮----
savingsPurchaseRedemption(params: {
    ccy: string;
    amt: numberInString;
    side: 'purchase' | 'redempt';
    rate: numberInString;
}): Promise<any[]>
⋮----
setLendingRate(params: {
    ccy: string;
    rate: numberInString;
}): Promise<any[]>
⋮----
getLendingHistory(params?: PaginatedSymbolRequest): Promise<any[]>
⋮----
getPublicBorrowInfo(params?:
⋮----
getPublicBorrowHistory(
    params?: PaginatedSymbolRequest,
): Promise<PublicBorrowHistoryRecord[]>
⋮----
/**
   *
   * Financial product - simple earn fixed endpoints
   *
   */
⋮----
getLendingOffers(params?:
⋮----
getLendingAPYHistory(params:
⋮----
getLendingVolume(params:
⋮----
placeLendingOrder(params: LendingOrder): Promise<any[]>
⋮----
amendLendingOrder(params: LendingOrder): Promise<any[]>
⋮----
getLendingOrders(params: GetLendingOrderListRequest): Promise<any[]>
⋮----
getLendingSubOrders(params: GetLendingSubOrderListRequest): Promise<any[]>
⋮----
/**
   *
   * Financial product - Flexible loan endpoints
   *
   */
⋮----
getBorrowableCurrencies(): Promise<
    {
      borrowCcy: string;
    }[]
  > {
    return this.get('/api/v5/finance/flexible-loan/borrow-currencies');
⋮----
getCollateralAssets(
    params?: GetFlexibleLoanCollateralAssetsRequest,
): Promise<CollateralAssetsResponse[]>
⋮----
getMaxLoanAmount(params: MaxLoanRequest): Promise<MaxLoanResponse[]>
⋮----
adjustCollateral(params: AdjustCollateralRequest): Promise<[]>
⋮----
getLoanInfo(params?: GetLoanInfoRequest): Promise<LoanInfo[]>
⋮----
getLoanHistory(params?: LoanHistoryRequest): Promise<LoanHistoryItem[]>
⋮----
getAccruedInterest(
    params?: AccruedInterestRequest,
): Promise<AccruedInterestItem[]>
⋮----
/**
   *
   * Financial product — dual investment (DCD) endpoints
   * @see https://www.okx.com/docs-v5/en/ (2026-03-13 release)
   *
   */
⋮----
getDcdCurrencyPairs(): Promise<DcdCurrencyPair[]>
⋮----
getDcdProducts(params: GetDcdProductsRequest): Promise<DcdProduct[]>
⋮----
requestDcdQuote(params: RequestDcdQuoteRequest): Promise<DcdQuote[]>
⋮----
submitDcdTrade(params: SubmitDcdTradeRequest): Promise<DcdTradeResult[]>
⋮----
requestDcdRedeemQuote(
    params: RequestDcdRedeemQuoteRequest,
): Promise<DcdRedeemQuote[]>
⋮----
submitDcdRedeem(params: SubmitDcdRedeemRequest): Promise<DcdRedeemResult[]>
⋮----
getDcdOrderStatus(
    params: GetDcdOrderStatusRequest,
): Promise<DcdOrderStatus[]>
⋮----
getDcdOrderHistory(
    params?: GetDcdOrderHistoryRequest,
): Promise<DcdOrderHistoryItem[]>
⋮----
/**
   *
   * Financial product — stable rewards endpoints
   * @see https://www.okx.com/docs-v5/en/ (2026-04-24 release)
   *
   */
⋮----
getStableRewardsProductInfo(
    params: GetStableRewardsProductInfoRequest,
): Promise<StableRewardsProductInfo[]>
⋮----
requestStableRewardsQuote(
    params: RequestStableRewardsQuoteRequest,
): Promise<StableRewardsQuote[]>
⋮----
submitStableRewardsTrade(
    params: SubmitStableRewardsTradeRequest,
): Promise<StableRewardsTradeResult[]>
⋮----
getStableRewardsBalance(
    params?: GetStableRewardsBalanceRequest,
): Promise<StableRewardsBalance[]>
⋮----
getStableRewardsApyHistory(
    params: GetStableRewardsApyHistoryRequest,
): Promise<StableRewardsApyHistoryItem[]>
⋮----
getStableRewardsSubscribeRedeemHistory(
    params: GetStableRewardsSubscribeRedeemHistoryRequest,
): Promise<StableRewardsSubscribeRedeemHistoryItem[]>
⋮----
/**
   *
   * Affiliate endpoints
   * @see https://www.okx.com/docs-v5/en/ (2026-05-08 release)
   *
   */
⋮----
getAffiliatePerformanceSummary(
    params?: GetAffiliatePerformanceSummaryRequest,
): Promise<AffiliatePerformanceSummary[]>
⋮----
getInviteeDetail(params: GetInviteeDetailRequest): Promise<InviteeDetail[]>
⋮----
getAffiliateInviteeList(
    params?: GetAffiliateInviteeListRequest,
): Promise<AffiliateInviteeListItem[]>
⋮----
getAffiliateLinkList(
    params?: GetAffiliateLinkListRequest,
): Promise<AffiliateLinkListItem[]>
⋮----
getAffiliateCoInviterLinkList(
    params?: GetAffiliateCoInviterLinkListRequest,
): Promise<AffiliateCoInviterLinkListItem[]>
⋮----
getAffiliateSubAffiliateList(
    params?: GetAffiliateSubAffiliateListRequest,
): Promise<AffiliateSubAffiliateListItem[]>
⋮----
getAffiliateRebateInfo(params:
⋮----
/**
   *
   * Status endpoints (public)
   *
   */
⋮----
getSystemStatus(params: {
    state?: 'scheduled' | 'ongoing' | 'pre_open' | 'completed' | 'canceled';
}): Promise<any[]>
⋮----
/**
   *
   * Announcement endpoints
   *
   */
⋮----
getAnnouncements(params?: { annType?: string; page?: string }): Promise<
    {
      totalPage: string;
      details: Announcement[];
    }[]
  > {
    return this.get('/api/v5/support/announcements', params);
⋮----
getAnnouncementTypes(): Promise<
    {
      annType: string;
      annTypeDesc: string;
    }[]
  > {
    return this.get('/api/v5/support/announcement-types');
⋮----
/**
   *
   * Broker endpoints (private)
   *
   */
⋮----
createSubAccount(params: {
    subAcct: string;
    label?: string;
    clientIP?: string;
    mainAcct: string;
}): Promise<any[]>
⋮----
deleteSubAccount(params:
⋮----
createSubAccountAPIKey(params: {
    subAcct: string;
    label: string;
    passphrase: string;
    ip?: string;
    perm?: string;
}): Promise<any[]>

================
File: README.md
================
# Node.js & Typescript OKX (OKEX) API & WebSocket SDK

[![E2E Tests](https://github.com/tiagosiebler/okx-api/actions/workflows/e2etest.yml/badge.svg?branch=master)](https://github.com/tiagosiebler/okx-api/actions/workflows/e2etest.yml)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/tiagosiebler/okx-api)
[![npm downloads](https://img.shields.io/npm/dt/okx-api)][1]
[![npm version](https://img.shields.io/npm/v/okx-api)][1]
[![npm size](https://img.shields.io/bundlephobia/min/okx-api/latest)][1]
[![last commit](https://img.shields.io/github/last-commit/tiagosiebler/okx-api)][1]
[![CodeFactor](https://www.codefactor.io/repository/github/tiagosiebler/okx-api/badge)](https://www.codefactor.io/repository/github/tiagosiebler/okx-api)

<p align="center">
  <a href="https://www.npmjs.com/package/okx-api">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tiagosiebler/okx-api/blob/master/docs/images/logoDarkMode2.svg?raw=true#gh-dark-mode-only">
      <img alt="SDK Logo" src="https://github.com/tiagosiebler/okx-api/blob/master/docs/images/logoBrightMode2.svg?raw=true#gh-light-mode-only">
    </picture>
  </a>
</p>

[1]: https://www.npmjs.com/package/okx-api

> [!TIP]
> Upcoming change: As part of the [Siebly.io](https://siebly.io/?ref=ghokx) brand, this SDK will soon be hosted under the [Siebly.io GitHub organisation](https://github.com/sieblyio). The migration is seamless and requires no user changes.

Complete, updated & performant Node.js SDK for the OKX(OKEX) APIs and WebSockets:

- Complete integration with OKX REST APIs, WebSockets & WebSocket APIs.
- TypeScript support (with type declarations for most API requests & responses).
- Over 100 end-to-end tests making real API calls & WebSocket connections, validating any changes before they reach npm.
- Supports all available OKX regions:
  - OKX Global (www.okx.com), by default.
  - OKX EEA (my.okx.com), by setting `market: 'EEA'`.
  - OKX US (app.okx.com), by setting `market: 'US'`.
- Actively maintained with a modern, promise-driven interface.
- Robust WebSocket integration
  - Configurable connection heartbeats (automatically detect failing connections).
  - Automatic reconnect then resubscribe workflows.
  - Automatic authentication and heartbeat handling.
- Supports WebSocket API in all supported regions & product groups:
  - Use the WebsocketClient's event-driven `sendWSAPIRequest()` method, or;
  - Use the WebsocketAPIClient for a REST-like experience.
    - Use the WebSocket API like a REST API!
    - Automatic routing to business vs private WebSocket endpoints.
    - End to end types.
    - See [examples/ws-api-client.ts](./examples/ws-api-client.ts) for a demonstration.
- Browser support (via webpack bundle - see "Browser Usage" below).
- QuickStart Guide: https://siebly.io/sdk/okx/javascript

## Table of Contents

- [Installation](#installation)
- [Issues & Discussion](#issues--discussion)
- [Related Projects](#related-projects)
- [Documentation](#documentation)
- [Contributions & Thanks](#contributions--thanks)
- [Structure](#structure)
- [Usage](#usage)
  - [REST Client](#rest-client)
    - [Requests & Responses](#requests--responses)
    - [Example](#example)
  - [WebSockets](#websockets)
    - [Sending Orders via WebSockets](#sending-orders-via-websockets)
    - [Receiving Realtime Data](#receiving-realtime-data)
    - [Public Events](#public-events)
    - [Private Events](#private-events)
- [Browser/Frontend Usage](#browserfrontend-usage)
  - [Import](#import)
  - [Webpack](#webpack)
- [Use with LLMs & AI](#use-with-llms--ai)
- [Contributions & Pull Requests](#contributions--pull-requests)
- [Used By](#used-by)
- [Star History](#star-history)

## Installation

```bash
npm install okx-api
```

## Issues & Discussion

- Issues? Check the [issues tab](https://github.com/tiagosiebler/okx-api/issues).
- Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram.
- Follow our announcement channel for real-time updates on [X/Twitter](https://x.com/sieblyio)

<!-- template_related_projects -->

## Related Projects

Check out our JavaScript/TypeScript/Node.js SDKs & Projects:

- Visit our website: [https://Siebly.io](https://siebly.io/?ref=gh)
- Try our REST API & WebSocket SDKs published on npmjs:
  - [Bybit Node.js SDK: bybit-api](https://www.npmjs.com/package/bybit-api)
  - [Kraken Node.js SDK: @siebly/kraken-api](https://www.npmjs.com/package/@siebly/kraken-api)
  - [OKX Node.js SDK: okx-api](https://www.npmjs.com/package/okx-api)
  - [Binance Node.js SDK: binance](https://www.npmjs.com/package/binance)
  - [Gate (gate.com) Node.js SDK: gateio-api](https://www.npmjs.com/package/gateio-api)
  - [Bitget Node.js SDK: bitget-api](https://www.npmjs.com/package/bitget-api)
  - [Kucoin Node.js SDK: kucoin-api](https://www.npmjs.com/package/kucoin-api)
  - [Coinbase Node.js SDK: coinbase-api](https://www.npmjs.com/package/coinbase-api)
  - [Bitmart Node.js SDK: bitmart-api](https://www.npmjs.com/package/bitmart-api)
- Try my misc utilities:
  - [OrderBooks Node.js: orderbooks](https://www.npmjs.com/package/orderbooks)
  - [Crypto Exchange Account State Cache: accountstate](https://www.npmjs.com/package/accountstate)
- Check out my examples:
  - [awesome-crypto-examples Node.js](https://github.com/tiagosiebler/awesome-crypto-examples)
  <!-- template_related_projects_end -->

## Documentation

Most methods accept JS objects. These can be populated using parameters specified by okx's API documentation, or check the type definition in the rest-client class methods.

- [RestClient](src/rest-client.ts)
- [OKX API Documentation](https://www.okx.com/docs-v5/en/#rest-api)
- [REST Endpoint Function List](./docs/endpointFunctionList.md)

## Contributions & Thanks

Support my efforts to make algo trading accessible to all - register with my referral links:

- [Bybit](https://www.bybit.com/en-US/register?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
- [Binance](https://www.binance.com/en/register?ref=20983262)
- [OKX](https://www.okx.com/join/18504944)

For more ways to give thanks & support my efforts, visit [Contributions & Thanks](https://github.com/tiagosiebler/awesome-crypto-examples/wiki/Contributions-&-Thanks)!

## Structure

This project uses typescript. Resources are stored in 3 key structures:

- [src](./src) - the whole connector written in typescript
- [lib](./lib) - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release. This is also the version published to npm.
- [dist](./dist) - the packed bundle of the project for use in browser environments (manual, using webpack).
- [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome!

---

## Usage

Create API credentials at okx

- [OKX/account/API](https://www.okx.com/account/my-api)

## REST Client

### Requests & Responses

- If your IDE doesn't have IntelliSense, check the [rest-client.ts](./src/rest-client.ts) for a list of methods, params & return types.
- Requests follow the same ordering and format as the categories in the [API docs](https://www.okx.com/docs-v5/en/#rest-api).
- Responses are parsed automatically for less nesting. Error responses are thrown in full:
  - If the response looks successful (HTTP 200 and "code" in the response body === "0"), only the `data` property is directly (without the `code`, `data` & `msg` properties).
  - If the response looks like an error (HTTP error OR the "code" property in the response does not equal "0"), the full response is thrown (including `code` and `msg` properties). See the interface for [APIResponse<T>](./src/types/rest/shared.ts).

### Example

```ts
import { RestClient } from 'okx-api';

const client = new RestClient({
  apiKey: 'apiKeyHere',
  apiSecret: 'apiSecretHere',
  apiPass: 'apiPassHere',
  // For Global users (www.okx.com), you don't need to set the market.
  // It will use global by default.
  // Not needed: market: 'GLOBAL',

  // For EEA users (my.okx.com), set market to "EEA":
  // market: 'EEA',

  // For US users (app.okx.com), set market to "US":
  // market: 'US',
});

// Submit a buy and sell market order
(async () => {
  try {
    const allBalances = await client.getBalance();
    console.log('All balances: ', allBalances);

    const buyResult = await client.submitOrder({
      instId: 'BTC-USDT',
      ordType: 'market',
      side: 'buy',
      sz: '0.1',
      tdMode: 'cash',
      tgtCcy: 'base_ccy',
    });
    console.log('buy order result: ', buyResult);

    const sellResult = await client.submitOrder({
      instId: 'BTC-USDT',
      ordType: 'market',
      side: 'sell',
      sz: '0.1',
      tdMode: 'cash',
      tgtCcy: 'base_ccy',
    });
    console.log('Sell order result: ', sellResult);
  } catch (e) {
    console.error('request failed: ', e);
  }
})();
```

## WebSockets

This connector includes a high-performance Node.js, TypeScript & JavaScript WebSocket client for the OKX public & private WebSocket, including the OKX WebSocket API for order placement. API credentials are optional unless private streams will be used (such as account order updates).

- If your IDE doesn't have IntelliSense, check the [websocket-client.ts](./src/websocket-client.ts) for a list of methods, params & return types.
- When subscribing to channels, only the "args" should be passed as an object or array when calling the websocket client subcribe() function: [API docs](https://www.okx.com/docs-v5/en/#websocket-api-subscribe).
- TypeScript recommended (but it is not required) for a richer experience:
  ![typescript-subscribe](./docs/images/subscribe-with-typescript.gif)
- The ws client will automatically open connections as needed when subscribing to a channel.
- If the connection is lost for any reason, the ws client will detect this (via the connection heartbeats). It will then:
  - Automatically teardown the dead connection.
  - Automatically respawn a fresh connection.
  - Automatically reauthenticate, if using private channels.
  - Automatically resubscribe to previously subscribed topics.
  - Resume producing events as before, without extra handling needed in your logic.
- The ws client will automatically authenticate if accounts are provided and a private channel is subscribed to.
- Up to 100 accounts are supported on the private connection, as per the [API docs](https://www.okx.com/docs-v5/en/#websocket-api-login). Authentication is automatic if accounts are provided.
- For examples in using the websocket client, check the examples in the repo:
  - Private channels (account data): [examples/ws-private.ts](./examples/ws-private.ts)
  - Public chanels (market data): [examples/ws-public.ts](./examples/ws-public.ts)
  - These examples are written in TypeScript, so can be executed with ts-node for easy testing:
    `ts-node examples/ws-private.ts`
  - Or convert them to javascript:
    - Change the `import { ... } from 'okx-api'` to `const { ... } = require('okx-api');`
    - Rename the file to `ws-private.js`
    - And execute with node: `node examples/ws-private.js`

### Sending orders via WebSockets

OKX supports some order management capabilities via a persisted WebSocket connection. This SDK supports this with two convenient approaches.

The recommended route is to use the dedicated WebsocketAPIClient class, included with this SDK:

- Dedicated functions for every available WebSocket API operation
- Fully typed requests and responses
- Asynchronous promisified wrapper around WS API commands.

It looks & feels like a REST API client, but uses WebSockets, via the WebsocketClient's sendWSAPIRequest method (which you can use directly if you prefer).

A simple example is below but for a more thorough example, check the example here: [./examples/ws-api-client.ts](./examples/ws-api-client.ts).

```typescript
import { WebsocketAPIClient } from 'okx-api';
// or if you prefer require:
// const { WebsocketAPIClient } = require("okx-api");

// For private events, all 3 of the following are required (per account):
const API_KEY = process.env.API_KEY_COM;
const API_SECRET = process.env.API_SECRET_COM;
const API_PASSPHRASE = process.env.API_PASSPHRASE_COM;

// If running from CLI in unix, you can pass env vars as such:
// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/ws-private.ts

const wsClient = new WebsocketAPIClient({
  // For Global users (www.okx.com), you don't need to set the market.
  // It will use global by default.
  // Not needed: market: 'GLOBAL',

  // For EEA users (my.okx.com), set market to "EEA":
  // market: 'EEA',

  // For US users (app.okx.com), set market to "US":
  // market: 'US',

  accounts: [
    {
      apiKey: API_KEY,
      apiSecret: API_SECRET,
      apiPass: API_PASSPHRASE,
    },
  ],
});

async function start() {
  // Optional: prepare the WebSocket API connection in advance.
  // This happens automatically but you can do this early before making any API calls, to prevent delays from a cold start.
  // await wsClient.connectWSAPI();

  /**
   * OKX's WebSocket API be used like a REST API, through this SDK's WebsocketAPIClient. The WebsocketAPIClient is a utility class wrapped around WebsocketClient's sendWSAPIRequest() capabilities.
   *
   * Each request sent via the WebsocketAPIClient will automatically:
   * - route via the active WS API connection
   * - return a Promise, which automatically resolves/rejects when a matching response is received
   */

  /**
   * Place Order
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-order
   */
  try {
    const res = await wsClient.submitNewOrder({
      instId: 'BTC-USDT',
      tdMode: 'cash',
      side: 'buy',
      ordType: 'market',
      sz: '100',
    });
    /**
      const res = {
        id: '2',
        op: 'order',
        code: '1',
        msg: '',
        data: [
          {
            tag: '159881cb7207BCDE',
            ts: '1753714603721',
            ordId: '',
            clOrdId: '',
            sCode: '51008',
            sMsg: 'Order failed. Insufficient USDT balance in account.'
          }
        ],
        inTime: '1753714603720755',
        outTime: '1753714603721942',
        wsKey: 'prodPrivate',
        isWSAPIResponse: false
      }

      const res =  {
        id: '2',
        op: 'order',
        code: '1',
        msg: '',
        data: [
          {
            tag: '159881cb7207BCDE',
            ts: '1753714567149',
            ordId: '',
            clOrdId: '',
            sCode: '51010',
            sMsg: "You can't complete this request under your current account mode."
          }
        ],
        inTime: '1753714567149196',
        outTime: '1753714567149913',
        wsKey: 'prodPrivate',
        isWSAPIResponse: false
      }
     */

    console.log(new Date(), 'WS API "submitNewOrder()" result: ', res);
  } catch (e) {
    console.error(new Date(), 'Exception with WS API "submitNewOrder()": ', e);
  }

  /**
   * Submit multiple orders in a batch
   * https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-place-multiple-orders
   */
  try {
    const res = await wsClient.submitMultipleOrders([
      {
        instId: 'BTC-USDT',
        tdMode: 'cash',
        side: 'buy',
        ordType: 'market',
        sz: '100',
      },
      {
        instId: 'BTC-USDT',
        tdMode: 'cash',
        side: 'buy',
        ordType: 'market',
        sz: '50',
      },
    ]);
    console.log(new Date(), 'WS API "submitMultipleOrders()" result: ', res);
  } catch (e) {
    console.error(
      new Date(),
      'Exception with WS API "submitMultipleOrders()": ',
      e,
    );
  }
}

start();
```

### Receiving realtime data

The below example demonstrates connecting as a consumer, to receive WebSocket events from OKX, using the included WebsocketClient:

```javascript
import { WebsocketClient } from 'okx-api';
// or if you prefer require:
// const { WebsocketClient } = require("okx-api");

// For private events, all 3 of the following are required (per account):
const API_KEY = process.env.API_KEY_COM;
const API_SECRET = process.env.API_SECRET_COM;
const API_PASSPHRASE = process.env.API_PASSPHRASE_COM;

// If running from CLI in unix, you can pass env vars as such:
// API_KEY_COM='lkm12n3-2ba3-1mxf-fn13-lkm12n3a' API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/ws-private.ts

// Note the single quotes, preventing special characters such as $ from being incorrectly passed

const wsClient = new WebsocketClient({
  // For Global users (www.okx.com), you don't need to set the market.
  // It will use global by default.
  // Not needed: market: 'GLOBAL',

  // For EEA users (my.okx.com), set market to "EEA":
  // market: 'EEA',

  // For US users (app.okx.com), set market to "US":
  // market: 'US',

  accounts: [
    // For private topics, include one or more accounts in an array. Otherwise only public topics will work
    {
      apiKey: API_KEY,
      apiSecret: API_SECRET,
      apiPass: API_PASSPHRASE,
    },
    // {
    //   apiKey: 'yourApiKeyHere',
    //   apiSecret: 'yourApiSecretHere',
    //   apiPass: 'yourApiPassHere',
    // },
    // {
    //   apiKey: 'anotherAccountKey',
    //   apiSecret: 'anotherAccountSecret',
    //   apiPass: 'anotherAccountPass',
    // },
  ],
});

// Raw data will arrive on the 'update' event
wsClient.on('update', (data) => {
  console.log('ws update (raw data received)', JSON.stringify(data));
});

wsClient.on('open', (data) => {
  console.log('connection opened open:', data.wsKey);
});

// Replies (e.g. authenticating or subscribing to channels) will arrive on the 'response' event
wsClient.on('response', (data) => {
  // console.log('ws response: ', JSON.stringify(data, null, 2));
  console.log('ws response: ', JSON.stringify(data));
});

wsClient.on('reconnect', ({ wsKey }) => {
  console.log('ws automatically reconnecting.... ', wsKey);
});
wsClient.on('reconnected', (data) => {
  console.log('ws has reconnected ', data?.wsKey);
});
wsClient.on('exception', (data) => {
  console.error('ws exception: ', data);
});

/**
 * Simply call subscribe to request the channels that you're interested in.
 *
 * If authentication is required, the WSClient will automatically authenticate with the available credentials.
 */

// Subscribe one event at a time:
wsClient.subscribe({
  channel: 'account',
});

// OR, combine multiple subscription events into one request using an array instead of an object:
wsClient.subscribe([
  {
    channel: 'account',
  },
  {
    channel: 'positions',
    instType: 'ANY',
  },
]);

// Public topics, for comparison. These do not require authentication / api keys:
wsClient.subscribe([
  {
    channel: 'instruments',
    instType: 'SPOT',
  },
  {
    channel: 'instruments',
    instType: 'FUTURES',
  },
  {
    channel: 'tickers',
    instId: 'LTC-BTC',
  },
]);
```

#### Public Events

See [examples/ws-public.ts](./examples/ws-public.ts) for a full example:

![typescript-events-public](./docs/images/subscribe-events-public.gif)

#### Private Events

See [examples/ws-private.ts](./examples/ws-private.ts) for a full example:

![typescript-events](./docs/images/subscribe-events.gif)

## Browser/Frontend Usage

### Import

This is the "modern" way, allowing the package to be directly imported into frontend projects with full typescript support.

1. Install these dependencies
   ```sh
   npm install crypto-browserify stream-browserify
   ```
2. Add this to your `tsconfig.json`
   ```json
   {
     "compilerOptions": {
       "paths": {
         "crypto": [
           "./node_modules/crypto-browserify"
         ],
         "stream": [
           "./node_modules/stream-browserify"
         ]
   }
   ```
3. Declare this in the global context of your application (ex: in polyfills for angular)
   ```js
   (window as any).global = window;
   ```

### Webpack

This is the "old" way of using this package on webpages. This will build a minified js bundle that can be pulled in using a script tag on a website.

Build a bundle using webpack:

- `npm install`
- `npm build`
- `npm pack`

The bundle can be found in `dist/`. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO.

## Use with LLMs & AI

This SDK includes a bundled `llms.txt` file in the root of the repository. If you're developing with LLMs, use the included `llms.txt` with your LLM - it will significantly improve the LLMs understanding of how to correctly use this SDK.

This file contains AI optimised structure of all the functions in this package, and their parameters for easier use with any learning models or artificial intelligence.

---

<!-- template_contributions -->

### Contributions & Thanks

Have my projects helped you? Share the love, there are many ways you can show your thanks:

- Star & share my projects.
- Are my projects useful? Sponsor me on Github and support my effort to maintain & improve them: https://github.com/sponsors/tiagosiebler
- Have an interesting project? Get in touch & invite me to it.
- Or buy me all the coffee:
  - ETH(ERC20): `0xA3Bda8BecaB4DCdA539Dc16F9C54a592553Be06C` <!-- metamask -->
- Sign up with my referral links:
  - OKX (receive a 20% fee discount!): https://www.okx.com/join/42013004
  - Binance (receive a 20% fee discount!): https://accounts.binance.com/register?ref=OKFFGIJJ
  - HyperLiquid (receive a 4% fee discount!): https://app.hyperliquid.xyz/join/SDK
  - Gate: https://www.gate.io/signup/NODESDKS?ref_type=103

<!---
old ones:
  - BTC: `1C6GWZL1XW3jrjpPTS863XtZiXL1aTK7Jk`
  - BTC(SegWit): `bc1ql64wr9z3khp2gy7dqlmqw7cp6h0lcusz0zjtls`
  - ETH(ERC20): `0xe0bbbc805e0e83341fadc210d6202f4022e50992`
  - USDT(TRC20): `TA18VUywcNEM9ahh3TTWF3sFpt9rkLnnQa
  - gate: https://www.gate.io/signup/AVNNU1WK?ref_type=103

-->
<!-- template_contributions_end -->

## Contributions & Pull Requests

Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.

## Used By

The following represents some of the known public projects that use this SDK on GitHub:

[![Repository Users Preview Image](https://dependents.info/tiagosiebler/okx-api/image)](https://github.com/tiagosiebler/okx-api/network/dependents)

<!-- template_star_history -->

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=tiagosiebler/bybit-api,tiagosiebler/okx-api,tiagosiebler/binance,tiagosiebler/bitget-api,tiagosiebler/bitmart-api,tiagosiebler/gateio-api,tiagosiebler/kucoin-api,tiagosiebler/coinbase-api,tiagosiebler/orderbooks,tiagosiebler/accountstate,tiagosiebler/awesome-crypto-examples&type=Date)](https://star-history.com/#tiagosiebler/bybit-api&tiagosiebler/okx-api&tiagosiebler/binance&tiagosiebler/bitget-api&tiagosiebler/bitmart-api&tiagosiebler/gateio-api&tiagosiebler/kucoin-api&tiagosiebler/coinbase-api&tiagosiebler/orderbooks&tiagosiebler/accountstate&tiagosiebler/awesome-crypto-examples&Date)

<!-- template_star_history_end -->

================
File: package.json
================
{
  "name": "okx-api",
  "version": "3.1.6",
  "description": "Complete Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests",
  "scripts": {
    "test": "jest",
    "test:public": "jest --testPathIgnorePatterns='.*private.*'",
    "test:private": "jest --testPathPattern='.*private.*'",
    "test:watch": "jest --watch",
    "clean": "rm -rf lib dist",
    "build": "npm run clean && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && bash ./postBuild.sh",
    "build:clean": "npm run clean && npm run build",
    "build:watch": "npm run clean && tsc --watch",
    "pack": "webpack --config webpack/webpack.config.cjs",
    "lint": "eslint src",
    "prepublish": "npm run build:clean",
    "betapublish": "npm publish --tag beta"
  },
  "main": "dist/cjs/index.js",
  "module": "dist/mjs/index.js",
  "types": "dist/mjs/index.d.ts",
  "exports": {
    ".": {
      "import": "./dist/mjs/index.js",
      "require": "./dist/cjs/index.js",
      "types": "./dist/mjs/index.d.ts"
    }
  },
  "files": [
    "dist/*",
    "llms.txt"
  ],
  "type": "module",
  "author": "Tiago Siebler (https://siebly.io)",
  "contributors": [],
  "dependencies": {
    "axios": "^1.13.2",
    "isomorphic-ws": "^5.0.0",
    "ws": "^8.18.3"
  },
  "devDependencies": {
    "@types/jest": "^29.5.11",
    "@types/node": "^22.17.2",
    "@types/ws": "^8.18.1",
    "@typescript-eslint/eslint-plugin": "^8.18.0",
    "@typescript-eslint/parser": "^8.18.0",
    "eslint": "^8.24.0",
    "eslint-config-prettier": "^9.1.0",
    "eslint-plugin-prettier": "^5.2.1",
    "eslint-plugin-require-extensions": "^0.1.3",
    "eslint-plugin-simple-import-sort": "^12.1.1",
    "jest": "^29.7.0",
    "ts-jest": "^29.1.2",
    "ts-node": "^10.9.2",
    "typescript": "^5.7.3",
    "source-map-loader": "^4.0.0",
    "ts-loader": "^9.5.4",
    "webpack": "^5.74.0",
    "webpack-bundle-analyzer": "^4.6.1",
    "webpack-cli": "^4.10.0"
  },  
  "keywords": [
    "okx",
    "okx api",
    "okex",
    "okex api",
    "api",
    "websocket",
    "okx websocket api",
    "okx websocket api javascript",
    "okx ws api",
    "rest",
    "rest api",
    "usdt",
    "trading bots",
    "nodejs",
    "node",
    "trading",
    "cryptocurrency",
    "bitcoin",
    "best"
  ],
  "funding": {
    "type": "individual",
    "url": "https://github.com/sponsors/tiagosiebler"
  },
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "https://github.com/tiagosiebler/okx-api"
  },
  "bugs": {
    "url": "https://github.com/tiagosiebler/okx-api/issues"
  },
  "homepage": "https://github.com/tiagosiebler/okx-api#readme"
}





================================================================
End of Codebase
================================================================