coinmate

coinmate{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchTime
• fetchMarkets
• fetchBalance
• fetchOrderBook
• fetchTicker
• fetchTickers
• fetchDepositsWithdrawals
• withdraw
• fetchMyTrades
• fetchTrades
• fetchTradingFee
• fetchOpenOrders
• fetchOrders
• createOrder
• fetchOrder
• cancelOrder

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the bingx server

Kind: instance method of coinmate
Returns: int - the current integer timestamp in milliseconds from the bingx server

See: https://coinmate.docs.apiary.io/#reference/system/get-server-time/get

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

coinmate.fetchTime (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for coinmate

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

See: https://coinmate.docs.apiary.io/#reference/trading-pairs/get-trading-pairs/get

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

coinmate.fetchMarkets (params?)

fetchBalance{docsify-ignore}

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

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

See: https://coinmate.docs.apiary.io/#reference/balance/get-balances/post

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

coinmate.fetchBalance (params?)

fetchOrderBook{docsify-ignore}

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

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

See: https://coinmate.docs.apiary.io/#reference/order-book/get-order-book/get

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

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

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 coinmate
Returns: object - a ticker structure

See: https://coinmate.docs.apiary.io/#reference/ticker/get-ticker/get

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

coinmate.fetchTicker (symbol, params?)

fetchTickers{docsify-ignore}

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

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

See: https://coinmate.docs.apiary.io/#reference/ticker/get-ticker-all/get

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

coinmate.fetchTickers (symbols, params?)

fetchDepositsWithdrawals{docsify-ignore}

fetch history of deposits and withdrawals

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

See: https://coinmate.docs.apiary.io/#reference/transfers/get-transfer-history/post

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

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

withdraw{docsify-ignore}

make a withdrawal

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

See

• https://coinmate.docs.apiary.io/#reference/bitcoin-withdrawal-and-deposit/withdraw-bitcoins/post
• https://coinmate.docs.apiary.io/#reference/litecoin-withdrawal-and-deposit/withdraw-litecoins/post
• https://coinmate.docs.apiary.io/#reference/ethereum-withdrawal-and-deposit/withdraw-ethereum/post
• https://coinmate.docs.apiary.io/#reference/ripple-withdrawal-and-deposit/withdraw-ripple/post
• https://coinmate.docs.apiary.io/#reference/cardano-withdrawal-and-deposit/withdraw-cardano/post
• https://coinmate.docs.apiary.io/#reference/solana-withdrawal-and-deposit/withdraw-solana/post

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

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

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://coinmate.docs.apiary.io/#reference/trade-history/get-trade-history/post

Param	Type	Required	Description
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 structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

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

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://coinmate.docs.apiary.io/#reference/transactions/transactions/get

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

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

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of coinmate
Returns: object - a fee structure

See: https://coinmate.docs.apiary.io/#reference/trader-fees/get-trading-fees/post

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the exchange API endpoint

coinmate.fetchTradingFee (symbol, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://coinmate.docs.apiary.io/#reference/order/get-open-orders/post

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

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

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://coinmate.docs.apiary.io/#reference/order/order-history/post

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

coinmate.fetchOrders (symbol, since?, limit?, params?)

createOrder{docsify-ignore}

create a trade order

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

See

• https://coinmate.docs.apiary.io/#reference/order/buy-limit-order/post
• https://coinmate.docs.apiary.io/#reference/order/sell-limit-order/post
• https://coinmate.docs.apiary.io/#reference/order/buy-instant-order/post
• https://coinmate.docs.apiary.io/#reference/order/sell-instant-order/post

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

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

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See

• https://coinmate.docs.apiary.io/#reference/order/get-order-by-orderid/post
• https://coinmate.docs.apiary.io/#reference/order/get-order-by-clientorderid/post

Param	Type	Required	Description
id	string	Yes	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

coinmate.fetchOrder (id, symbol, params?)

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://coinmate.docs.apiary.io/#reference/order/cancel-order/post

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	not used by coinmate cancelOrder ()
params	object	No	extra parameters specific to the exchange API endpoint

coinmate.cancelOrder (id, symbol, params?)