Class ExchangeAbstract

constructor

• new Exchange(): Exchange

  Returns Exchange

Abstract Readonlyname

Abstract Readonlytestnet

Abstractinitialize

• initialize(credentials: ExchangeCredentials): void

  Initialize the exchange with credentials

  Parameters

  • credentials: ExchangeCredentials

    API credentials for the exchange

  Returns void

AbstractverifyCredentials

• verifyCredentials(): Promise<boolean>

  Verify that the API credentials are valid

  Returns Promise<boolean>

  True if credentials are valid

AbstractgetBalances

• getBalances(asset?: string): Promise<ExchangeBalance[]>

  Get account balances

  Parameters

  • Optionalasset: string

    Optional specific asset to get balance for

  Returns Promise<ExchangeBalance[]>

  Array of balances, or single balance if asset specified

AbstractgetPrice

• getPrice(symbol: string): Promise<ExchangePrice>

  Get current price for a trading pair

  Parameters

  • symbol: string

    The trading pair symbol (e.g., "BTCUSDT")

  Returns Promise<ExchangePrice>

  Current price information

AbstractgetSymbols

• getSymbols(): Promise<string[]>

  Get all available trading pairs

  Returns Promise<string[]>

  Array of trading pair symbols

AbstractmarketBuy

• marketBuy(
      symbol: string,
      quantity: number,
      quantityIsQuote?: boolean,
  ): Promise<ExchangeOrder>

  Place a market buy order

  Parameters

  • symbol: string

    Trading pair symbol (e.g., "ETHUSDT")

  • quantity: number

    Amount to buy (in base asset or quote asset depending on quantityIsQuote)

  • OptionalquantityIsQuote: boolean

    If true, quantity is in quote currency (e.g., USDT)

  Returns Promise<ExchangeOrder>

  The created order

AbstractmarketSell

• marketSell(symbol: string, quantity: number): Promise<ExchangeOrder>

  Place a market sell order

  Parameters

  • symbol: string

    Trading pair symbol (e.g., "ETHUSDT")

  • quantity: number

    Amount to sell (in base asset)

  Returns Promise<ExchangeOrder>

  The created order

AbstractlimitBuy

• limitBuy(
      symbol: string,
      quantity: number,
      price: number,
  ): Promise<ExchangeOrder>

  Place a limit buy order

  Parameters

  • symbol: string

    Trading pair symbol (e.g., "ETHUSDT")

  • quantity: number

    Amount to buy (in base asset)

  • price: number

    Limit price

  Returns Promise<ExchangeOrder>

  The created order

AbstractlimitSell

• limitSell(
      symbol: string,
      quantity: number,
      price: number,
  ): Promise<ExchangeOrder>

  Place a limit sell order

  Parameters

  • symbol: string

    Trading pair symbol (e.g., "ETHUSDT")

  • quantity: number

    Amount to sell (in base asset)

  • price: number

    Limit price

  Returns Promise<ExchangeOrder>

  The created order

AbstractstopLoss

• stopLoss(
      symbol: string,
      quantity: number,
      stopPrice: number,
      limitPrice?: number,
  ): Promise<ExchangeOrder>

  Place a stop loss order

  Parameters

  • symbol: string

    Trading pair symbol (e.g., "ETHUSDT")

  • quantity: number

    Amount to sell (in base asset)

  • stopPrice: number

    Price at which to trigger the stop loss

  • OptionallimitPrice: number

    Optional limit price (if not provided, uses stopPrice)

  Returns Promise<ExchangeOrder>

  The created order

AbstracttakeProfit

• takeProfit(
      symbol: string,
      quantity: number,
      price: number,
      limitPrice?: number,
  ): Promise<ExchangeOrder>

  Place a take profit order

  Parameters

  • symbol: string

    Trading pair symbol (e.g., "ETHUSDT")

  • quantity: number

    Amount to sell (in base asset)

  • price: number

    Price at which to take profit

  • OptionallimitPrice: number

    Optional limit price (if not provided, uses price)

  Returns Promise<ExchangeOrder>

  The created order

AbstractcancelOrder

• cancelOrder(orderId: string, symbol: string): Promise<boolean>

  Cancel an existing order

  Parameters

  • orderId: string

    The order ID to cancel

  • symbol: string

    The trading pair symbol

  Returns Promise<boolean>

  True if cancellation was successful

AbstractgetOrder

• getOrder(orderId: string, symbol: string): Promise<ExchangeOrder>

  Get order status

  Parameters

  • orderId: string

    The order ID to check

  • symbol: string

    The trading pair symbol

  Returns Promise<ExchangeOrder>

  The order details

AbstractgetOpenOrders

• getOpenOrders(symbol?: string): Promise<ExchangeOrder[]>

  Get open orders

  Parameters

  • Optionalsymbol: string

    Optional symbol to filter by

  Returns Promise<ExchangeOrder[]>

  Array of open orders

formatSymbol

• formatSymbol(asset: string, quoteAsset?: string): string

  Format an asset to a trading symbol

  Parameters

  • asset: string

    The base asset (e.g., "ETH")

  • quoteAsset: string = "USDT"

    The quote asset (default: "USDT")

  Returns string

  Formatted symbol (e.g., "ETHUSDT")

parseSymbol

• parseSymbol(symbol: string): { base: string; quote: string }

  Parse a symbol into base and quote assets

  Parameters

  • symbol: string

    The trading pair symbol

  Returns { base: string; quote: string }

  Object with base and quote assets