exmo

exmo cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.

exmo

Kind: global class
Extends: Exchange

reduceMargin
addMargin
fetchTradingFees
fetchTransactionFees
fetchDepositWithdrawFees
fetchCurrencies
fetchMarkets
fetchOHLCV
fetchBalance
fetchOrderBook
fetchOrderBooks
fetchTickers
fetchTicker
fetchTrades
fetchMyTrades
createMarketOrderWithCost
createMarketBuyOrderWithCost
createMarketSellOrderWithCost
createOrder
cancelOrder
fetchOrder
fetchOrderTrades
fetchOpenOrders
fetchCanceledOrders
editOrder
fetchDepositAddress
withdraw
fetchDepositsWithdrawals
fetchWithdrawals
fetchWithdrawal
fetchDeposit
fetchDeposits
watchBalance
watchTicker
watchTickers
watchTrades
watchMyTrades
watchOrderBook
watchOrders

reduceMargin

remove margin from a position

Kind: instance method of exmo
Returns: object - a margin structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#eebf9f25-0289-4946-9482-89872c738449

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
amount	`float`	Yes	the amount of margin to remove
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.reduceMargin (symbol, amount, params?)

addMargin

add margin

Kind: instance method of exmo
Returns: object - a margin structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#143ef808-79ca-4e49-9e79-a60ea4d8c0e3

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
amount	`float`	Yes	amount of margin to add
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.addMargin (symbol, amount, params?)

fetchTradingFees

fetch the trading fees for multiple markets

Kind: instance method of exmo
Returns: object - a dictionary of fee structures indexed by market symbols

See

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchTradingFees (params?)

fetchTransactionFees

DEPRECATED

please use fetchDepositWithdrawFees instead

Kind: instance method of exmo
Returns: object - a list of transaction fees structures

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#4190035d-24b1-453d-833b-37e0a52f88e2

Param	Type	Required	Description
codes	`Array<string>`, `undefined`	Yes	list of unified currency codes
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchTransactionFees (codes, params?)

fetchDepositWithdrawFees

fetch deposit and withdraw fees

Kind: instance method of exmo
Returns: object - a list of transaction fees structures

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#4190035d-24b1-453d-833b-37e0a52f88e2

Param	Type	Required	Description
codes	`Array<string>`, `undefined`	Yes	list of unified currency codes
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchDepositWithdrawFees (codes, params?)

fetchCurrencies

fetches all available currencies on an exchange

Kind: instance method of exmo
Returns: object - an associative dictionary of currencies

See

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchCurrencies (params?)

fetchMarkets

retrieves data on all markets for exmo

Kind: instance method of exmo
Returns: Array<object> - an array of objects representing market data

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#7de7e75c-5833-45a8-b937-c2276d235aaa

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchMarkets (params?)

fetchOHLCV

fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of exmo
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#65eeb949-74e5-4631-9184-c38387fe53e8

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
since	`int`	No	timestamp in ms of the earliest candle to fetch
limit	`int`	No	the maximum amount of candles to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint
params.until	`int`	No	timestamp in ms of the latest candle to fetch

exmo.fetchOHLCV (symbol, timeframe, since?, limit?, params?)

fetchBalance

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of exmo
Returns: object - a balance structure

See

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint
params.marginMode	`string`	No	isolated fetches the isolated margin balance

exmo.fetchBalance (params?)

fetchOrderBook

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of exmo
Returns: object - A dictionary of order book structures indexed by market symbols

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#c60c51a8-e683-4f45-a000-820723d37871

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the order book for
limit	`int`	No	the maximum amount of order book entries to return
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchOrderBook (symbol, limit?, params?)

fetchOrderBooks

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for multiple markets

Kind: instance method of exmo
Returns: object - a dictionary of order book structures indexed by market symbol

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#c60c51a8-e683-4f45-a000-820723d37871

Param	Type	Required	Description
symbols	`Array<string>`, `undefined`	Yes	list of unified market symbols, all symbols fetched if undefined, default is undefined
limit	`int`	No	max number of entries per orderbook to return, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchOrderBooks (symbols, limit?, params?)

fetchTickers

fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market

Kind: instance method of exmo
Returns: object - a dictionary of ticker structures

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#4c8e6459-3503-4361-b012-c34bb9f7e385

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

exmo.fetchTickers (symbols, params?)

fetchTicker

fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of exmo
Returns: object - a ticker structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#4c8e6459-3503-4361-b012-c34bb9f7e385

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

exmo.fetchTicker (symbol, params?)

fetchTrades

get the list of most recent trades for a particular symbol

Kind: instance method of exmo
Returns: Array<Trade> - a list of trade structures

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#5a5a9c0d-cf17-47f6-9d62-6d4404ebd5ac

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 amount of trades to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchTrades (symbol, since?, limit?, params?)

fetchMyTrades

fetch all trades made by the user

Kind: instance method of exmo
Returns: Array<Trade> - a list of trade structures

See

