Optional
currenciesOptional
issuersOptional
marketsOptional
transfer(Optional) A FetchBalanceParams object
Listens for new OrderBook data for a single Market pair. Returns a Promise resolving to a WatchBalanceResponse.
A Promise resolving to a WatchBalanceResponse object
(Optional) A WatchBalanceParams object
Retrieves a list of Currencies being traded on the dEX. Returns a FetchCurrenciesResponse.
A FetchCurrenciesResponse object
Retrieves and caches a list of Currencies being traded on the dEX. Returns a Promise resolving to a LoadCurrenciesResponse.
A Promise resolving to a LoadCurrenciesResponse object
Optional
reload: boolean(Optional) Whether to refresh the cache
Fetches information regarding ExchangeStatus from either the info hardcoded in the exchange instance or the API, if available. Returns a FetchStatusResponse.
A FetchStatusResponse object
Streams information regarding ExchangeStatus from either the info hardcoded in the exchange instance or the API, if available. Returns a Promise resolving to a WatchStatusResponse.
A Promise resolving to a WatchStatusResponse object
Fetches information about currency-related Fees incurred for performing transactions. Returns a FetchFeesResponse.
https://docs.ccxt.com/en/latest/manual.html?#fees
A FetchFeesResponse object
Fetches information about the fees incurred while trading on given Market. Returns a FetchTradingFeeResponse.
https://docs.ccxt.com/en/latest/manual.html?#fees
A FetchTradingFeeResponse object
(Optional) MarketSymbol to get trading fees for
Fetches information about the fees incurred while trading on any Market. Returns a FetchTradingFeesResponse.
https://docs.ccxt.com/en/latest/manual.html?#fees
A FetchTradingFeesResponse object
Fetches information about fees incurred for performing transactions with a given Currency. Returns a FetchTransactionFeesResponse.
https://docs.ccxt.com/en/latest/manual.html?#fees
A FetchTransactionFeeResponse object
CurrencyCode to get fees for
Fetches information about fees incurred for performing transactions with multiple Currencies. Returns a FetchTransactionFeesResponse.
https://docs.ccxt.com/en/latest/manual.html?#fees
A FetchTransactionFeesResponse object
Array of CurrencyCodes to get fees for
Retrieves an Issuer's transfer rate (if any). Returns a FetchTransferRateResponse with the transfer rate, or zero if the Issuer has no transfer fees.
https://docs.ccxt.com/en/latest/manual.html?#fees
A FetchTransferRateResponse object
Issuer address to get data for
Retrieves a list of trusted Issuers. Returns a FetchIssuersResponse.
a FetchIssuersResponse object
Retrieves and caches a list of Issuers whose Currencies are being traded on the dEX. Returns a Promise resolving to a LoadIssuersResponse.
A Promise resolving to a LoadIssuersResponse object
Optional
reload: boolean(Optional) Whether to refresh the cache
Retrieves info for a single Market being traded on the dEX. Returns a FetchMarketsResponse.
FetchMarketsResponse or undefined
ArgumentsRequired Thrown if any required function arguments are missing
BadSymbol Thrown if the provided MarketSymbol is invalid
MarketNotFound Thrown if data about the market could not be found
MarketSymbol of the market to get info for
Retrieves info for all Markets being traded on the dEX. Returns a FetchMarketsResponse.
A FetchMarketsResponse object
Retrieves and caches a list of Markets being traded on the dEX. Returns a Promise resolving to a LoadMarketsResponse.
A Promise resolving to a LoadMarketsResponse object
Optional
reload: boolean(Optional) Whether to refresh the cache
Retrieves L2 order book data for a single market pair. Returns a FetchL2OrderBookResponse.
https://docs.ccxt.com/en/latest/manual.html?#order-book
A FetchL2OrderBookResponse object
MarketSymbol to get order book for
Optional
limit: number(Optional) Total number of entries to return (default is 20)
Optional
params: FetchL2OrderBookParams(Optional) A FetchL2OrderBookParams
Retrieves order book data for a single Market pair. Returns a FetchOrderBookResponse.
https://docs.ccxt.com/en/latest/manual.html?#order-book
A FetchOrderBookResponse object
MarketSymbol to get order book for
Optional
limit: number(Optional) Total number of entries to return (default is 20)
Optional
params: FetchOrderBookParams(Optional) A FetchOrderBookParams object
Retrieves order book data for multiple Market pairs. Returns a FetchOrderBooksResponse.
https://docs.ccxt.com/en/latest/manual.html?#order-book
A FetchOrderBooksResponse object
Array of MarketSymbols to get order books for
(Optional) Total number of entries to return (default is 20)
(Optional) A FetchOrderBookParams object
Listens for new OrderBook data for a single Market pair. Returns a Promise resolving to a WatchOrderBookResponse.
A Promise resolving to a WatchOrderBookResponse object
MarketSymbol to get order book for
Optional
limit: number(Optional) Total number of entries to return (default is 20)
Cancels an Order on the Ripple dEX. Returns a Promise resolving to a CancelOrderResponse with the ID of the canceled Order object.
https://docs.ccxt.com/en/latest/manual.html?#canceling-orders
a Promise resolving to a CancelOrderResponse
OrderId of the Order to cancel
Places a Limit Buy Order on the Ripple dEX. Returns a CreateLimitBuyOrderResponse with the newly created Order's ID.
https://docs.ccxt.com/en/latest/manual.html?#placing-orders
A CreateLimitBuyOrderResponse object
MarketSymbol for new Order
How much currency you want to trade (in units of base currency)
Price at which the order is to be fullfilled (in units of quote currency)
(Optional) A CreateLimitBuyOrderParams object
Places a Limit Sell Order on the Ripple dEX. Returns a CreateLimitSellOrderResponse with the newly created Order's ID.
https://docs.ccxt.com/en/latest/manual.html?#placing-orders
A CreateLimitSellOrderResponse object
MarketSymbol for new Order
How much currency you want to trade (in units of base currency)
Price at which the order is to be fullfilled (in units of quote currency)
(Optional) A CreateLimitSellOrderParams object
Places an Order on the Ripple dEX. Returns a CreateOrderResponse with the newly created Order's ID.
https://docs.ccxt.com/en/latest/manual.html?#placing-orders
A CreateOrderResponse object
MarketSymbol for new Order
Order direction (buy or sell)
Order type (only limit is supported)
How much currency you want to trade (in units of base currency)
Price at which the order is to be fullfilled (in units of quote currency)
(Optional) a CreateOrderParams object
Creates a Trust Line to a currency Issuer on the XRPL ledger. Returns a CreateTrustLineResponse with the newly created Trust Line.
A CreateTrustLineResponse object
CurrencyCode for an issued (non-XRP) currency
Max amount of sdk currency you can receive
Fetches a list of canceled Orders from the dEX. Returns a FetchCanceledOrdersResponse with any retrieved Orders.
https://docs.ccxt.com/en/latest/manual.html?#querying-orders
Optional
symbol: `${string}/${string}`(Optional) MarketSymbol to filter Orders by
Optional
since: number(Optional) Only return Orders since sdk date
Optional
limit: number(Optional) Total number of Orders to return (default is 20)
Optional
params: FetchCanceledOrdersParams(Optional) A FetchCanceledOrdersParams
Fetches a list of closed Orders from the dEX. Returns a FetchClosedOrdersResponse with any retrieved Orders.
https://docs.ccxt.com/en/latest/manual.html?#querying-orders
Optional
symbol: `${string}/${string}`(Optional) MarketSymbol to filter Orders by
Optional
since: number(Optional) Only return Orders since sdk date
Optional
limit: number(Optional) Total number of Orders to return (default is 20)
Optional
params: FetchClosedOrdersParams(Optional) A FetchClosedOrdersResponse
Fetches a list of open Orders from the dEX. Returns a FetchOpenOrdersResponse with a list of any Orders found.
https://docs.ccxt.com/en/latest/manual.html?#querying-orders
A FetchOpenOrdersResponse object
Optional
symbol: `${string}/${string}`(Optional) MarketSymbol to filter Orders by
Optional
since: number(Optional) Only return Orders since sdk date
Optional
limit: number(Optional) Total number of Orders to return (default is 20)
Optional
params: FetchOpenOrdersParams(Optional) A FetchOpenOrdersParams object
Fetches an Order from the dEX. Returns a FetchOrderResponse with the matching Order.
https://docs.ccxt.com/en/latest/manual.html?#querying-orders
OrderId of the Order to fetch
Optional
symbol: `${string}/${string}`(Optional) The MarketSymbol of the Order to fetch
Optional
params: FetchOrderParams(Optional) A FetchOrderParams object
Retrieves OrderBook data for multiple Market pairs. Returns a FetchOrdersResponse with a list of any matching Orders.
https://docs.ccxt.com/en/latest/manual.html?#querying-multiple-orders-and-trades
A FetchOrdersResponse object
Optional
symbol: `${string}/${string}`(Optional) MarketSymbol to filter Orders by
Optional
since: number(Optional) Only return Orders since sdk date
Optional
limit: number(Optional) Total number of entries to return (default is 20)
Optional
params: FetchOrdersParams(Optional) A FetchOrdersParams object
Listens for new Orders for a single Market pair. Returns a Promise resolving to a WatchOrdersResponse.
A Promise resolving to a WatchOrdersResponse object
Optional
symbol: `${string}/${string}`(Optional) MarketSymbol to filter Orders by
Optional
params: WatchOrdersParams(Optional) A WatchOrdersParams object
Retrieves Ticker data for a single Market pair. Returns a FetchTickerResponse.
https://docs.ccxt.com/en/latest/manual.html?#a-single-ticker-for-one-symbol
A FetchTickerResponse object
MarketSymbol to get price ticker data for
(Optional) A FetchTickerParams object
Retrieves price Ticker data for multiple Market pairs. Returns a FetchTickersResponse.
https://docs.ccxt.com/en/latest/manual.html?#multiple-tickers-for-all-or-many-symbols
A FetchTickersResponse object
Array of MarketSymbols to get price ticker data for
(Optional) A FetchTickersParams object
Listens for new Ticker data for a single Market pair. Returns a Promise resolving to a WatchTickerResponse.
A Promise resolving to a WatchTickerResponse object
MarketSymbol to get price ticker data for
(Optional) A WatchTickerParams object
Listens for new Ticker data for multiple Market pairs. Returns a Promise resolving to a WatchTickersResponse.
A Promise resolving to a WatchTickersResponse object
Array of MarketSymbols to get price ticker data for
(Optional) A WatchTickerParams object
Fetch the SDK user's Trades for a given market symbol. Returns a FetchMyTradesResponse.
A FetchMyTradesResponse object
MarketSymbol to filter Trades by
Optional
since: number(Optional) Only return Trades since sdk date
Optional
limit: number(Optional) Total number of Trades to return (default is 20)
Optional
params: FetchMyTradesParams(Optional) A FetchMyTradesParams object
Fetch Trades for a given MarketSymbol. Returns a FetchTradesResponse with any matching Trades.
https://docs.ccxt.com/en/latest/manual.html?#querying-multiple-orders-and-trades
A FetchTradesResponse object
(Optional) MarketSymbol to filter Trades by
Optional
since: number(Optional) Only return Trades since sdk date
Optional
limit: number(Optional) Total number of Trades to return (default is 20)
Optional
params: FetchTradesParams(Optional) A FetchTradesParams object
Listens for new Trades from the SDK user for a given Market pair. Returns a Promise resolving to a WatchMyTradesResponse.
A Promise resolving to a WatchMyTradesResponse object
MarketSymbol to watch
Listens for new Trades for a given Market. Returns a Promise resolving to a WatchTradesResponse.
A Promise resolving to a WatchTradesResponse object
(Optional) MarketSymbol to filter Trades by
Generated using TypeDoc
Fetches information about an account's balances, sorted by currency and funds availability. Returns a FetchBalanceResponse.
Link
https://docs.ccxt.com/en/latest/manual.html?#account-balance
Returns
FetchBalanceResponse