Class CoinbaseExchange

Coinbase exchange implementation using the official Coinbase SDK

Hierarchy (View Summary)

Exchange
- CoinbaseExchange

Index

Constructors

constructor

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

Properties

`Readonly`name

name: "coinbase" = ...

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 Coinbase exchange with API credentials
Parameters
- credentials: ExchangeCredentials
  API key name and private key
Returns void
Overrides Exchange.initialize
- Defined in packages/trading/src/exchanges/coinbase.ts:19

verifyCredentials

verifyCredentials(): Promise<boolean>
Verify that the API credentials are valid

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

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/coinbase.ts:53

getPrice

getPrice(_symbol: string): Promise<ExchangePrice>
Get current price for a trading pair Note: Coinbase SDK doesn't have a direct price endpoint, we simulate it
Parameters
- _symbol: string
  Trading pair symbol (e.g., "BTCUSD")
Returns Promise<ExchangePrice>
Current price information
Overrides Exchange.getPrice
- Defined in packages/trading/src/exchanges/coinbase.ts:100

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/coinbase.ts:115

marketBuy

marketBuy(
    symbol: string,
    quantity: number,
    _quantityIsQuote?: boolean,
): Promise<ExchangeOrder>
Place a market buy order using Coinbase trade feature
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/coinbase.ts:128

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/coinbase.ts:176

limitBuy

limitBuy(
    _symbol: string,
    _quantity: number,
    _price: number,
): Promise<ExchangeOrder>
Place a limit buy order Note: Coinbase SDK doesn't support limit orders directly
Parameters
- _symbol: string
- _quantity: number
- _price: number
Returns Promise<ExchangeOrder>
Overrides Exchange.limitBuy
- Defined in packages/trading/src/exchanges/coinbase.ts:220

limitSell

limitSell(
    _symbol: string,
    _quantity: number,
    _price: number,
): Promise<ExchangeOrder>
Place a limit sell order Note: Coinbase SDK doesn't support limit orders directly
Parameters
- _symbol: string
- _quantity: number
- _price: number
Returns Promise<ExchangeOrder>
Overrides Exchange.limitSell
- Defined in packages/trading/src/exchanges/coinbase.ts:228

stopLoss

stopLoss(
    _symbol: string,
    _quantity: number,
    _stopPrice: number,
    _limitPrice?: number,
): Promise<ExchangeOrder>
Place a stop loss order Note: Coinbase SDK doesn't support stop orders directly
Parameters
- _symbol: string
- _quantity: number
- _stopPrice: number
- Optional_limitPrice: number
Returns Promise<ExchangeOrder>
Overrides Exchange.stopLoss
- Defined in packages/trading/src/exchanges/coinbase.ts:236

takeProfit

takeProfit(
    _symbol: string,
    _quantity: number,
    _price: number,
    _limitPrice?: number,
): Promise<ExchangeOrder>
Place a take profit order Note: Coinbase SDK doesn't support take profit orders directly
Parameters
- _symbol: string
- _quantity: number
- _price: number
- Optional_limitPrice: number
Returns Promise<ExchangeOrder>
Overrides Exchange.takeProfit
- Defined in packages/trading/src/exchanges/coinbase.ts:244

cancelOrder

cancelOrder(_orderId: string, _symbol: string): Promise<boolean>
Cancel an existing order Note: Coinbase SDK trades are immediate
Parameters
- _orderId: string
- _symbol: string
Returns Promise<boolean>
Overrides Exchange.cancelOrder
- Defined in packages/trading/src/exchanges/coinbase.ts:252

getOrder

getOrder(orderId: string, symbol: string): Promise<ExchangeOrder>
Get order status Note: Coinbase SDK trades are immediate
Parameters
- orderId: string
- symbol: string
Returns Promise<ExchangeOrder>
Overrides Exchange.getOrder
- Defined in packages/trading/src/exchanges/coinbase.ts:261

getOpenOrders

getOpenOrders(_symbol?: string): Promise<ExchangeOrder[]>
Get open orders Note: Coinbase SDK doesn't maintain open orders
Parameters
- Optional_symbol: string
Returns Promise<ExchangeOrder[]>
Overrides Exchange.getOpenOrders
- Defined in packages/trading/src/exchanges/coinbase.ts:278

Class CoinbaseExchange

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CoinbaseExchange

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