Param	Type	Required	Description
symbol	`string`	Yes	a symbol is required but it can be a single string, or a non-empty array
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	required for margin orders the maximum number of trades structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint EXCHANGE SPECIFIC PARAMETERS
params.offset	`int`	No	last deal offset, default = 0

exmo.fetchMyTrades (symbol, since?, limit?, params?)

createMarketOrderWithCost

create a market order by providing the symbol, side and cost

Kind: instance method of exmo
Returns: object - an order structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#80daa469-ec59-4d0a-b229-6a311d8dd1cd

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
side	`string`	Yes	'buy' or 'sell'
cost	`float`	Yes	how much you want to trade in units of the quote currency
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.createMarketOrderWithCost (symbol, side, cost, params?)

createMarketBuyOrderWithCost

create a market buy order by providing the symbol and cost

Kind: instance method of exmo
Returns: object - an order structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#80daa469-ec59-4d0a-b229-6a311d8dd1cd

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
cost	`float`	Yes	how much you want to trade in units of the quote currency
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.createMarketBuyOrderWithCost (symbol, cost, params?)

createMarketSellOrderWithCost

create a market sell order by providing the symbol and cost

Kind: instance method of exmo
Returns: object - an order structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#80daa469-ec59-4d0a-b229-6a311d8dd1cd

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
cost	`float`	Yes	how much you want to trade in units of the quote currency
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.createMarketSellOrderWithCost (symbol, cost, params?)

createOrder

create a trade order

Kind: instance method of exmo
Returns: object - an order structure

See

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to create an order in
type	`string`	Yes	'market' or 'limit'
side	`string`	Yes	'buy' or 'sell'
amount	`float`	Yes	how much of currency you want to trade in units of base currency
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.triggerPrice	`float`	No	the price at which a trigger order is triggered at
params.timeInForce	`string`	No	spot only 'fok', 'ioc' or 'post_only'
params.postOnly	`boolean`	No	spot only true for post only orders
params.cost	`float`	No	spot only market orders only the cost of the order in the quote currency for market orders

exmo.createOrder (symbol, type, side, amount, price?, params?)

cancelOrder

cancels an open order

Kind: instance method of exmo
Returns: object - An order structure

See

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	not used by exmo cancelOrder ()
params	`object`	No	extra parameters specific to the exchange API endpoint
params.trigger	`boolean`	No	true to cancel a trigger order
params.marginMode	`string`	No	set to 'cross' or 'isolated' to cancel a margin order

exmo.cancelOrder (id, symbol, params?)

fetchOrder

spot only fetches information on an order made by the user

Kind: instance method of exmo
Returns: object - An order structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#cf27781e-28e5-4b39-a52d-3110f5d22459 // spot

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	not used by exmo fetchOrder
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchOrder (id, symbol, params?)

fetchOrderTrades

fetch all the trades made from a single order

Kind: instance method of exmo
Returns: Array<object> - a list of trade structures

See

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified market symbol
since	`int`	No	the earliest time in ms to fetch trades for
limit	`int`	No	the maximum number of trades to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.marginMode	`string`	No	set to "isolated" to fetch trades for a margin order

exmo.fetchOrderTrades (id, symbol, since?, limit?, params?)

fetchOpenOrders

fetch all unfilled currently open orders

Kind: instance method of exmo
Returns: Array<Order> - a list of order structures

See

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol
since	`int`	No	the earliest time in ms to fetch open orders for
limit	`int`	No	the maximum number of open orders structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint
params.marginMode	`string`	No	set to "isolated" for margin orders

exmo.fetchOpenOrders (symbol, since?, limit?, params?)

fetchCanceledOrders

fetches information on multiple canceled orders made by the user

Kind: instance method of exmo
Returns: object - a list of order structures

See

https://documenter.getpostman.com/view/10287440/SzYXWKPi#1d2524dd-ae6d-403a-a067-77b50d13fbe5 // margin
https://documenter.getpostman.com/view/10287440/SzYXWKPi#a51be1d0-af5f-44e4-99d7-f7b04c6067d0 // spot canceled orders

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	timestamp in ms of the earliest order, default is undefined
limit	`int`	No	max number of orders to return, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint
params.marginMode	`string`	No	set to "isolated" for margin orders

exmo.fetchCanceledOrders (symbol, since?, limit?, params?)

editOrder

margin only edit a trade order

Kind: instance method of exmo
Returns: object - an order structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#f27ee040-c75f-4b59-b608-d05bd45b7899 // margin

Param	Type	Required	Description
id	`string`	Yes	order id
symbol	`string`	Yes	unified CCXT market symbol
type	`string`	Yes	not used by exmo editOrder
side	`string`	Yes	not used by exmo editOrder
amount	`float`	No	how much of the currency you want to trade in units of the base currency
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.triggerPrice	`float`	No	stop price for stop-market and stop-limit orders
params.marginMode	`string`	Yes	must be set to isolated EXCHANGE SPECIFIC PARAMETERS
params.distance	`int`	No	distance for trailing stop orders
params.expire	`int`	No	expiration timestamp in UTC timezone for the order. order will not be expired if expire is 0
params.comment	`string`	No	optional comment for order. up to 50 latin symbols, whitespaces, underscores

