revolutx
revolutx cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
🔌 Looking for raw exchange endpoints? See the revolutx implicit API — every endpoint in this exchange's API exposed as an implicit method.
revolutx
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchCurrencies
- fetchTickers
- fetchTicker
- fetchOrderBook
- fetchOHLCV
- fetchTrades
- fetchBalance
- createOrder
- cancelOrder
- cancelAllOrders
- fetchOrder
- fetchOpenOrders
- fetchOrders
- fetchClosedOrders
- fetchMyTrades
- editOrder
fetchMarkets
retrieves all available markets on the exchange
Kind: instance method of revolutx
Returns: Array<object> - an array of market structures
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-public-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.region | string | No | the region to filter markets by (e.g. EEA, UK) |
revolutx.fetchMarkets (params?)fetchCurrencies
fetches all available currencies on the exchange
Kind: instance method of revolutx
Returns: object - a dictionary of currency structures
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-public-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.region | string | No | the region to filter currencies by |
revolutx.fetchCurrencies (params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of revolutx
Returns: object - a dictionary of ticker structures
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-public-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined | Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.region | string | No | the region to fetch tickers for (e.g. EEA, UK) |
revolutx.fetchTickers (symbols, params?)fetchTicker
fetches a price ticker for a given market symbol
Kind: instance method of revolutx
Returns: object - a ticker structure
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-public-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the ticker for |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.region | string | No | the region to fetch the ticker for |
revolutx.fetchTicker (symbol, params?)fetchOrderBook
fetches the current order book snapshot for a given market symbol
Kind: instance method of revolutx
Returns: object - an order book structure
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-public-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch the order book for |
| limit | int | No | the maximum number of orders to return (1-50, default 50) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.region | string | No | the region to fetch the order book for |
revolutx.fetchOrderBook (symbol, limit?, params?)fetchOHLCV
fetches historical candlestick data for a given market symbol
Kind: instance method of revolutx
Returns: Array<Array<int>> - a list of OHLCV structures
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-public-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string | Yes | the length of time each candle represents (e.g. 1m, 5m, 1h, 1d) |
| since | int | No | timestamp in ms of the earliest candle to fetch |
| limit | int | No | the maximum number of candles to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.until | int | No | timestamp in ms of the latest candle to fetch |
| params.region | string | No | the region to fetch candles for |
revolutx.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchTrades
fetches the public trade history for a given market symbol
Kind: instance method of revolutx
Returns: Array<object> - a list of trade structures
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-public-market-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch trades for |
| since | int | No | timestamp in ms of the earliest trade to fetch |
| limit | int | No | the maximum number of trades to return (1-1900, default 1900) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.until | int | No | timestamp in ms of the latest trade to fetch |
| params.cursor | string | No | pagination cursor from the previous response |
revolutx.fetchTrades (symbol, since?, limit?, params?)fetchBalance
fetches the current balance for the authenticated user
Kind: instance method of revolutx
Returns: object - a balance structure
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-account-data
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
revolutx.fetchBalance (params?)createOrder
create a trade order
Kind: instance method of revolutx
Returns: object - an order structure
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-trading
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| type | string | Yes | 'limit' or 'market' |
| side | string | Yes | 'buy' or 'sell' |
| amount | float | Yes | how much of the base currency you want to trade |
| price | float | No | the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.clientOrderId | string | No | a custom client order id (UUID) |
| params.cost | float | No | the order cost in units of the quote currency (alternative to amount) |
| params.timeInForce | string | No | 'gtc' or 'ioc' for limit orders |
| params.executionInstructions | Array<string> | No | limit order instructions, e.g. ['post_only'] or ['allow_taker'] |
revolutx.createOrder (symbol, type, side, amount, price?, params?)cancelOrder
cancels an open order by its id
Kind: instance method of revolutx
Returns: object - an order structure
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-trading
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | the order id (venue order id) |
| symbol | string | Yes | not used by this exchange |
| params | object | No | extra parameters specific to the exchange API endpoint |
revolutx.cancelOrder (id, symbol, params?)cancelAllOrders
cancels all open orders
Kind: instance method of revolutx
Returns: object - an empty order structure
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-trading
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | No | not used by this exchange |
| params | object | No | extra parameters specific to the exchange API endpoint |
revolutx.cancelAllOrders (symbol?, params?)fetchOrder
fetches an order by its id
Kind: instance method of revolutx
Returns: object - an order structure
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-account-data
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | the order id (venue order id) |
| symbol | string | Yes | unified symbol of the market the order was made in |
| params | object | No | extra parameters specific to the exchange API endpoint |
revolutx.fetchOrder (id, symbol, params?)fetchOpenOrders
fetches all open orders for the authenticated user
Kind: instance method of revolutx
Returns: Array<object> - a list of order structures
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-account-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string, undefined | Yes | unified symbol of the market to fetch open orders for |
| since | int | No | timestamp in ms of the earliest order to fetch |
| limit | int | No | the maximum number of orders to return (1-300, default 300) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.cursor | string | No | pagination cursor from the previous response |
| params.orderStates | Array<string> | No | filter by order states, e.g. ['new', 'partially_filled'] |
| params.orderTypes | Array<string> | No | filter by order types, e.g. ['limit', 'market'] |
| params.side | string | No | filter by side, 'buy' or 'sell' |
revolutx.fetchOpenOrders (symbol, since?, limit?, params?)fetchOrders
fetches historical orders for the authenticated user
Kind: instance method of revolutx
Returns: Array<object> - a list of order structures
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-account-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string, undefined | Yes | unified symbol of the market to fetch orders for |
| since | int | No | timestamp in ms of the earliest order to fetch, the lookup window is limited to 30 days |
| limit | int | No | the maximum number of orders to return (1-1900, default 1900) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.until | int | No | timestamp in ms of the latest order to fetch |
| params.cursor | string | No | pagination cursor from the previous response |
| params.orderStates | Array<string> | No | filter by order states, e.g. ['filled', 'cancelled', 'rejected'] |
| params.orderTypes | Array<string> | No | filter by order types, e.g. ['limit', 'market'] |
revolutx.fetchOrders (symbol, since?, limit?, params?)fetchClosedOrders
fetches closed (filled, cancelled, rejected) orders for the authenticated user
Kind: instance method of revolutx
Returns: Array<object> - a list of order structures
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-account-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string, undefined | Yes | unified symbol of the market to fetch orders for |
| since | int | No | timestamp in ms of the earliest order to fetch, the lookup window is limited to 30 days |
| limit | int | No | the maximum number of orders to return |
| params | object | No | extra parameters specific to the exchange API endpoint |
revolutx.fetchClosedOrders (symbol, since?, limit?, params?)fetchMyTrades
fetches the trade history for the authenticated user
Kind: instance method of revolutx
Returns: Array<object> - a list of trade structures
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-account-data
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to fetch trades for |
| since | int | No | timestamp in ms of the earliest trade to fetch, the lookup window is limited to 30 days |
| limit | int | No | the maximum number of trades to return (1-1900, default 1900) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.until | int | No | timestamp in ms of the latest trade to fetch |
| params.cursor | string | No | pagination cursor from the previous response |
revolutx.fetchMyTrades (symbol, since?, limit?, params?)editOrder
replaces an existing order
Kind: instance method of revolutx
Returns: object - an order structure
See: https://developer.revolut.com/docs/api/revolut-x-crypto-exchange#tag-trading
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | the order id (venue order id) to replace |
| symbol | string | Yes | unified symbol of the market |
| type | string | Yes | 'limit' or 'market' |
| side | string | Yes | 'buy' or 'sell' |
| amount | float | Yes | the new amount |
| price | float | No | the new price |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.clientOrderId | string | No | a custom client order id (UUID) |
| params.cost | float | No | the new order cost in units of the quote currency |
| params.timeInForce | string | No | e.g. gtc |
| params.executionInstructions | Array<string> | No | e.g. ['post_only'] |
revolutx.editOrder (id, symbol, type, side, amount, price?, params?)