- Preparing search index...
- The search index is not available
xrpl-dex-sdk
Properties
broadcastClient
broadcastClient: default
client
client: Client | default
Methods
cancelOrder
- cancelOrder(id: `${string}:${number}`): Promise<CancelOrderResponse>
-
Parameters
-
id: `${string}:${number}`
createOrder
- createOrder(symbol: `${string}/${string}`, side: OrderSide, type: "limit", amount: string, price: string, params: CreateOrderParams): Promise<CreateOrderResponse>
-
Parameters
-
symbol: `${string}/${string}`
-
-
type: "limit"
-
amount: string
-
price: string
-
fetchClosedOrders
- fetchClosedOrders(symbol?: `${string}/${string}`, since?: number, limit?: number, params?: FetchClosedOrdersParams): Promise<FetchClosedOrdersResponse>
-
Parameters
-
Optional
symbol: `${string}/${string}`
-
Optional
since: number
-
Optional
limit: number
-
fetchMarket
- fetchMarket(symbol: `${string}/${string}`): Promise<FetchMarketResponse>
-
Parameters
-
symbol: `${string}/${string}`
fetchMyTrades
- fetchMyTrades(symbol: `${string}/${string}`, since?: number, limit?: number, params?: FetchMyTradesParams): Promise<FetchMyTradesResponse>
-
Parameters
-
symbol: `${string}/${string}`
-
Optional
since: number
-
Optional
limit: number
-
fetchOpenOrders
- fetchOpenOrders(symbol?: `${string}/${string}`, since?: number, limit?: number, params?: FetchOpenOrdersParams): Promise<FetchOpenOrdersResponse>
-
Parameters
-
Optional
symbol: `${string}/${string}`
-
Optional
since: number
-
Optional
limit: number
-
fetchOrder
- fetchOrder(id: `${string}:${number}`, symbol?: `${string}/${string}`, params?: FetchOrderParams): Promise<FetchOrderResponse>
-
Parameters
-
id: `${string}:${number}`
-
Optional
symbol: `${string}/${string}`
-
fetchOrders
- fetchOrders(symbol?: `${string}/${string}`, since?: number, limit?: number, params?: FetchOrdersParams): Promise<FetchOrdersResponse>
-
Parameters
-
Optional
symbol: `${string}/${string}`
-
Optional
since: number
-
Optional
limit: number
-
fetchTrades
- fetchTrades(symbol: `${string}/${string}`, since?: number, limit?: number, params?: FetchTradesParams): Promise<FetchTradesResponse>
-
Parameters
-
symbol: `${string}/${string}`
-
Optional
since: number
-
Optional
limit: number
-
fetchTradingFee
- fetchTradingFee(symbol: `${string}/${string}`): Promise<FetchTradingFeeResponse>
-
Parameters
-
symbol: `${string}/${string}`
fetchTransferRate
- fetchTransferRate(issuer: string): Promise<BigNumber>
-
Returns Promise<BigNumber>
watchOrderBook
- watchOrderBook(symbol: `${string}/${string}`, limit?: number): Promise<Readable>
-
Parameters
-
symbol: `${string}/${string}`
-
Optional
limit: number
Returns Promise<Readable>
watchOrders
- watchOrders(symbol?: `${string}/${string}`, params?: WatchOrdersParams): Promise<Readable>
-
Parameters
-
Optional
symbol: `${string}/${string}`
-
Returns Promise<Readable>
watchStatus
- watchStatus(): Promise<Readable>
-
Returns Promise<Readable>
watchTicker
- watchTicker(symbol: `${string}/${string}`, params: WatchTickerParams): Promise<Readable>
-
Parameters
-
symbol: `${string}/${string}`
-
Returns Promise<Readable>
watchTickers
- watchTickers(symbols: `${string}/${string}`[], params: WatchTickersParams): Promise<Readable>
-
Parameters
-
symbols: `${string}/${string}`[]
-
Returns Promise<Readable>
watchTrades
- watchTrades(symbol: `${string}/${string}`): Promise<Readable>
-
Parameters
-
symbol: `${string}/${string}`
Returns Promise<Readable>