btcmarkets

btcmarkets{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchDepositsWithdrawals
• fetchDeposits
• fetchWithdrawals
• fetchMarkets
• fetchTime
• fetchBalance
• fetchOHLCV
• fetchOrderBook
• fetchTicker
• fetchTrades
• createOrder
• cancelOrders
• cancelOrder
• fetchOrder
• fetchOrders
• fetchOpenOrders
• fetchClosedOrders
• fetchMyTrades
• withdraw

fetchDepositsWithdrawals{docsify-ignore}

fetch history of deposits and withdrawals

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

See: https://docs.btcmarkets.net/v3/#tag/Fund-Management-APIs/paths/~1v3~1transfers/get

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

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

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://docs.btcmarkets.net/v3/#tag/Fund-Management-APIs/paths/~1v3~1deposits/get

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

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

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

See: https://docs.btcmarkets.net/v3/#tag/Fund-Management-APIs/paths/~1v3~1withdrawals/get

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

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

fetchMarkets{docsify-ignore}

retrieves data on all markets for btcmarkets

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

See: https://docs.btcmarkets.net/v3/#tag/Market-Data-APIs/paths/~1v3~1markets/get

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

btcmarkets.fetchMarkets (params?)

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

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

See: https://docs.btcmarkets.net/v3/#tag/Misc-APIs/paths/~1v3~1time/get

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

btcmarkets.fetchTime (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 btcmarkets
Returns: object - a balance structure

See: https://docs.btcmarkets.net/v3/#tag/Account-APIs/paths/~1v3~1accounts~1me~1balances/get

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

btcmarkets.fetchBalance (params?)

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 btcmarkets
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See: https://docs.btcmarkets.net/v3/#tag/Market-Data-APIs/paths/~1v3~1markets~1{marketId}~1candles/get

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

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

fetchOrderBook{docsify-ignore}

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

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

See: https://docs.btcmarkets.net/v3/#tag/Market-Data-APIs/paths/~1v3~1markets~1{marketId}~1orderbook/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

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

See: https://docs.btcmarkets.net/v3/#tag/Market-Data-APIs/paths/~1v3~1markets~1{marketId}~1ticker/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

btcmarkets.fetchTicker (symbol, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://docs.btcmarkets.net/v3/#tag/Market-Data-APIs/paths/~1v3~1markets~1{marketId}~1trades/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

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

createOrder{docsify-ignore}

create a trade order

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

See: https://docs.btcmarkets.net/v3/#tag/Order-Placement-APIs/paths/~1v3~1orders/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
params.triggerPrice	float	No	the price at which a trigger order is triggered at

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

cancelOrders{docsify-ignore}

cancel multiple orders

Kind: instance method of btcmarkets
Returns: object - an list of order structures

See: https://docs.btcmarkets.net/v3/#tag/Batch-Order-APIs/paths/~1v3~1batchorders~1{ids}/delete

Param	Type	Required	Description
ids	Array<string>	Yes	order ids
symbol	string	Yes	not used by btcmarkets cancelOrders ()
params	object	No	extra parameters specific to the exchange API endpoint

btcmarkets.cancelOrders (ids, symbol, params?)

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://docs.btcmarkets.net/v3/#operation/cancelOrder

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

btcmarkets.cancelOrder (id, symbol, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://docs.btcmarkets.net/v3/#operation/getOrderById

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

btcmarkets.fetchOrder (id, symbol, params?)

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://docs.btcmarkets.net/v3/#operation/listOrders

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

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://docs.btcmarkets.net/v3/#operation/listOrders

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

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

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://docs.btcmarkets.net/v3/#operation/listOrders

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

btcmarkets.fetchClosedOrders (symbol, since?, limit?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://docs.btcmarkets.net/v3/#operation/getTrades

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

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

withdraw{docsify-ignore}

make a withdrawal

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

See: https://docs.btcmarkets.net/v3/#tag/Fund-Management-APIs/paths/~1v3~1withdrawals/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

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