cryptomus
cryptomus cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
cryptomus
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchCurrencies
- fetchTickers
- fetchOrderBook
- fetchTrades
- fetchBalance
- createOrder
- cancelOrder
- fetchOrders
- fetchOpenOrders
- fetchTradingFees
fetchMarkets
retrieves data on all markets for the exchange
Kind: instance method of cryptomus
Returns: Array<object> - an array of objects representing market data
See: https://doc.cryptomus.com/personal/market-cap/tickers
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
cryptomus.fetchMarkets (params?)fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of cryptomus
Returns: object - an associative dictionary of currencies
See: https://doc.cryptomus.com/personal/market-cap/assets
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
cryptomus.fetchCurrencies (params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of cryptomus
Returns: object - a dictionary of ticker structures
See: https://doc.cryptomus.com/personal/market-cap/tickers
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string> | No | 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 |
cryptomus.fetchTickers (symbols?, params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of cryptomus
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://doc.cryptomus.com/personal/market-cap/orderbook
| 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 |
| params.level | int | No | 0 or 1 or 2 or 3 or 4 or 5 - the level of volume |
cryptomus.fetchOrderBook (symbol, limit?, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of cryptomus
Returns: Array<Trade> - a list of trade structures
See: https://doc.cryptomus.com/personal/market-cap/trades
| 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 (maximum value is 100) |
| params | object | No | extra parameters specific to the exchange API endpoint |
cryptomus.fetchTrades (symbol, 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 cryptomus
Returns: object - a balance structure
See: https://doc.cryptomus.com/personal/converts/balance
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
cryptomus.fetchBalance (params?)createOrder
create a trade order
Kind: instance method of cryptomus
Returns: object - an order structure
See
- https://doc.cryptomus.com/personal/exchange/market-order-creation
- https://doc.cryptomus.com/personal/exchange/limit-order-creation
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified symbol of the market to create an order in |
| type | string | Yes | 'market' or 'limit' or for spot |
| side | string | Yes | 'buy' or 'sell' |
| amount | float | Yes | how much of you want to trade in units of the base currency |
| price | float | No | the price that the order is to be fulfilled, in units of the quote currency, ignored in market orders (only for limit orders) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.cost | float | No | market buy only the quote quantity that can be used as an alternative for the amount |
| params.clientOrderId | string | No | a unique identifier for the order (optional) |
cryptomus.createOrder (symbol, type, side, amount, price?, params?)cancelOrder
cancels an open limit order
Kind: instance method of cryptomus
Returns: object - An order structure
See: https://doc.cryptomus.com/personal/exchange/limit-order-cancellation
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | unified symbol of the market the order was made in (not used in cryptomus) |
| params | object | No | extra parameters specific to the exchange API endpoint |
cryptomus.cancelOrder (id, symbol, params?)fetchOrders
fetches information on multiple orders made by the user
Kind: instance method of cryptomus
Returns: Array<Order> - a list of order structures
See: https://doc.cryptomus.com/personal/exchange/history-of-completed-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol of the market orders were made in (not used in cryptomus) |
| since | int | No | the earliest time in ms to fetch orders for (not used in cryptomus) |
| limit | int | No | the maximum number of order structures to retrieve (not used in cryptomus) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.direction | string | No | order direction 'buy' or 'sell' |
| params.order_id | string | No | order id |
| params.client_order_id | string | No | client order id |
| params.limit | string | No | A special parameter that sets the maximum number of records the request will return |
| params.offset | string | No | A special parameter that sets the number of records from the beginning of the list |
cryptomus.fetchOrders (symbol, since?, limit?, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of cryptomus
Returns: Array<Order> - a list of order structures
See: https://doc.cryptomus.com/personal/exchange/list-of-active-orders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | unified market symbol |
| since | int | No | the earliest time in ms to fetch open orders for (not used in cryptomus) |
| limit | int | No | the maximum number of open orders structures to retrieve (not used in cryptomus) |
| params | object | No | extra parameters specific to the exchange API endpoint |
| params.direction | string | No | order direction 'buy' or 'sell' |
| params.order_id | string | No | order id |
| params.client_order_id | string | No | client order id |
| params.limit | string | No | A special parameter that sets the maximum number of records the request will return |
| params.offset | string | No | A special parameter that sets the number of records from the beginning of the list |
cryptomus.fetchOpenOrders (symbol, since?, limit?, params?)fetchTradingFees
fetch the trading fees for multiple markets
Kind: instance method of cryptomus
Returns: object - a dictionary of fee structures indexed by market symbols
See: https://trade-docs.coinlist.co/?javascript--nodejs#list-fees
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
cryptomus.fetchTradingFees (params?)