Class BinanceExchange

Binance exchange implementation using the official binance npm package

Hierarchy (View Summary)

Exchange
- BinanceExchange

Index

Constructors

constructor

new BinanceExchange(): BinanceExchange
Returns BinanceExchange
Inherited from Exchange.constructor

Properties

`Readonly`name

name: "binance" = ...

The name of the exchange

`Readonly`testnet

testnet: false

Whether the exchange is connected to testnet

Methods

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")
Inherited from Exchange.formatSymbol
- Defined in packages/trading/src/exchanges/base.ts:151

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
Inherited from Exchange.parseSymbol
- Defined in packages/trading/src/exchanges/base.ts:160

initialize

initialize(credentials: ExchangeCredentials): void
Initialize the Binance exchange with API credentials
Parameters
- credentials: ExchangeCredentials
  API key and secret
Returns void
Overrides Exchange.initialize
- Defined in packages/trading/src/exchanges/binance.ts:19

verifyCredentials

verifyCredentials(): Promise<boolean>
Verify that the API credentials are valid by fetching account info

Returns Promise<boolean>
True if credentials are valid
Overrides Exchange.verifyCredentials
- Defined in packages/trading/src/exchanges/binance.ts:30

getBalances

getBalances(asset?: string): Promise<ExchangeBalance[]>
Get account balances
Parameters
- Optionalasset: string
  Optional specific asset to filter
Returns Promise<ExchangeBalance[]>
Array of balances
Overrides Exchange.getBalances
- Defined in packages/trading/src/exchanges/binance.ts:48

getPrice

getPrice(symbol: string): Promise<ExchangePrice>
Get current price for a trading pair
Parameters
- symbol: string
  Trading pair symbol (e.g., "BTCUSDT")
Returns Promise<ExchangePrice>
Current price information
Overrides Exchange.getPrice
- Defined in packages/trading/src/exchanges/binance.ts:80

getSymbols

getSymbols(): Promise<string[]>
Get all available trading pairs

Returns Promise<string[]>
Array of trading pair symbols
Overrides Exchange.getSymbols
- Defined in packages/trading/src/exchanges/binance.ts:105

marketBuy

marketBuy(
    symbol: string,
    quantity: number,
    quantityIsQuote?: boolean,
): Promise<ExchangeOrder>
Place a market buy order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to buy
- quantityIsQuote: boolean = false
  If true, quantity is in quote currency
Returns Promise<ExchangeOrder>
The created order
Overrides Exchange.marketBuy
- Defined in packages/trading/src/exchanges/binance.ts:121

marketSell

marketSell(symbol: string, quantity: number): Promise<ExchangeOrder>
Place a market sell order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to sell
Returns Promise<ExchangeOrder>
The created order
Overrides Exchange.marketSell
- Defined in packages/trading/src/exchanges/binance.ts:149

limitBuy

limitBuy(
    symbol: string,
    quantity: number,
    price: number,
): Promise<ExchangeOrder>
Place a limit buy order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to buy
- price: number
  Limit price
Returns Promise<ExchangeOrder>
The created order
Overrides Exchange.limitBuy
- Defined in packages/trading/src/exchanges/binance.ts:171

limitSell

limitSell(
    symbol: string,
    quantity: number,
    price: number,
): Promise<ExchangeOrder>
Place a limit sell order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to sell
- price: number
  Limit price
Returns Promise<ExchangeOrder>
The created order
Overrides Exchange.limitSell
- Defined in packages/trading/src/exchanges/binance.ts:195

stopLoss

stopLoss(
    symbol: string,
    quantity: number,
    stopPrice: number,
    limitPrice?: number,
): Promise<ExchangeOrder>
Place a stop loss order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to sell
- stopPrice: number
  Stop trigger price
- OptionallimitPrice: number
  Optional limit price
Returns Promise<ExchangeOrder>
The created order
Overrides Exchange.stopLoss
- Defined in packages/trading/src/exchanges/binance.ts:220

takeProfit

takeProfit(
    symbol: string,
    quantity: number,
    price: number,
    limitPrice?: number,
): Promise<ExchangeOrder>
Place a take profit order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to sell
- price: number
  Take profit trigger price
- OptionallimitPrice: number
  Optional limit price
Returns Promise<ExchangeOrder>
The created order
Overrides Exchange.takeProfit
- Defined in packages/trading/src/exchanges/binance.ts:246

cancelOrder

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
Overrides Exchange.cancelOrder
- Defined in packages/trading/src/exchanges/binance.ts:270

getOrder

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
Overrides Exchange.getOrder
- Defined in packages/trading/src/exchanges/binance.ts:292

getOpenOrders

getOpenOrders(symbol?: string): Promise<ExchangeOrder[]>
Get open orders
Parameters
- Optionalsymbol: string
  Optional symbol to filter by
Returns Promise<ExchangeOrder[]>
Array of open orders
Overrides Exchange.getOpenOrders
- Defined in packages/trading/src/exchanges/binance.ts:323

Class BinanceExchange

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BinanceExchange

Properties

Readonlyname

Readonlytestnet

Methods

formatSymbol

Parameters

Returns string

parseSymbol

Parameters

Returns { base: string; quote: string }

initialize

Parameters

Returns void

verifyCredentials

Returns Promise<boolean>

getBalances

Parameters

Returns Promise<ExchangeBalance[]>

getPrice

Parameters

Returns Promise<ExchangePrice>

getSymbols

Returns Promise<string[]>

marketBuy

Parameters

Returns Promise<ExchangeOrder>

marketSell

Parameters

Returns Promise<ExchangeOrder>

limitBuy

Parameters

Returns Promise<ExchangeOrder>

limitSell

Parameters

Returns Promise<ExchangeOrder>

stopLoss

Parameters

Returns Promise<ExchangeOrder>

takeProfit

Parameters

Returns Promise<ExchangeOrder>

cancelOrder

Parameters

Returns Promise<boolean>

getOrder

Parameters

Returns Promise<ExchangeOrder>

getOpenOrders

Parameters

Returns Promise<ExchangeOrder[]>

Settings

On This Page

`Readonly`name

`Readonly`testnet