ContextQMD
Back to Ccxt

Cryptocom

wiki/exchanges/cryptocom.md

4.5.5255.0 KB
Original Source

<a name="cryptocom" id="cryptocom"></a>

cryptocom{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

<a name="fetchCurrencies" id="fetchcurrencies"></a>

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - an associative dictionary of currencies

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-currency-networks

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchCurrencies ([params])

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for cryptocom

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

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-instruments

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchMarkets ([params])

<a name="fetchTickers" id="fetchtickers"></a>

fetchTickers{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a dictionary of ticker structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yesunified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchTickers (symbols[, params])

<a name="fetchTicker" id="fetchticker"></a>

fetchTicker{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a ticker structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-tickers

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchTicker (symbol[, params])

<a name="fetchOrders" id="fetchorders"></a>

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-order-history

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market the orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for, max date range is one day
limit<code>int</code>Nothe maximum number of order structures to retrieve, default 100 max 100
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms for the ending date filter, default is the current time
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
cryptocom.fetchOrders (symbol[, since, limit, params])

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get a list of the most recent trades for a particular symbol

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-trades

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch, maximum date range is one day
limit<code>int</code>Nothe maximum number of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms for the ending date filter, default is the current time
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
cryptocom.fetchTrades (symbol[, since, limit, params])

<a name="fetchOHLCV" id="fetchohlcv"></a>

fetchOHLCV{docsify-ignore}

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

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

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-candlestick

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms for the ending date filter, default is the current time
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
cryptocom.fetchOHLCV (symbol, timeframe[, since, limit, params])

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-book

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe number of order book entries to return, max 50
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchOrderBook (symbol[, limit, params])

<a name="fetchBalance" id="fetchbalance"></a>

fetchBalance{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a balance structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-user-balance

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchBalance ([params])

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - An order structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-order-detail

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchOrder (id, symbol[, params])

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - an order structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-order

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market', 'limit', 'stop_loss', 'stop_limit', 'take_profit', 'take_profit_limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.timeInForce<code>string</code>No'GTC', 'IOC', 'FOK' or 'PO'
params.ref_price_type<code>string</code>No'MARK_PRICE', 'INDEX_PRICE', 'LAST_PRICE' which trigger price type to use, default is MARK_PRICE
params.triggerPrice<code>float</code>Noprice to trigger a trigger order
params.stopLossPrice<code>float</code>Noprice to trigger a stop-loss trigger order
params.takeProfitPrice<code>float</code>Noprice to trigger a take-profit trigger order
javascript
cryptocom.createOrder (symbol, type, side, amount[, price, params])

<a name="createOrders" id="createorders"></a>

createOrders{docsify-ignore}

create a list of trade orders

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - an order structure

See

ParamTypeRequiredDescription
orders<code>Array</code>Yeslist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.createOrders (orders[, params])

<a name="editOrder" id="editorder"></a>

editOrder{docsify-ignore}

edit a trade order

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - an order structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-amend-order

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified market symbol of the order to edit
type<code>string</code>Nonot used by cryptocom editOrder
side<code>string</code>Nonot used by cryptocom editOrder
amount<code>float</code>Yes(mandatory) how much of the currency you want to trade in units of the base currency
price<code>float</code>Yes(mandatory) the price for the order, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.clientOrderId<code>string</code>Nothe original client order id of the order to edit, required if id is not provided
javascript
cryptocom.editOrder (id, symbol[, type, side, amount, price, params])

<a name="cancelAllOrders" id="cancelallorders"></a>

cancelAllOrders{docsify-ignore}

cancel all open orders

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - Returns exchange raw messagehttps://docs.ccxt.com/?id=order-structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-all-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the orders to cancel
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.cancelAllOrders (symbol[, params])

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - An order structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order

ParamTypeRequiredDescription
id<code>string</code>Yesthe order id of the order to cancel
symbol<code>string</code>Nounified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.cancelOrder (id[, symbol, params])

<a name="cancelOrders" id="cancelorders"></a>

cancelOrders{docsify-ignore}

cancel multiple orders

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - an list of order structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order-list-list

ParamTypeRequiredDescription
ids<code>Array<string></code>Yesorder ids
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.cancelOrders (ids, symbol[, params])

<a name="cancelOrdersForSymbols" id="cancelordersforsymbols"></a>

cancelOrdersForSymbols{docsify-ignore}

cancel multiple orders for multiple symbols

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - an list of order structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order-list-list

ParamTypeRequiredDescription
orders<code>Array<CancellationRequest></code>Yeseach order should contain the parameters required by cancelOrder namely id and symbol, example [{"id": "a", "symbol": "BTC/USDT"}, {"id": "b", "symbol": "ETH/USDT"}]
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.cancelOrdersForSymbols (orders[, params])

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<Order></code> - a list of order structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-open-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch open orders for
limit<code>int</code>Nothe maximum number of open order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchOpenOrders (symbol[, since, limit, params])

<a name="fetchMyTrades" id="fetchmytrades"></a>

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-trades

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for, maximum date range is one day
limit<code>int</code>Nothe maximum number of trade structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms for the ending date filter, default is the current time
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
cryptocom.fetchMyTrades (symbol[, since, limit, params])

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a transaction structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-withdrawal

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesthe address to withdraw to
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.withdraw (code, amount, address, tag[, params])

<a name="fetchDepositAddressesByNetwork" id="fetchdepositaddressesbynetwork"></a>

fetchDepositAddressesByNetwork{docsify-ignore}

fetch a dictionary of addresses for a currency, indexed by network

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a dictionary of address structures indexed by the network

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-deposit-address

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency for the deposit address
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchDepositAddressesByNetwork (code[, params])

<a name="fetchDepositAddress" id="fetchdepositaddress"></a>

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - an address structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-deposit-address

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchDepositAddress (code[, params])

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-deposit-history

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms for the ending date filter, default is the current time
javascript
cryptocom.fetchDeposits (code[, since, limit, params])

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-withdrawal-history

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms for the ending date filter, default is the current time
javascript
cryptocom.fetchWithdrawals (code[, since, limit, params])

<a name="fetchDepositWithdrawFees" id="fetchdepositwithdrawfees"></a>

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdraw fees

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a list of fee structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-currency-networks

ParamTypeRequiredDescription
codes<code>Array<string></code>, <code>undefined</code>Yeslist of unified currency codes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchDepositWithdrawFees (codes[, params])

<a name="fetchLedger" id="fetchledger"></a>

fetchLedger{docsify-ignore}

fetch the history of changes, actions done by the user or operations that altered the balance of the user

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a ledger structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-transactions

ParamTypeRequiredDescription
code<code>string</code>Nounified currency code
since<code>int</code>Notimestamp in ms of the earliest ledger entry
limit<code>int</code>Nomax number of ledger entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms for the ending date filter, default is the current time
javascript
cryptocom.fetchLedger ([code, since, limit, params])

<a name="fetchAccounts" id="fetchaccounts"></a>

fetchAccounts{docsify-ignore}

fetch all the accounts associated with a profile

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a dictionary of account structures indexed by the account type

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-accounts

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchAccounts ([params])

<a name="fetchSettlementHistory" id="fetchsettlementhistory"></a>

fetchSettlementHistory{docsify-ignore}

fetches historical settlement records

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of settlement history objects

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-expired-settlement-price

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the settlement history
since<code>int</code>Notimestamp in ms
limit<code>int</code>Nonumber of records
params<code>object</code>Noexchange specific params
params.type<code>int</code>No'future', 'option'
javascript
cryptocom.fetchSettlementHistory (symbol[, since, limit, params])

<a name="fetchFundingRate" id="fetchfundingrate"></a>

fetchFundingRate{docsify-ignore}

fetches historical funding rates

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of funding rate structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-valuations

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the funding rate history for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchFundingRate (symbol[, params])

<a name="fetchFundingRateHistory" id="fetchfundingratehistory"></a>

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rates

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of funding rate structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#public-get-valuations

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the funding rate history for
since<code>int</code>Notimestamp in ms of the earliest funding rate to fetch
limit<code>int</code>Nothe maximum amount of [funding rate structures] to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms for the ending date filter, default is the current time
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
cryptocom.fetchFundingRateHistory (symbol[, since, limit, params])

<a name="fetchPosition" id="fetchposition"></a>

fetchPosition{docsify-ignore}

fetch data on a single open contract trade position

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a position structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-positions

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market the position is held in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchPosition (symbol[, params])

<a name="fetchPositions" id="fetchpositions"></a>

fetchPositions{docsify-ignore}

fetch all open positions

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of position structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-positions

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yeslist of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchPositions (symbols[, params])

<a name="closePositions" id="closepositions"></a>

closePositions{docsify-ignore}

closes open positions for a market

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - A list of position structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-close-position

ParamTypeRequiredDescription
symbol<code>string</code>YesUnified CCXT market symbol
side<code>string</code>Nonot used by cryptocom.closePositions
params<code>object</code>Noextra parameters specific to the okx api endpoint EXCHANGE SPECIFIC PARAMETERS
params.type<code>string</code>NoLIMIT or MARKET
params.price<code>number</code>Nofor limit orders only
javascript
cryptocom.closePositions (symbol[, side, params])

<a name="fetchTradingFee" id="fetchtradingfee"></a>

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a fee structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-instrument-fee-rate

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchTradingFee (symbol[, params])

<a name="fetchTradingFees" id="fetchtradingfees"></a>

fetchTradingFees{docsify-ignore}

fetch the trading fees for multiple markets

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a dictionary of fee structures indexed by market symbols

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-get-fee-rate

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.fetchTradingFees ([params])

<a name="watchOrderBook" id="watchorderbook"></a>

watchOrderBook{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#book-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.bookSubscriptionType<code>string</code>NoThe subscription type. Allowed values: SNAPSHOT full snapshot. This is the default if not specified. SNAPSHOT_AND_UPDATE delta updates
params.bookUpdateFrequency<code>int</code>NoBook update interval in ms. Allowed values: 100 for snapshot subscription 10 for delta subscription
javascript
cryptocom.watchOrderBook (symbol[, limit, params])

<a name="unWatchOrderBook" id="unwatchorderbook"></a>

unWatchOrderBook{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#book-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.bookSubscriptionType<code>string</code>NoThe subscription type. Allowed values: SNAPSHOT full snapshot. This is the default if not specified. SNAPSHOT_AND_UPDATE delta updates
params.bookUpdateFrequency<code>int</code>NoBook update interval in ms. Allowed values: 100 for snapshot subscription 10 for delta subscription
javascript
cryptocom.unWatchOrderBook (symbol[, params])

<a name="watchOrderBookForSymbols" id="watchorderbookforsymbols"></a>

watchOrderBookForSymbols{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#book-instrument_name

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified array of symbols
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.bookSubscriptionType<code>string</code>NoThe subscription type. Allowed values: SNAPSHOT full snapshot. This is the default if not specified. SNAPSHOT_AND_UPDATE delta updates
params.bookUpdateFrequency<code>int</code>NoBook update interval in ms. Allowed values: 100 for snapshot subscription 10 for delta subscription
javascript
cryptocom.watchOrderBookForSymbols (symbols[, limit, params])

<a name="unWatchOrderBookForSymbols" id="unwatchorderbookforsymbols"></a>

unWatchOrderBookForSymbols{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#book-instrument_name

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified array of symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.limit<code>int</code>Noorderbook limit, default is 50
params.bookSubscriptionType<code>string</code>NoThe subscription type. Allowed values: SNAPSHOT full snapshot. This is the default if not specified. SNAPSHOT_AND_UPDATE delta updates
params.bookUpdateFrequency<code>int</code>NoBook update interval in ms. Allowed values: 100 for snapshot subscription 10 for delta subscription
javascript
cryptocom.unWatchOrderBookForSymbols (symbols[, params])

<a name="watchTrades" id="watchtrades"></a>

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#trade-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchTrades (symbol[, since, limit, params])

<a name="unWatchTrades" id="unwatchtrades"></a>

unWatchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#trade-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.unWatchTrades (symbol[, params])

<a name="watchTradesForSymbols" id="watchtradesforsymbols"></a>

watchTradesForSymbols{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#trade-instrument_name

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchTradesForSymbols (symbols[, since, limit, params])

<a name="unWatchTradesForSymbols" id="unwatchtradesforsymbols"></a>

unWatchTradesForSymbols{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#trade-instrument_name

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nolist of unified market symbols to unwatch trades for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.unWatchTradesForSymbols ([symbols, params])

<a name="watchMyTrades" id="watchmytrades"></a>

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-trade-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market trades were made in
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trade structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchMyTrades (symbol[, since, limit, params])

<a name="watchTicker" id="watchticker"></a>

watchTicker{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a ticker structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#ticker-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchTicker (symbol[, params])

<a name="unWatchTicker" id="unwatchticker"></a>

unWatchTicker{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a ticker structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#ticker-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.unWatchTicker (symbol[, params])

<a name="watchTickers" id="watchtickers"></a>

watchTickers{docsify-ignore}

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 <code>cryptocom</code>
Returns: <code>object</code> - a ticker structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#ticker-instrument_name

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchTickers (symbols[, params])

<a name="unWatchTickers" id="unwatchtickers"></a>

unWatchTickers{docsify-ignore}

unWatches a price ticker

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a ticker structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#ticker-instrument_name

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.unWatchTickers (symbols[, params])

<a name="watchBidsAsks" id="watchbidsasks"></a>

watchBidsAsks{docsify-ignore}

watches best bid & ask for symbols

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a ticker structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#ticker-instrument_name

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchBidsAsks (symbols[, params])

<a name="watchOHLCV" id="watchohlcv"></a>

watchOHLCV{docsify-ignore}

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

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

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#candlestick-time_frame-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchOHLCV (symbol, timeframe[, since, limit, params])

<a name="unWatchOHLCV" id="unwatchohlcv"></a>

unWatchOHLCV{docsify-ignore}

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

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

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#candlestick-time_frame-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.unWatchOHLCV (symbol, timeframe[, params])

<a name="watchOrders" id="watchorders"></a>

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of order structures

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-order-instrument_name

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchOrders (symbol[, since, limit, params])

<a name="watchPositions" id="watchpositions"></a>

watchPositions{docsify-ignore}

watch all open positions

Kind: instance method of <code>cryptocom</code>
Returns: <code>Array<object></code> - a list of position structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-position_balance

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nolist of unified market symbols to watch positions for
since<code>int</code>Nothe earliest time in ms to fetch positions for
limit<code>int</code>Nothe maximum number of positions to retrieve
params<code>object</code>Yesextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchPositions ([symbols, since, limit, params])

<a name="watchBalance" id="watchbalance"></a>

watchBalance{docsify-ignore}

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

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - a balance structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#user-balance

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.watchBalance ([params])

<a name="createOrderWs" id="createorderws"></a>

createOrderWs{docsify-ignore}

create a trade order

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - an order structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-create-order

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of currency you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.createOrderWs (symbol, type, side, amount[, price, params])

<a name="editOrderWs" id="editorderws"></a>

editOrderWs{docsify-ignore}

edit a trade order

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - an order structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-amend-order

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified market symbol of the order to edit
type<code>string</code>Nonot used by cryptocom editOrder
side<code>string</code>Nonot used by cryptocom editOrder
amount<code>float</code>Yes(mandatory) how much of the currency you want to trade in units of the base currency
price<code>float</code>Yes(mandatory) the price for the order, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.clientOrderId<code>string</code>Nothe original client order id of the order to edit, required if id is not provided
javascript
cryptocom.editOrderWs (id, symbol[, type, side, amount, price, params])

<a name="cancelOrderWs" id="cancelorderws"></a>

cancelOrderWs{docsify-ignore}

cancels an open order

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - An order structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-order

ParamTypeRequiredDescription
id<code>string</code>Yesthe order id of the order to cancel
symbol<code>string</code>Nounified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.cancelOrderWs (id[, symbol, params])

<a name="cancelAllOrdersWs" id="cancelallordersws"></a>

cancelAllOrdersWs{docsify-ignore}

cancel all open orders

Kind: instance method of <code>cryptocom</code>
Returns: <code>object</code> - Returns exchange raw message https://docs.ccxt.com/?id=order-structure

See: https://exchange-docs.crypto.com/exchange/v1/rest-ws/index.html#private-cancel-all-orders

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the orders to cancel
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
cryptocom.cancelAllOrdersWs (symbol[, params])