exmo.editOrder (id, symbol, type, side, amount?, price?, params?)

fetchDepositAddress

fetch the deposit address for a currency associated with this account

Kind: instance method of exmo
Returns: object - an address structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#c8f9ced9-7ab6-4383-a6a4-bc54469ba60e

Param	Type	Required	Description
code	`string`	Yes	unified currency code
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchDepositAddress (code, params?)

withdraw

make a withdrawal

Kind: instance method of exmo
Returns: object - a transaction structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#3ab9c34d-ad58-4f87-9c57-2e2ea88a8325

Param	Type	Required	Description
code	`string`	Yes	unified currency code
amount	`float`	Yes	the amount to withdraw
address	`string`	Yes	the address to withdraw to
tag	`string`	Yes
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.withdraw (code, amount, address, tag, params?)

fetchDepositsWithdrawals

fetch history of deposits and withdrawals

Kind: instance method of exmo
Returns: object - a list of transaction structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#31e69a33-4849-4e6a-b4b4-6d574238f6a7

Param	Type	Required	Description
code	`string`	No	unified currency code for the currency of the deposit/withdrawals, default is undefined
since	`int`	No	timestamp in ms of the earliest deposit/withdrawal, default is undefined
limit	`int`	No	max number of deposit/withdrawals to return, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchDepositsWithdrawals (code?, since?, limit?, params?)

fetchWithdrawals

fetch all withdrawals made from an account

Kind: instance method of exmo
Returns: Array<object> - a list of transaction structures

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#97f1becd-7aad-4e0e-babe-7bbe09e33706

Param	Type	Required	Description
code	`string`	Yes	unified currency code
since	`int`	No	the earliest time in ms to fetch withdrawals for
limit	`int`	No	the maximum number of withdrawals structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchWithdrawals (code, since?, limit?, params?)

fetchWithdrawal

fetch data on a currency withdrawal via the withdrawal id

Kind: instance method of exmo
Returns: object - a transaction structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#97f1becd-7aad-4e0e-babe-7bbe09e33706

Param	Type	Required	Description
id	`string`	Yes	withdrawal id
code	`string`	Yes	unified currency code of the currency withdrawn, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchWithdrawal (id, code, params?)

fetchDeposit

fetch information on a deposit

Kind: instance method of exmo
Returns: object - a transaction structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#97f1becd-7aad-4e0e-babe-7bbe09e33706

Param	Type	Required	Description
id	`string`	Yes	deposit id
code	`string`	Yes	unified currency code, default is undefined
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchDeposit (id, code, params?)

fetchDeposits

fetch all deposits made to an account

Kind: instance method of exmo
Returns: Array<object> - a list of transaction structures

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#97f1becd-7aad-4e0e-babe-7bbe09e33706

Param	Type	Required	Description
code	`string`	Yes	unified currency code
since	`int`	No	the earliest time in ms to fetch deposits for
limit	`int`	No	the maximum number of deposits structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.fetchDeposits (code, since?, limit?, params?)

watchBalance

watch balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of exmo
Returns: object - a balance structure

Param	Type	Required	Description
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.watchBalance (params?)

watchTicker

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of exmo
Returns: object - a ticker structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#fd8f47bc-8517-43c0-bb60-1d61a86d4471

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

exmo.watchTicker (symbol, params?)

watchTickers

watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list

Kind: instance method of exmo
Returns: object - a ticker structure

See: https://documenter.getpostman.com/view/10287440/SzYXWKPi#fd8f47bc-8517-43c0-bb60-1d61a86d4471

Param	Type	Required	Description
symbols	`Array<string>`	No	unified symbol of the market to fetch the ticker for
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.watchTickers (symbols?, params?)

watchTrades

get the list of most recent trades for a particular symbol

Kind: instance method of exmo
Returns: Array<object> - a list of trade structures

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 amount of trades to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.watchTrades (symbol, since?, limit?, params?)

watchMyTrades

get the list of trades associated with the user

Kind: instance method of exmo
Returns: Array<object> - a list of trade structures

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 amount of trades to fetch
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.watchMyTrades (symbol, since?, limit?, params?)

watchOrderBook

watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of exmo
Returns: object - A dictionary of order book structures indexed by market symbols

Param	Type	Required	Description
symbol	`string`	Yes	unified symbol of the market to fetch the order book for
limit	`int`	No	the maximum amount of order book entries to return
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.watchOrderBook (symbol, limit?, params?)

watchOrders

watches information on multiple orders made by the user

Kind: instance method of exmo
Returns: Array<object> - a list of order structures

See

Param	Type	Required	Description
symbol	`string`	Yes	unified market symbol of the market orders were made in
since	`int`	No	the earliest time in ms to fetch orders for
limit	`int`	No	the maximum number of order structures to retrieve
params	`object`	No	extra parameters specific to the exchange API endpoint

exmo.watchOrders (symbol, since?, limit?, params?)

exmo

On this page