Spec
a b c d e f g h i j k l m n o p q r s t u v w x y z
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchTicker
- fetchTickers
- fetchOrderBook
- fetchOHLCV
- createOrder
- cancelOrder
- fetchOrder
- fetchOpenOrders
- fetchOrderTrades
- fetchMyTrades
- fetchBalance
retrieves data on all markets for ace
Kind: instance method of ace
Returns: Array.<object> - an array of objects representing market data
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#oapi-api---market-pair
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
ace.fetchMarkets (params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of ace
Returns: object - a ticker structure
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#oapi-api---trade-data
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the ace api endpoint |
ace.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of ace
Returns: object - a dictionary of ticker structures
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#oapi-api---trade-data
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the ace api endpoint |
ace.fetchTickers (symbols, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of ace
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---order-books
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the ace api endpoint |
ace.fetchOrderBook (symbol, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of ace
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---klinecandlestick-data
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the ace api endpoint |
ace.fetchOHLCV (symbol, timeframe, since, limit, params)create a trade order
Kind: instance method of ace
Returns: object - an order structure
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---new-order
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the ace api endpoint |
ace.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of ace
Returns: object - An order structure
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---cancel-order
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the ace api endpoint |
ace.cancelOrder (id, symbol, params)fetches information on an order made by the user
Kind: instance method of ace
Returns: object - An order structure
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---order-status
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the ace api endpoint |
ace.fetchOrder (symbol, params)fetch all unfilled currently open orders
Kind: instance method of ace
Returns: Array.<object> - a list of order structures
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---order-list
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the ace api endpoint |
ace.fetchOpenOrders (symbol, since, limit, params)fetch all the trades made from a single order
Kind: instance method of ace
Returns: Array.<object> - a list of trade structures
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---order-history
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades to retrieve |
| params | object |
extra parameters specific to the ace api endpoint |
ace.fetchOrderTrades (id, symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of ace
Returns: Array.<object> - a list of trade structures
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---trade-list
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the ace api endpoint |
ace.fetchMyTrades (symbol, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of ace
Returns: object - a balance structure
See: https://github.com/ace-exchange/ace-official-api-docs/blob/master/api_v2.md#open-api---account-balance
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the ace api endpoint |
ace.fetchBalance (params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchTrades
- fetchOrderBook
- fetchOHLCV
- createOrder
- cancelOrder
- fetchOrder
- fetchOpenOrders
retrieves data on all markets for alpaca
Kind: instance method of alpaca
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
alpaca.fetchMarkets (params)get the list of most recent trades for a particular symbol
Kind: instance method of alpaca
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the alpaca api endpoint |
alpaca.fetchTrades (symbol, since, limit, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of alpaca
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the alpaca api endpoint |
alpaca.fetchOrderBook (symbol, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of alpaca
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the alpha api endpoint |
alpaca.fetchOHLCV (symbol, timeframe, since, limit, params)create a trade order
Kind: instance method of alpaca
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market', 'limit' or 'stop_limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price | float |
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the alpaca api endpoint |
| params.triggerPrice | float |
The price at which a trigger order is triggered at |
alpaca.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of alpaca
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the alpaca api endpoint |
alpaca.cancelOrder (id, symbol, params)fetches information on an order made by the user
Kind: instance method of alpaca
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the alpaca api endpoint |
alpaca.fetchOrder (symbol, params)fetch all unfilled currently open orders
Kind: instance method of alpaca
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the alpaca api endpoint |
alpaca.fetchOpenOrders (symbol, since, limit, params)Kind: global class
Extends: Exchange
- fetchCurrencies
- fetchMarkets
- fetchTime
- fetchAccounts
- fetchBalance
- fetchOrderBook
- fetchTicker
- fetchTickers
- fetchOHLCV
- fetchTrades
- fetchTradingFees
- createOrder
- fetchOrder
- fetchOpenOrders
- fetchClosedOrders
- cancelOrder
- cancelAllOrders
- fetchDepositAddress
- fetchDeposits
- fetchWithdrawals
- fetchTransactions
- fetchPositions
- fetchFundingRates
- reduceMargin
- addMargin
- setLeverage
- setMarginMode
- fetchLeverageTiers
- fetchDepositWithdrawFees
- transfer
fetches all available currencies on an exchange
Kind: instance method of ascendex
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchCurrencies (params)retrieves data on all markets for ascendex
Kind: instance method of ascendex
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
ascendex.fetchMarkets (params)fetches the current integer timestamp in milliseconds from the ascendex server
Kind: instance method of ascendex
Returns: int - the current integer timestamp in milliseconds from the ascendex server
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchTime (params)fetch all the accounts associated with a profile
Kind: instance method of ascendex
Returns: object - a dictionary of account structures indexed by the account type
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchAccounts (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of ascendex
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of ascendex
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of ascendex
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of ascendex
Returns: object - a dictionary of ticker structures
See
- https://ascendex.github.io/ascendex-pro-api/#ticker
- https://ascendex.github.io/ascendex-futures-pro-api-v2/#ticker
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchTickers (symbols, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of ascendex
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchOHLCV (symbol, timeframe, since, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of ascendex
Returns: Array.<object> - a list of trade structures
See: https://ascendex.github.io/ascendex-pro-api/#market-trades
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchTrades (symbol, since, limit, params)fetch the trading fees for multiple markets
Kind: instance method of ascendex
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchTradingFees (params)Create an order on the exchange
Kind: instance method of ascendex
Returns: An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
Unified CCXT market symbol |
| type | string |
"limit" or "market" |
| side | string |
"buy" or "sell" |
| amount | float |
the amount of currency to trade |
| price | float |
ignored in "market" orders the price at which the order is to be fullfilled at in units of the quote currency |
| params | object |
Extra parameters specific to the exchange API endpoint |
| params.timeInForce | string |
"GTC", "IOC", "FOK", or "PO" |
| params.postOnly | bool |
true or false |
| params.stopPrice | float |
The price at which a trigger order is triggered at |
ascendex.createOrder (symbol, type, side, amount, price, params)fetches information on an order made by the user
Kind: instance method of ascendex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchOrder (symbol, params)fetch all unfilled currently open orders
Kind: instance method of ascendex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of ascendex
Returns: Array.<object> - a list of order structures
See: https://ascendex.github.io/ascendex-pro-api/#list-history-orders-v2
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the ascendex api endpoint |
| params.until |
int | undefined
|
the latest time in ms to fetch orders for |
ascendex.fetchClosedOrders (symbol, since, limit, params)cancels an open order
Kind: instance method of ascendex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.cancelOrder (id, symbol, params)cancel all open orders
Kind: instance method of ascendex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.cancelAllOrders (symbol, params)fetch the deposit address for a currency associated with this account
Kind: instance method of ascendex
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchDepositAddress (code, params)fetch all deposits made to an account
Kind: instance method of ascendex
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of ascendex
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchWithdrawals (code, since, limit, params)DEPRECATED, use fetchDepositsWithdrawals instead
Kind: instance method of ascendex
Returns: object - a list of transaction structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code for the currency of the transactions, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest transaction, default is undefined |
| limit |
int | undefined
|
max number of transactions to return, default is undefined |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchTransactions (code, since, limit, params)fetch all open positions
Kind: instance method of ascendex
Returns: Array.<object> - a list of position structure
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchPositions (symbols, params)fetch the funding rate for multiple markets
Kind: instance method of ascendex
Returns: object - a dictionary of funding rates structures, indexe by market symbols
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchFundingRates (symbols, params)remove margin from a position
Kind: instance method of ascendex
Returns: object - a margin structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| amount | float |
the amount of margin to remove |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.reduceMargin (symbol, amount, params)add margin
Kind: instance method of ascendex
Returns: object - a margin structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| amount | float |
amount of margin to add |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.addMargin (symbol, amount, params)set the level of leverage for a market
Kind: instance method of ascendex
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| leverage | float |
the rate of leverage |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.setLeverage (leverage, symbol, params)set margin mode to 'cross' or 'isolated'
Kind: instance method of ascendex
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| marginMode | string |
'cross' or 'isolated' |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.setMarginMode (marginMode, symbol, params)retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes
Kind: instance method of ascendex
Returns: object - a dictionary of leverage tiers structures, indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchLeverageTiers (symbols, params)fetch deposit and withdraw fees
Kind: instance method of ascendex
Returns: object - a list of fee structures
See: https://ascendex.github.io/ascendex-pro-api/#list-all-assets
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.fetchDepositWithdrawFees (codes, params)transfer currency internally between wallets on the same account
Kind: instance method of ascendex
Returns: object - a transfer structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
amount to transfer |
| fromAccount | string |
account to transfer from |
| toAccount | string |
account to transfer to |
| params | object |
extra parameters specific to the ascendex api endpoint |
ascendex.transfer (code, amount, fromAccount, toAccount, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchTicker
- fetchTickers
- fetchTime
- fetchOrderBook
- fetchTrades
- fetchOHLCV
- fetchBalance
- createOrder
- cancelOrder
- cancelAllOrders
- fetchOrder
- fetchOrders
- fetchMyTrades
- fetchOpenOrders
- fetchClosedOrders
- fetchDepositAddress
- fetchDeposits
- fetchWithdrawals
- transfer
- withdraw
retrieves data on all markets for bigone
Kind: instance method of bigone
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bigone.fetchMarkets (params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bigone
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bigone
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchTickers (symbols, params)fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of bigone
Returns: int - the current integer timestamp in milliseconds from the exchange server
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchTime (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bigone
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchOrderBook (symbol, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bigone
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchTrades (symbol, since, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bigone
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchOHLCV (symbol, timeframe, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bigone
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchBalance (params)create a trade order
Kind: instance method of bigone
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bigone
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
Not used by bigone cancelOrder () |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.cancelOrder (id, symbol, params)cancel all open orders
Kind: instance method of bigone
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.cancelAllOrders (symbol, params)fetches information on an order made by the user
Kind: instance method of bigone
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
not used by bigone fetchOrder |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchOrder (symbol, params)fetches information on multiple orders made by the user
Kind: instance method of bigone
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchOrders (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bigone
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchMyTrades (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of bigone
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bigone
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchClosedOrders (symbol, since, limit, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bigone
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchDepositAddress (code, params)fetch all deposits made to an account
Kind: instance method of bigone
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of bigone
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.fetchWithdrawals (code, since, limit, params)transfer currency internally between wallets on the same account
Kind: instance method of bigone
Returns: object - a transfer structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
amount to transfer |
| fromAccount | string |
account to transfer from |
| toAccount | string |
account to transfer to |
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.transfer (code, amount, fromAccount, toAccount, params)make a withdrawal
Kind: instance method of bigone
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bigone api endpoint |
bigone.withdraw (code, amount, address, tag, params)Kind: global class
Extends: Exchange
- fetchTime
- fetchCurrencies
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchStatus
- fetchTicker
- fetchBidsAsks
- fetchLastPrices
- fetchTickers
- fetchOHLCV
- fetchTrades
- editSpotOrder
- editOrder
- editOrder
- createOrder
- fetchOrder
- fetchOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchCanceledOrders
- cancelOrder
- cancelAllOrders
- fetchOrderTrades
- fetchMyTrades
- fetchMyDustTrades
- fetchDeposits
- fetchWithdrawals
- transfer
- fetchTransfers
- fetchDepositAddress
- fetchTransactionFees
- fetchDepositWithdrawFees
- withdraw
- fetchTradingFee
- fetchTradingFees
- futuresTransfer
- fetchFundingRate
- fetchFundingRateHistory
- fetchFundingRates
- fetchLeverageTiers
- fetchPosition
- fetchOptionPositions
- fetchPositions
- fetchAccountPositions
- fetchPositionsRisk
- fetchFundingHistory
- setLeverage
- setMarginMode
- setPositionMode
- fetchSettlementHistory
- fetchLedger
- reduceMargin
- addMargin
- fetchBorrowRate
- fetchBorrowRateHistory
- createGiftCode
- redeemGiftCode
- verifyGiftCode
- fetchBorrowInterest
- repayMargin
- borrowMargin
- fetchOpenInterestHistory
- fetchOpenInterest
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of binance
Returns: int - the current integer timestamp in milliseconds from the exchange server
See
- https://binance-docs.github.io/apidocs/spot/en/#check-server-time // spot
- https://binance-docs.github.io/apidocs/futures/en/#check-server-time // swap
- https://binance-docs.github.io/apidocs/delivery/en/#check-server-time // future
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchTime (params)fetches all available currencies on an exchange
Kind: instance method of binance
Returns: object - an associative dictionary of currencies
See: https://binance-docs.github.io/apidocs/spot/en/#all-coins-39-information-user_data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchCurrencies (params)retrieves data on all markets for binance
Kind: instance method of binance
Returns: Array.<object> - an array of objects representing market data
See
- https://binance-docs.github.io/apidocs/spot/en/#exchange-information // spot
- https://binance-docs.github.io/apidocs/futures/en/#exchange-information // swap
- https://binance-docs.github.io/apidocs/delivery/en/#exchange-information // future
- https://binance-docs.github.io/apidocs/voptions/en/#exchange-information // option
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
binance.fetchMarkets (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of binance
Returns: object - a balance structure
See
- https://binance-docs.github.io/apidocs/spot/en/#account-information-user_data // spot
- https://binance-docs.github.io/apidocs/spot/en/#query-cross-margin-account-details-user_data // cross margin
- https://binance-docs.github.io/apidocs/spot/en/#query-isolated-margin-account-info-user_data // isolated margin
- https://binance-docs.github.io/apidocs/spot/en/#lending-account-user_data // lending
- https://binance-docs.github.io/apidocs/spot/en/#funding-wallet-user_data // funding
- https://binance-docs.github.io/apidocs/futures/en/#account-information-v2-user_data // swap
- https://binance-docs.github.io/apidocs/delivery/en/#account-information-user_data // future
- https://binance-docs.github.io/apidocs/voptions/en/#option-account-information-trade // option
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the binance api endpoint |
| params.type |
string | undefined
|
'future', 'delivery', 'savings', 'funding', or 'spot' |
| params.marginMode |
string | undefined
|
'cross' or 'isolated', for margin trading, uses this.options.defaultMarginMode if not passed, defaults to undefined/None/null |
| params.symbols |
Array.<string> | undefined
|
unified market symbols, only used in isolated margin mode |
binance.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of binance
Returns: object - A dictionary of order book structures indexed by market symbols
See
- https://binance-docs.github.io/apidocs/spot/en/#order-book // spot
- https://binance-docs.github.io/apidocs/futures/en/#order-book // swap
- https://binance-docs.github.io/apidocs/delivery/en/#order-book // future
- https://binance-docs.github.io/apidocs/voptions/en/#order-book // option
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchOrderBook (symbol, limit, params)the latest known information on the availability of the exchange API
Kind: instance method of binance
Returns: object - a status structure
See: https://binance-docs.github.io/apidocs/spot/en/#system-status-system
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchStatus (params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of binance
Returns: object - a ticker structure
See
- https://binance-docs.github.io/apidocs/spot/en/#24hr-ticker-price-change-statistics // spot
- https://binance-docs.github.io/apidocs/futures/en/#24hr-ticker-price-change-statistics // swap
- https://binance-docs.github.io/apidocs/delivery/en/#24hr-ticker-price-change-statistics // future
- https://binance-docs.github.io/apidocs/voptions/en/#24hr-ticker-price-change-statistics // option
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchTicker (symbol, params)fetches the bid and ask price and volume for multiple markets
Kind: instance method of binance
Returns: object - a dictionary of ticker structures
See
- https://binance-docs.github.io/apidocs/spot/en/#symbol-order-book-ticker // spot
- https://binance-docs.github.io/apidocs/futures/en/#symbol-order-book-ticker // swap
- https://binance-docs.github.io/apidocs/delivery/en/#symbol-order-book-ticker // future
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchBidsAsks (symbols, params)fetches the last price for multiple markets
Kind: instance method of binance
Returns: object - a dictionary of ticker structures
See
- https://binance-docs.github.io/apidocs/spot/en/#symbol-price-ticker // spot
- https://binance-docs.github.io/apidocs/future/en/#symbol-price-ticker // swap
- https://binance-docs.github.io/apidocs/delivery/en/#symbol-price-ticker // future
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the last prices |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchLastPrices (symbols, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of binance
Returns: object - a dictionary of ticker structures
See
- https://binance-docs.github.io/apidocs/spot/en/#24hr-ticker-price-change-statistics // spot
- https://binance-docs.github.io/apidocs/futures/en/#24hr-ticker-price-change-statistics // swap
- https://binance-docs.github.io/apidocs/delivery/en/#24hr-ticker-price-change-statistics // future
- https://binance-docs.github.io/apidocs/voptions/en/#24hr-ticker-price-change-statistics // option
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchTickers (symbols, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of binance
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the binance api endpoint |
| params.price |
string | undefined
|
"mark" or "index" for mark price and index price candles |
| params.until |
int | undefined
|
timestamp in ms of the latest candle to fetch |
binance.fetchOHLCV (symbol, timeframe, since, limit, params)get the list of most recent trades for a particular symbol Default fetchTradesMethod
Kind: instance method of binance
Returns: Array.<object> - a list of trade structures
See
- https://binance-docs.github.io/apidocs/spot/en/#compressed-aggregate-trades-list // publicGetAggTrades (spot)
- https://binance-docs.github.io/apidocs/futures/en/#compressed-aggregate-trades-list // fapiPublicGetAggTrades (swap)
- https://binance-docs.github.io/apidocs/delivery/en/#compressed-aggregate-trades-list // dapiPublicGetAggTrades (future)
- https://binance-docs.github.io/apidocs/voptions/en/#recent-trades-list // eapiPublicGetTrades (option) Other fetchTradesMethod
- https://binance-docs.github.io/apidocs/spot/en/#recent-trades-list // publicGetTrades (spot)
- https://binance-docs.github.io/apidocs/futures/en/#recent-trades-list // fapiPublicGetTrades (swap)
- https://binance-docs.github.io/apidocs/delivery/en/#recent-trades-list // dapiPublicGetTrades (future)
- https://binance-docs.github.io/apidocs/spot/en/#old-trade-lookup-market_data // publicGetHistoricalTrades (spot)
- https://binance-docs.github.io/apidocs/future/en/#old-trade-lookup-market_data // fapiPublicGetHistoricalTrades (swap)
- https://binance-docs.github.io/apidocs/delivery/en/#old-trade-lookup-market_data // dapiPublicGetHistoricalTrades (future)
- https://binance-docs.github.io/apidocs/voptions/en/#old-trade-lookup-market_data // eapiPublicGetHistoricalTrades (option)
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
only used when fetchTradesMethod is 'publicGetAggTrades', 'fapiPublicGetAggTrades', or 'dapiPublicGetAggTrades' |
| limit |
int | undefined
|
default 500, max 1000 |
| params | object |
extra parameters specific to the binance api endpoint |
| params.until |
int | undefined
|
only used when fetchTradesMethod is 'publicGetAggTrades', 'fapiPublicGetAggTrades', or 'dapiPublicGetAggTrades' |
| params.fetchTradesMethod |
int | undefined
|
'publicGetAggTrades' (spot default), 'fapiPublicGetAggTrades' (swap default), 'dapiPublicGetAggTrades' (future default), 'eapiPublicGetTrades' (option default), 'publicGetTrades', 'fapiPublicGetTrades', 'dapiPublicGetTrades', 'publicGetHistoricalTrades', 'fapiPublicGetHistoricalTrades', 'dapiPublicGetHistoricalTrades', 'eapiPublicGetHistoricalTrades' EXCHANGE SPECIFIC PARAMETERS |
| params.fromId |
int | undefined
|
trade id to fetch from, default gets most recent trades, not used when fetchTradesMethod is 'publicGetTrades', 'fapiPublicGetTrades', 'dapiPublicGetTrades', or 'eapiPublicGetTrades' |
binance.fetchTrades (symbol, since, limit, params)edit a trade order
Kind: instance method of binance
Returns: object - an order structure
See: https://binance-docs.github.io/apidocs/spot/en/#cancel-an-existing-order-and-send-a-new-order-trade
| Param | Type | Description |
|---|---|---|
| id | string |
cancel order id |
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the base currency, ignored in market orders |
| params | object |
extra parameters specific to the binance api endpoint |
binance.editSpotOrder (id, symbol, type, side, amount, price, params)edit a trade order
Kind: instance method of binance
Returns: object - an order structure
See
- https://binance-docs.github.io/apidocs/futures/en/#modify-order-trade
- https://binance-docs.github.io/apidocs/delivery/en/#modify-order-trade
| Param | Type | Description |
|---|---|---|
| id | string |
cancel order id |
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the base currency, ignored in market orders |
| params | object |
extra parameters specific to the binance api endpoint |
binance.editOrder (id, symbol, type, side, amount, price, params)edit a trade order
Kind: instance method of binance
Returns: object - an order structure
See
- https://binance-docs.github.io/apidocs/spot/en/#cancel-an-existing-order-and-send-a-new-order-trade
- https://binance-docs.github.io/apidocs/futures/en/#modify-order-trade
- https://binance-docs.github.io/apidocs/delivery/en/#modify-order-trade
| Param | Type | Description |
|---|---|---|
| id | string |
cancel order id |
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the base currency, ignored in market orders |
| params | object |
extra parameters specific to the binance api endpoint |
binance.editOrder (id, symbol, type, side, amount, price, params)create a trade order
Kind: instance method of binance
Returns: object - an order structure
See
- https://binance-docs.github.io/apidocs/spot/en/#new-order-trade
- https://binance-docs.github.io/apidocs/spot/en/#test-new-order-trade
- https://binance-docs.github.io/apidocs/futures/en/#new-order-trade
- https://binance-docs.github.io/apidocs/delivery/en/#new-order-trade
- https://binance-docs.github.io/apidocs/voptions/en/#new-order-trade
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' or 'STOP_LOSS' or 'STOP_LOSS_LIMIT' or 'TAKE_PROFIT' or 'TAKE_PROFIT_LIMIT' or 'STOP' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the binance api endpoint |
| params.marginMode |
string | undefined
|
'cross' or 'isolated', for spot margin trading |
binance.createOrder (symbol, type, side, amount, price, params)fetches information on an order made by the user
Kind: instance method of binance
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the binance api endpoint |
| params.marginMode |
string | undefined
|
'cross' or 'isolated', for spot margin trading |
binance.fetchOrder (symbol, params)fetches information on multiple orders made by the user
Kind: instance method of binance
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of order structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
| params.marginMode |
string | undefined
|
'cross' or 'isolated', for spot margin trading |
binance.fetchOrders (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of binance
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
| params.marginMode |
string | undefined
|
'cross' or 'isolated', for spot margin trading |
binance.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of binance
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of order structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchClosedOrders (symbol, since, limit, params)fetches information on multiple canceled orders made by the user
Kind: instance method of binance
Returns: Array.<object> - a list of order structures
See
- https://binance-docs.github.io/apidocs/spot/en/#all-orders-user_data
- https://binance-docs.github.io/apidocs/spot/en/#query-margin-account-39-s-all-orders-user_data
- https://binance-docs.github.io/apidocs/voptions/en/#query-option-order-history-trade
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market the orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of order structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchCanceledOrders (symbol, since, limit, params)cancels an open order
Kind: instance method of binance
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the binance api endpoint |
binance.cancelOrder (id, symbol, params)cancel all open orders in a market
Kind: instance method of binance
Returns: Array.<object> - a list of order structures
See
- https://binance-docs.github.io/apidocs/spot/en/#cancel-all-open-orders-on-a-symbol-trade
- https://binance-docs.github.io/apidocs/futures/en/#cancel-all-open-orders-trade
- https://binance-docs.github.io/apidocs/delivery/en/#cancel-all-open-orders-trade
- https://binance-docs.github.io/apidocs/voptions/en/#cancel-all-option-orders-on-specific-symbol-trade
- https://binance-docs.github.io/apidocs/spot/en/#margin-account-cancel-order-trade
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market to cancel orders in |
| params | object |
extra parameters specific to the binance api endpoint |
| params.marginMode |
string | undefined
|
'cross' or 'isolated', for spot margin trading |
binance.cancelAllOrders (symbol, params)fetch all the trades made from a single order
Kind: instance method of binance
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchOrderTrades (id, symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of binance
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchMyTrades (symbol, since, limit, params)fetch all dust trades made by the user
Kind: instance method of binance
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
not used by binance fetchMyDustTrades () |
| since |
int | undefined
|
the earliest time in ms to fetch my dust trades for |
| limit |
int | undefined
|
the maximum number of dust trades to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchMyDustTrades (symbol, since, limit, params)fetch all deposits made to an account
Kind: instance method of binance
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
| params.fiat | bool |
if true, only fiat deposits will be returned |
| params.until |
int | undefined
|
the latest time in ms to fetch deposits for |
binance.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of binance
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
| params.fiat | bool |
if true, only fiat withdrawals will be returned |
binance.fetchWithdrawals (code, since, limit, params)transfer currency internally between wallets on the same account
Kind: instance method of binance
Returns: object - a transfer structure
See
- https://binance-docs.github.io/apidocs/spot/en/#user-universal-transfer-user_data
- https://binance-docs.github.io/apidocs/spot/en/#isolated-margin-account-transfer-margin
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
amount to transfer |
| fromAccount | string |
account to transfer from |
| toAccount | string |
account to transfer to |
| params | object |
extra parameters specific to the binance api endpoint |
binance.transfer (code, amount, fromAccount, toAccount, params)fetch a history of internal transfers made on an account
Kind: instance method of binance
Returns: Array.<object> - a list of transfer structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code of the currency transferred |
| since |
int | undefined
|
the earliest time in ms to fetch transfers for |
| limit |
int | undefined
|
the maximum number of transfers structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchTransfers (code, since, limit, params)fetch the deposit address for a currency associated with this account
Kind: instance method of binance
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchDepositAddress (code, params)DEPRECATED please use fetchDepositWithdrawFees instead
Kind: instance method of binance
Returns: Array.<object> - a list of fee structures
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
not used by binance fetchTransactionFees () |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchTransactionFees (codes, params)fetch deposit and withdraw fees
Kind: instance method of binance
Returns: Array.<object> - a list of fee structures
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
not used by binance fetchDepositWithdrawFees () |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchDepositWithdrawFees (codes, params)make a withdrawal
Kind: instance method of binance
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the binance api endpoint |
binance.withdraw (code, amount, address, tag, params)fetch the trading fees for a market
Kind: instance method of binance
Returns: object - a fee structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchTradingFee (symbol, params)fetch the trading fees for multiple markets
Kind: instance method of binance
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchTradingFees (params)transfer between futures account
Kind: instance method of binance
Returns: object - a transfer structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to transfer |
| type | string |
1 - transfer from spot account to USDT-Ⓜ futures account, 2 - transfer from USDT-Ⓜ futures account to spot account, 3 - transfer from spot account to COIN-Ⓜ futures account, 4 - transfer from COIN-Ⓜ futures account to spot account |
| params | object |
extra parameters specific to the binance api endpoint |
| params.recvWindow |
float | undefined
|
binance.futuresTransfer (code, amount, type, params)fetch the current funding rate
Kind: instance method of binance
Returns: object - a funding rate structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchFundingRate (symbol, params)fetches historical funding rate prices
Kind: instance method of binance
Returns: Array.<object> - a list of funding rate structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market to fetch the funding rate history for |
| since |
int | undefined
|
timestamp in ms of the earliest funding rate to fetch |
| limit |
int | undefined
|
the maximum amount of funding rate structures to fetch |
| params | object |
extra parameters specific to the binance api endpoint |
| params.until |
int | undefined
|
timestamp in ms of the latest funding rate |
binance.fetchFundingRateHistory (symbol, since, limit, params)fetch the funding rate for multiple markets
Kind: instance method of binance
Returns: object - a dictionary of funding rates structures, indexe by market symbols
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchFundingRates (symbols, params)retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes
Kind: instance method of binance
Returns: object - a dictionary of leverage tiers structures, indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchLeverageTiers (symbols, params)fetch data on an open position
Kind: instance method of binance
Returns: object - a position structure
See: https://binance-docs.github.io/apidocs/voptions/en/#option-position-information-user_data
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market the position is held in |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchPosition (symbol, params)fetch data on open options positions
Kind: instance method of binance
Returns: Array.<object> - a list of position structures
See: https://binance-docs.github.io/apidocs/voptions/en/#option-position-information-user_data
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchOptionPositions (symbols, params)fetch all open positions
Kind: instance method of binance
Returns: Array.<object> - a list of position structure
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchPositions (symbols, params)fetch account positions
Kind: instance method of binance
Returns: object - data on account positions
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchAccountPositions (symbols, params)fetch positions risk
Kind: instance method of binance
Returns: object - data on the positions risk
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchPositionsRisk (symbols, params)fetch the history of funding payments paid and received on this account
Kind: instance method of binance
Returns: object - a funding history structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch funding history for |
| limit |
int | undefined
|
the maximum number of funding history structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchFundingHistory (symbol, since, limit, params)set the level of leverage for a market
Kind: instance method of binance
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| leverage | float |
the rate of leverage |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the binance api endpoint |
binance.setLeverage (leverage, symbol, params)set margin mode to 'cross' or 'isolated'
Kind: instance method of binance
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| marginMode | string |
'cross' or 'isolated' |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the binance api endpoint |
binance.setMarginMode (marginMode, symbol, params)set hedged to true or false for a market
Kind: instance method of binance
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| hedged | bool |
set to true to use dualSidePosition |
| symbol |
string | undefined
|
not used by binance setPositionMode () |
| params | object |
extra parameters specific to the binance api endpoint |
binance.setPositionMode (hedged, symbol, params)fetches historical settlement records
Kind: instance method of binance
Returns: Array.<object> - a list of [settlement history objects]
See: https://binance-docs.github.io/apidocs/voptions/en/#historical-exercise-records
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the settlement history |
| since | int |
timestamp in ms |
| limit | int |
number of records, default 100, max 100 |
| params | object |
exchange specific params |
binance.fetchSettlementHistory (symbol, since, limit, params)fetch the history of changes, actions done by the user or operations that altered the balance of the user
Kind: instance method of binance
Returns: object - a ledger structure
See
- https://binance-docs.github.io/apidocs/voptions/en/#account-funding-flow-user_data
- https://binance-docs.github.io/apidocs/futures/en/#get-income-history-user_data
- https://binance-docs.github.io/apidocs/delivery/en/#get-income-history-user_data
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
timestamp in ms of the earliest ledger entry |
| limit |
int | undefined
|
max number of ledger entrys to return |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchLedger (code, since, limit, params)remove margin from a position
Kind: instance method of binance
Returns: object - a margin structure
See
- https://binance-docs.github.io/apidocs/delivery/en/#modify-isolated-position-margin-trade
- https://binance-docs.github.io/apidocs/futures/en/#modify-isolated-position-margin-trade
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| amount | float |
the amount of margin to remove |
| params | object |
extra parameters specific to the binance api endpoint |
binance.reduceMargin (symbol, amount, params)add margin
Kind: instance method of binance
Returns: object - a margin structure
See
- https://binance-docs.github.io/apidocs/delivery/en/#modify-isolated-position-margin-trade
- https://binance-docs.github.io/apidocs/futures/en/#modify-isolated-position-margin-trade
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| amount | float |
amount of margin to add |
| params | object |
extra parameters specific to the binance api endpoint |
binance.addMargin (symbol, amount, params)fetch the rate of interest to borrow a currency for margin trading
Kind: instance method of binance
Returns: object - a borrow rate structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchBorrowRate (code, params)retrieves a history of a currencies borrow interest rate at specific time slots
Kind: instance method of binance
Returns: Array.<object> - an array of borrow rate structures
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| since |
int | undefined
|
timestamp for the earliest borrow rate |
| limit |
int | undefined
|
the maximum number of borrow rate structures to retrieve |
| params | object |
extra parameters specific to the exchange api endpoint |
binance.fetchBorrowRateHistory (code, since, limit, params)create gift code
Kind: instance method of binance
Returns: object - The gift code id, code, currency and amount
| Param | Type | Description |
|---|---|---|
| code | string |
gift code |
| amount | float |
amount of currency for the gift |
| params | object |
extra parameters specific to the binance api endpoint |
binance.createGiftCode (code, amount, params)redeem gift code
Kind: instance method of binance
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| giftcardCode | string |
|
| params | object |
extra parameters specific to the binance api endpoint |
binance.redeemGiftCode (giftcardCode, params)verify gift code
Kind: instance method of binance
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| id | string |
reference number id |
| params | object |
extra parameters specific to the binance api endpoint |
binance.verifyGiftCode (id, params)fetch the interest owed by the user for borrowing currency for margin trading
Kind: instance method of binance
Returns: Array.<object> - a list of borrow interest structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| symbol |
string | undefined
|
unified market symbol when fetch interest in isolated markets |
| since |
int | undefined
|
the earliest time in ms to fetch borrrow interest for |
| limit |
int | undefined
|
the maximum number of structures to retrieve |
| params | object |
extra parameters specific to the binance api endpoint |
binance.fetchBorrowInterest (code, symbol, since, limit, params)repay borrowed margin and interest
Kind: instance method of binance
Returns: object - a margin loan structure
See: https://binance-docs.github.io/apidocs/spot/en/#margin-account-repay-margin
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code of the currency to repay |
| amount | float |
the amount to repay |
| symbol |
string | undefined
|
unified market symbol, required for isolated margin |
| params | object |
extra parameters specific to the binance api endpoint |
binance.repayMargin (code, amount, symbol, params)create a loan to borrow margin
Kind: instance method of binance
Returns: object - a margin loan structure
See: https://binance-docs.github.io/apidocs/spot/en/#margin-account-borrow-margin
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code of the currency to borrow |
| amount | float |
the amount to borrow |
| symbol |
string | undefined
|
unified market symbol, required for isolated margin |
| params | object |
extra parameters specific to the binance api endpoint |
binance.borrowMargin (code, amount, symbol, params)Retrieves the open interest history of a currency
Kind: instance method of binance
Returns: object - an array of open interest history structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
Unified CCXT market symbol |
| timeframe | string |
"5m","15m","30m","1h","2h","4h","6h","12h", or "1d" |
| since |
int | undefined
|
the time(ms) of the earliest record to retrieve as a unix timestamp |
| limit |
int | undefined
|
default 30, max 500 |
| params | object |
exchange specific parameters |
| params.until |
int | undefined
|
the time(ms) of the latest record to retrieve as a unix timestamp |
binance.fetchOpenInterestHistory (symbol, timeframe, since, limit, params)retrieves the open interest of a contract trading pair
Kind: instance method of binance
Returns: object - an open interest structurehttps://docs.ccxt.com/#/?id=interest-history-structure
See
- https://binance-docs.github.io/apidocs/futures/en/#open-interest
- https://binance-docs.github.io/apidocs/delivery/en/#open-interest
- https://binance-docs.github.io/apidocs/voptions/en/#open-interest
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified CCXT market symbol |
| params | object |
exchange specific parameters |
binance.fetchOpenInterest (symbol, params)Kind: global class
Extends: Exchange
- fetchBalance
- fetchOrderBook
- fetchTicker
- fetchTrades
- fetchTradingFees
- createOrder
- cancelOrder
- fetchOpenOrders
- fetchOrder
- fetchMyTrades
- fetchDepositAddress
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bit2c
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bit2c
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bit2c
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of bit2c
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.fetchTrades (symbol, since, limit, params)fetch the trading fees for multiple markets
Kind: instance method of bit2c
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.fetchTradingFees (params)create a trade order
Kind: instance method of bit2c
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bit2c
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
Not used by bit2c cancelOrder () |
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.cancelOrder (id, symbol, params)fetch all unfilled currently open orders
Kind: instance method of bit2c
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.fetchOpenOrders (symbol, since, limit, params)fetches information on an order made by the user
Kind: instance method of bit2c
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.fetchOrder (symbol, params)fetch all trades made by the user
Kind: instance method of bit2c
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.fetchMyTrades (symbol, since, limit, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bit2c
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bit2c api endpoint |
bit2c.fetchDepositAddress (code, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchTicker
- fetchOrderBook
- fetchTrades
- fetchTradingFees
- fetchOHLCV
- fetchBalance
- createOrder
- cancelOrder
- fetchOrder
- fetchOpenOrders
- fetchMyTrades
- fetchDepositAddress
- withdraw
retrieves data on all markets for bitbank
Kind: instance method of bitbank
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitbank.fetchMarkets (params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitbank
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchTicker (symbol, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitbank
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchOrderBook (symbol, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitbank
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchTrades (symbol, since, limit, params)fetch the trading fees for multiple markets
Kind: instance method of bitbank
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchTradingFees (params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitbank
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchOHLCV (symbol, timeframe, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitbank
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchBalance (params)create a trade order
Kind: instance method of bitbank
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitbank
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.cancelOrder (id, symbol, params)fetches information on an order made by the user
Kind: instance method of bitbank
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchOrder (symbol, params)fetch all unfilled currently open orders
Kind: instance method of bitbank
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchOpenOrders (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bitbank
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchMyTrades (symbol, since, limit, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitbank
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.fetchDepositAddress (code, params)make a withdrawal
Kind: instance method of bitbank
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitbank api endpoint |
bitbank.withdraw (code, amount, address, tag, params)Kind: global class
Extends: Exchange
- fetchStatus
- fetchMarkets
- fetchOrderBook
- fetchTickers
- fetchBalance
- createOrder
- cancelOrder
- fetchOrder
- fetchOpenOrders
- fetchMyTrades
- fetchTrades
- fetchDeposits
- fetchWithdrawals
- fetchDepositAddress
the latest known information on the availability of the exchange API
Kind: instance method of bitbns
Returns: object - a status structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchStatus (params)retrieves data on all markets for bitbns
Kind: instance method of bitbns
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitbns.fetchMarkets (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitbns
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchOrderBook (symbol, limit, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitbns
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchTickers (symbols, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitbns
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchBalance (params)create a trade order
Kind: instance method of bitbns
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitbns
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.cancelOrder (id, symbol, params)fetches information on an order made by the user
Kind: instance method of bitbns
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchOrder (symbol, params)fetch all unfilled currently open orders
Kind: instance method of bitbns
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchOpenOrders (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bitbns
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchMyTrades (symbol, since, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitbns
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchTrades (symbol, since, limit, params)fetch all deposits made to an account
Kind: instance method of bitbns
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of bitbns
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchWithdrawals (code, since, limit, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitbns
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitbns api endpoint |
bitbns.fetchDepositAddress (code, params)Kind: global class
Extends: Exchange
- fetchTransactionFees
- fetchDepositWithdrawFees
- fetchTradingFees
- fetchMarkets
- fetchBalance
- transfer
- fetchOrderBook
- fetchTickers
- fetchTicker
- fetchTrades
- fetchMyTrades
- createOrder
- cancelOrder
- cancelAllOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchOrder
- fetchOHLCV
- createDepositAddress
- fetchDepositAddress
- fetchTransactions
- withdraw
- fetchPositions
DEPRECATED please use fetchDepositWithdrawFees instead
Kind: instance method of bitfinex
Returns: Array.<object> - a list of fees structures
See: https://docs.bitfinex.com/v1/reference/rest-auth-fees
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchTransactionFees (codes, params)fetch deposit and withdraw fees
Kind: instance method of bitfinex
Returns: Array.<object> - a list of fees structures
See: https://docs.bitfinex.com/v1/reference/rest-auth-fees
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchDepositWithdrawFees (codes, params)fetch the trading fees for multiple markets
Kind: instance method of bitfinex
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchTradingFees (params)retrieves data on all markets for bitfinex
Kind: instance method of bitfinex
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitfinex.fetchMarkets (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitfinex
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchBalance (params)transfer currency internally between wallets on the same account
Kind: instance method of bitfinex
Returns: object - a transfer structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
amount to transfer |
| fromAccount | string |
account to transfer from |
| toAccount | string |
account to transfer to |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.transfer (code, amount, fromAccount, toAccount, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitfinex
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchOrderBook (symbol, limit, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitfinex
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchTickers (symbols, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitfinex
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitfinex
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchTrades (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bitfinex
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchMyTrades (symbol, since, limit, params)create a trade order
Kind: instance method of bitfinex
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitfinex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
not used by bitfinex cancelOrder () |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.cancelOrder (id, symbol, params)cancel all open orders
Kind: instance method of bitfinex
Returns: object - response from exchange
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.cancelAllOrders (symbol, params)fetch all unfilled currently open orders
Kind: instance method of bitfinex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitfinex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchClosedOrders (symbol, since, limit, params)fetches information on an order made by the user
Kind: instance method of bitfinex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
not used by bitfinex fetchOrder |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchOrder (symbol, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitfinex
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchOHLCV (symbol, timeframe, since, limit, params)create a currency deposit address
Kind: instance method of bitfinex
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code of the currency for the deposit address |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.createDepositAddress (code, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitfinex
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchDepositAddress (code, params)DEPRECATED use fetchDepositsWithdrawals instead
Kind: instance method of bitfinex
Returns: object - a list of transaction structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code for the currency of the transactions, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest transaction, default is undefined |
| limit |
int | undefined
|
max number of transactions to return, default is undefined |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchTransactions (code, since, limit, params)make a withdrawal
Kind: instance method of bitfinex
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.withdraw (code, amount, address, tag, params)fetch all open positions
Kind: instance method of bitfinex
Returns: Array.<object> - a list of position structure
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the bitfinex api endpoint |
bitfinex.fetchPositions (symbols, params)Kind: global class
Extends: Exchange
- fetchStatus
- fetchMarkets
- fetchCurrencies
- fetchBalance
- transfer
- fetchOrderBook
- fetchTickers
- fetchTicker
- fetchTrades
- fetchOHLCV
- createOrder
- cancelAllOrders
- cancelOrder
- fetchOpenOrder
- fetchClosedOrder
- fetchOpenOrders
- fetchClosedOrders
- fetchOrderTrades
- fetchMyTrades
- createDepositAddress
- fetchDepositAddress
- fetchTradingFees
- fetchTransactions
- withdraw
- fetchPositions
- fetchLedger
the latest known information on the availability of the exchange API
Kind: instance method of bitfinex2
Returns: object - a status structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchStatus (params)retrieves data on all markets for bitfinex2
Kind: instance method of bitfinex2
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitfinex2.fetchMarkets (params)fetches all available currencies on an exchange
Kind: instance method of bitfinex2
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchCurrencies (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitfinex2
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchBalance (params)transfer currency internally between wallets on the same account
Kind: instance method of bitfinex2
Returns: object - a transfer structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
amount to transfer |
| fromAccount | string |
account to transfer from |
| toAccount | string |
account to transfer to |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.transfer (code, amount, fromAccount, toAccount, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitfinex2
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchOrderBook (symbol, limit, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitfinex2
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchTickers (symbols, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitfinex2
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitfinex2
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchTrades (symbol, since, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitfinex2
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchOHLCV (symbol, timeframe, since, limit, params)Create an order on the exchange
Kind: instance method of bitfinex2
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
Unified CCXT market symbol |
| type | string |
'limit' or 'market' |
| side | string |
'buy' or 'sell' |
| amount | float |
the amount of currency to trade |
| price | float |
price of order |
| params | object |
Extra parameters specific to the exchange API endpoint |
| params.stopPrice | float |
The price at which a trigger order is triggered at |
| params.timeInForce | string |
"GTC", "IOC", "FOK", or "PO" |
| params.postOnly | bool |
|
| params.reduceOnly | bool |
Ensures that the executed order does not flip the opened position. |
| params.flags | int |
additional order parameters: 4096 (Post Only), 1024 (Reduce Only), 16384 (OCO), 64 (Hidden), 512 (Close), 524288 (No Var Rates) |
| params.lev | int |
leverage for a derivative order, supported by derivative symbol orders only. The value should be between 1 and 100 inclusive. |
| params.price_traling | string |
The trailing price for a trailing stop order |
| params.price_aux_limit | string |
Order price for stop limit orders |
| params.price_oco_stop | string |
OCO stop price |
bitfinex2.createOrder (symbol, type, side, amount, price, params)cancel all open orders
Kind: instance method of bitfinex2
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.cancelAllOrders (symbol, params)cancels an open order
Kind: instance method of bitfinex2
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
Not used by bitfinex2 cancelOrder () |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.cancelOrder (id, symbol, params)fetch an open order by it's id
Kind: instance method of bitfinex2
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified market symbol, default is undefined |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchOpenOrder (id, symbol, params)fetch an open order by it's id
Kind: instance method of bitfinex2
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified market symbol, default is undefined |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchClosedOrder (id, symbol, params)fetch all unfilled currently open orders
Kind: instance method of bitfinex2
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitfinex2
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchClosedOrders (symbol, since, limit, params)fetch all the trades made from a single order
Kind: instance method of bitfinex2
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades to retrieve |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchOrderTrades (id, symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bitfinex2
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchMyTrades (symbol, since, limit, params)create a currency deposit address
Kind: instance method of bitfinex2
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code of the currency for the deposit address |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.createDepositAddress (code, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitfinex2
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchDepositAddress (code, params)fetch the trading fees for multiple markets
Kind: instance method of bitfinex2
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchTradingFees (params)DEPRECATED use fetchDepositsWithdrawals instead
Kind: instance method of bitfinex2
Returns: object - a list of transaction structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code for the currency of the transactions, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest transaction, default is undefined |
| limit |
int | undefined
|
max number of transactions to return, default is undefined |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchTransactions (code, since, limit, params)make a withdrawal
Kind: instance method of bitfinex2
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.withdraw (code, amount, address, tag, params)fetch all open positions
Kind: instance method of bitfinex2
Returns: Array.<object> - a list of position structure
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchPositions (symbols, params)fetch the history of changes, actions done by the user or operations that altered balance of the user
Kind: instance method of bitfinex2
Returns: object - a ledger structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest ledger entry, default is undefined |
| limit |
int | undefined
|
max number of ledger entrys to return, default is undefined |
| params | object |
extra parameters specific to the bitfinex2 api endpoint |
bitfinex2.fetchLedger (code, since, limit, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchTicker
- fetchTrades
- fetchTradingFee
- createOrder
- cancelOrder
- fetchOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchOrder
- fetchMyTrades
- fetchPositions
- withdraw
- fetchDeposits
- fetchWithdrawals
retrieves data on all markets for bitflyer
Kind: instance method of bitflyer
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitflyer.fetchMarkets (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitflyer
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitflyer
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitflyer
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitflyer
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchTrades (symbol, since, limit, params)fetch the trading fees for a market
Kind: instance method of bitflyer
Returns: object - a fee structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchTradingFee (symbol, params)create a trade order
Kind: instance method of bitflyer
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitflyer
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.cancelOrder (id, symbol, params)fetches information on multiple orders made by the user
Kind: instance method of bitflyer
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchOrders (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of bitflyer
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitflyer
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchClosedOrders (symbol, since, limit, params)fetches information on an order made by the user
Kind: instance method of bitflyer
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchOrder (symbol, params)fetch all trades made by the user
Kind: instance method of bitflyer
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchMyTrades (symbol, since, limit, params)fetch all open positions
Kind: instance method of bitflyer
Returns: Array.<object> - a list of position structure
| Param | Type | Description |
|---|---|---|
| symbols | Array.<string> |
list of unified market symbols |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchPositions (symbols, params)make a withdrawal
Kind: instance method of bitflyer
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.withdraw (code, amount, address, tag, params)fetch all deposits made to an account
Kind: instance method of bitflyer
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of bitflyer
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bitflyer api endpoint |
bitflyer.fetchWithdrawals (code, since, limit, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchTrades
- fetchMyTrades
- fetchBalance
- fetchTicker
- fetchOHLCV
- fetchOrderBook
- fetchOrder
- fetchOpenOrders
- fetchClosedOrders
- createOrder
- cancelOrder
retrieves data on all markets for bitforex
Kind: instance method of bitforex
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitforex.fetchMarkets (params)get the list of most recent trades for a particular symbol
Kind: instance method of bitforex
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.fetchTrades (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bitforex
Returns: Array.<object> - a list of trade structures
See: https://apidoc.bitforex.com/#spot-account-trade
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.fetchMyTrades (symbol, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitforex
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.fetchBalance (params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitforex
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.fetchTicker (symbol, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitforex
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.fetchOHLCV (symbol, timeframe, since, limit, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitforex
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.fetchOrderBook (symbol, limit, params)fetches information on an order made by the user
Kind: instance method of bitforex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.fetchOrder (symbol, params)fetch all unfilled currently open orders
Kind: instance method of bitforex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitforex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.fetchClosedOrders (symbol, since, limit, params)create a trade order
Kind: instance method of bitforex
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitforex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitforex api endpoint |
bitforex.cancelOrder (id, symbol, params)Kind: global class
Extends: Exchange
- fetchTime
- fetchMarkets
- fetchCurrencies
- fetchMarketLeverageTiers
- fetchDeposits
- withdraw
- fetchWithdrawals
- fetchDepositAddress
- fetchOrderBook
- fetchTicker
- fetchTickers
- fetchTrades
- fetchTradingFee
- fetchTradingFees
- fetchOHLCV
- fetchBalance
- createOrder
- editOrder
- cancelOrder
- cancelOrders
- cancelAllOrders
- fetchOrder
- fetchOpenOrders
- fetchClosedOrders
- fetchCanceledOrders
- fetchLedger
- fetchMyTrades
- fetchOrderTrades
- fetchPosition
- fetchPositions
- fetchFundingRateHistory
- fetchFundingRate
- fetchFundingHistory
- reduceMargin
- addMargin
- fetchLeverage
- setLeverage
- setMarginMode
- setPositionMode
- fetchOpenInterest
- fetchTransfers
- transfer
- fetchDepositWithdrawFees
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of bitget
Returns: int - the current integer timestamp in milliseconds from the exchange server
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchTime (params)retrieves data on all markets for bitget
Kind: instance method of bitget
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitget.fetchMarkets (params)fetches all available currencies on an exchange
Kind: instance method of bitget
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchCurrencies (params)retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes for a single market
Kind: instance method of bitget
Returns: object - a leverage tiers structure
See: https://bitgetlimited.github.io/apidoc/en/mix/#get-position-tier
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchMarketLeverageTiers (symbol, params)fetch all deposits made to an account
Kind: instance method of bitget
Returns: Array.<object> - a list of transaction structures
See: https://bitgetlimited.github.io/apidoc/en/spot/#get-deposit-list
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since | int |
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bitget api endpoint |
| params.pageNo |
string | undefined
|
pageNo default 1 |
| params.pageSize |
string | undefined
|
pageSize default 20. Max 100 |
bitget.fetchDeposits (code, since, limit, params)make a withdrawal
Kind: instance method of bitget
Returns: object - a transaction structure
See: https://bitgetlimited.github.io/apidoc/en/spot/#withdraw-v2
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitget api endpoint |
| params.chain | string |
the chain to withdraw to |
bitget.withdraw (code, amount, address, tag, params)fetch all withdrawals made from an account
Kind: instance method of bitget
Returns: Array.<object> - a list of transaction structures
See: https://bitgetlimited.github.io/apidoc/en/spot/#get-withdraw-list
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since | int |
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bitget api endpoint |
| params.pageNo |
string | undefined
|
pageNo default 1 |
| params.pageSize |
string | undefined
|
pageSize default 20. Max 100 |
bitget.fetchWithdrawals (code, since, limit, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitget
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchDepositAddress (code, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitget
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitget
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitget
Returns: object - a dictionary of ticker structures
See
- https://bitgetlimited.github.io/apidoc/en/spot/#get-all-tickers
- https://bitgetlimited.github.io/apidoc/en/mix/#get-all-symbol-ticker
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchTickers (symbols, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitget
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchTrades (symbol, since, limit, params)fetch the trading fees for a market
Kind: instance method of bitget
Returns: object - a fee structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchTradingFee (symbol, params)fetch the trading fees for multiple markets
Kind: instance method of bitget
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchTradingFees (params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitget
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See
- https://bitgetlimited.github.io/apidoc/en/mix/#get-candle-data
- https://bitgetlimited.github.io/apidoc/en/spot/#candlestick-line-timeframe
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitget api endpoint |
| params.until |
int | undefined
|
timestamp in ms of the latest candle to fetch |
bitget.fetchOHLCV (symbol, timeframe, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitget
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchBalance (params)create a trade order
Kind: instance method of bitget
Returns: object - an order structure
See
- https://bitgetlimited.github.io/apidoc/en/spot/#place-order
- https://bitgetlimited.github.io/apidoc/en/spot/#place-plan-order
- https://bitgetlimited.github.io/apidoc/en/mix/#place-order
- https://bitgetlimited.github.io/apidoc/en/mix/#place-stop-order
- https://bitgetlimited.github.io/apidoc/en/mix/#place-position-tpsl
- https://bitgetlimited.github.io/apidoc/en/mix/#place-plan-order
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' or 'open_long' or 'open_short' or 'close_long' or 'close_short' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitget api endpoint |
| params.triggerPrice | float |
swap only The price at which a trigger order is triggered at |
| params.stopLossPrice |
float | undefined
|
swap only The price at which a stop loss order is triggered at |
| params.takeProfitPrice |
float | undefined
|
swap only The price at which a take profit order is triggered at |
| params.stopLoss |
float | undefined
|
swap only uses the Place Position TPSL The price at which a stop loss order is triggered at |
| params.takeProfit |
float | undefined
|
swap only uses the Place Position TPSL The price at which a take profit order is triggered at |
| params.timeInForce |
string | undefined
|
"GTC", "IOC", "FOK", or "PO" |
bitget.createOrder (symbol, type, side, amount, price, params)edit a trade order
Kind: instance method of bitget
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| id | string |
cancel order id |
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the base currency, ignored in market orders |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.editOrder (id, symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitget
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.cancelOrder (id, symbol, params)cancel multiple orders
Kind: instance method of bitget
Returns: object - an list of order structures
| Param | Type | Description |
|---|---|---|
| ids | Array.<string> |
order ids |
| symbol | string |
unified market symbol, default is undefined |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.cancelOrders (ids, symbol, params)cancel all open orders
Kind: instance method of bitget
Returns: Array.<object> - a list of order structures
See
- https://bitgetlimited.github.io/apidoc/en/mix/#cancel-all-order
- https://bitgetlimited.github.io/apidoc/en/mix/#cancel-all-trigger-order-tpsl
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| params | object |
extra parameters specific to the bitget api endpoint |
| params.code | string |
marginCoin unified currency code |
bitget.cancelAllOrders (symbol, params)fetches information on an order made by the user
Kind: instance method of bitget
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchOrder (symbol, params)fetch all unfilled currently open orders
Kind: instance method of bitget
Returns: Array.<object> - a list of order structures
See
- https://bitgetlimited.github.io/apidoc/en/spot/#get-order-list
- https://bitgetlimited.github.io/apidoc/en/mix/#get-all-open-order
- https://bitgetlimited.github.io/apidoc/en/mix/#get-plan-order-tpsl-list
- https://bitgetlimited.github.io/apidoc/en/mix/#get-open-order
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open order structures to retrieve |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitget
Returns: Array.<object> - a list of order structures
See
- https://bitgetlimited.github.io/apidoc/en/spot/#get-order-history
- https://bitgetlimited.github.io/apidoc/en/mix/#get-history-orders
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the closed orders |
| since |
int | undefined
|
timestamp in ms of the earliest order |
| limit |
int | undefined
|
the max number of closed orders to return |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchClosedOrders (symbol, since, limit, params)fetches information on multiple canceled orders made by the user
Kind: instance method of bitget
Returns: object - a list of order structures
See
- https://bitgetlimited.github.io/apidoc/en/spot/#get-order-history
- https://bitgetlimited.github.io/apidoc/en/mix/#get-history-orders
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the canceled orders |
| since |
int | undefined
|
timestamp in ms of the earliest order |
| limit |
int | undefined
|
the max number of canceled orders to return |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchCanceledOrders (symbol, since, limit, params)fetch the history of changes, actions done by the user or operations that altered balance of the user
Kind: instance method of bitget
Returns: object - a ledger structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest ledger entry, default is undefined |
| limit |
int | undefined
|
max number of ledger entrys to return, default is undefined |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchLedger (code, since, limit, params)fetch all trades made by the user
Kind: instance method of bitget
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchMyTrades (symbol, since, limit, params)fetch all the trades made from a single order
Kind: instance method of bitget
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades to retrieve |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchOrderTrades (id, symbol, since, limit, params)fetch data on a single open contract trade position
Kind: instance method of bitget
Returns: object - a position structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market the position is held in, default is undefined |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchPosition (symbol, params)fetch all open positions
Kind: instance method of bitget
Returns: Array.<object> - a list of position structure
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchPositions (symbols, params)fetches historical funding rate prices
Kind: instance method of bitget
Returns: Array.<object> - a list of funding rate structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market to fetch the funding rate history for |
| since |
int | undefined
|
timestamp in ms of the earliest funding rate to fetch |
| limit |
int | undefined
|
the maximum amount of funding rate structures to fetch |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchFundingRateHistory (symbol, since, limit, params)fetch the current funding rate
Kind: instance method of bitget
Returns: object - a funding rate structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchFundingRate (symbol, params)fetch the funding history
Kind: instance method of bitget
Returns: Array.<object> - a list of funding history structures
See: https://bitgetlimited.github.io/apidoc/en/mix/#get-account-bill
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the starting timestamp in milliseconds |
| limit |
int | undefined
|
the number of entries to return |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchFundingHistory (symbol, since, limit, params)remove margin from a position
Kind: instance method of bitget
Returns: object - a margin structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| amount | float |
the amount of margin to remove |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.reduceMargin (symbol, amount, params)add margin
Kind: instance method of bitget
Returns: object - a margin structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| amount | float |
amount of margin to add |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.addMargin (symbol, amount, params)fetch the set leverage for a market
Kind: instance method of bitget
Returns: object - a leverage structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchLeverage (symbol, params)set the level of leverage for a market
Kind: instance method of bitget
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| leverage | float |
the rate of leverage |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.setLeverage (leverage, symbol, params)set margin mode to 'cross' or 'isolated'
Kind: instance method of bitget
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| marginMode | string |
'cross' or 'isolated' |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.setMarginMode (marginMode, symbol, params)set hedged to true or false for a market
Kind: instance method of bitget
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| hedged | bool |
set to true to use dualSidePosition |
| symbol |
string | undefined
|
not used by bitget setPositionMode () |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.setPositionMode (hedged, symbol, params)Retrieves the open interest of a currency
Kind: instance method of bitget
Returns: object - an open interest structurehttps://docs.ccxt.com/#/?id=interest-history-structure
See: https://bitgetlimited.github.io/apidoc/en/mix/#get-open-interest
| Param | Type | Description |
|---|---|---|
| symbol | string |
Unified CCXT market symbol |
| params | object |
exchange specific parameters |
bitget.fetchOpenInterest (symbol, params)fetch a history of internal transfers made on an account
Kind: instance method of bitget
Returns: Array.<object> - a list of transfer structures
See: https://bitgetlimited.github.io/apidoc/en/spot/#get-transfer-list
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code of the currency transferred |
| since |
int | undefined
|
the earliest time in ms to fetch transfers for |
| limit |
int | undefined
|
the maximum number of transfers structures to retrieve |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchTransfers (code, since, limit, params)transfer currency internally between wallets on the same account
Kind: instance method of bitget
Returns: object - a transfer structure
See: https://bitgetlimited.github.io/apidoc/en/spot/#transfer-v2
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
amount to transfer |
| fromAccount | string |
account to transfer from |
| toAccount | string |
account to transfer to |
| params | object |
extra parameters specific to the bitget api endpoint EXCHANGE SPECIFIC PARAMS |
| params.clientOid | string |
custom id |
bitget.transfer (code, amount, fromAccount, toAccount, params)fetch deposit and withdraw fees
Kind: instance method of bitget
Returns: object - a list of fee structures
See: https://bitgetlimited.github.io/apidoc/en/spot/#get-coin-list
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitget api endpoint |
bitget.fetchDepositWithdrawFees (codes, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchTickers
- fetchTicker
- fetchOHLCV
- fetchTrades
- createOrder
- fetchOrder
- fetchOpenOrders
- cancelOrder
- withdraw
retrieves data on all markets for bithumb
Kind: instance method of bithumb
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bithumb.fetchMarkets (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bithumb
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bithumb
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.fetchOrderBook (symbol, limit, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bithumb
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.fetchTickers (symbols, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bithumb
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.fetchTicker (symbol, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bithumb
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.fetchOHLCV (symbol, timeframe, since, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bithumb
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.fetchTrades (symbol, since, limit, params)create a trade order
Kind: instance method of bithumb
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.createOrder (symbol, type, side, amount, price, params)fetches information on an order made by the user
Kind: instance method of bithumb
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.fetchOrder (symbol, params)fetch all unfilled currently open orders
Kind: instance method of bithumb
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.fetchOpenOrders (symbol, since, limit, params)cancels an open order
Kind: instance method of bithumb
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.cancelOrder (id, symbol, params)make a withdrawal
Kind: instance method of bithumb
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bithumb api endpoint |
bithumb.withdraw (code, amount, address, tag, params)Kind: global class
Extends: Exchange
- fetchTime
- fetchStatus
- fetchMarkets
- fetchCurrencies
- fetchTransactionFee
- fetchDepositWithdrawFee
- fetchTicker
- fetchTickers
- fetchOrderBook
- fetchTrades
- fetchOHLCV
- fetchMyTrades
- fetchOrderTrades
- fetchBalance
- fetchTradingFee
- createOrder
- cancelOrder
- cancelAllOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchCanceledOrders
- fetchOrder
- fetchDepositAddress
- withdraw
- fetchDeposit
- fetchDeposits
- fetchWithdrawal
- fetchWithdrawals
- repayMargin
- borrowMargin
- fetchBorrowRate
- fetchBorrowRates
- transfer
- fetchBorrowInterest
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of bitmart
Returns: int - the current integer timestamp in milliseconds from the exchange server
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchTime (params)the latest known information on the availability of the exchange API
Kind: instance method of bitmart
Returns: object - a status structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchStatus (params)retrieves data on all markets for bitmart
Kind: instance method of bitmart
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitmart.fetchMarkets (params)fetches all available currencies on an exchange
Kind: instance method of bitmart
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchCurrencies (params)DEPRECATED please use fetchDepositWithdrawFee instead
Kind: instance method of bitmart
Returns: object - a fee structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchTransactionFee (code, params)fetch the fee for deposits and withdrawals
Kind: instance method of bitmart
Returns: object - a fee structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchDepositWithdrawFee (code, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitmart
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitmart
Returns: object - a dictionary of ticker structures
See: https://developer-pro.bitmart.com/en/spot/#get-ticker-of-all-pairs-v2
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchTickers (symbols, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitmart
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchOrderBook (symbol, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitmart
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchTrades (symbol, since, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitmart
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See
- https://developer-pro.bitmart.com/en/spot/#get-k-line
- https://developer-pro.bitmart.com/en/futures/#get-k-line
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchOHLCV (symbol, timeframe, since, limit, params)fetch all trades made by the user
Kind: instance method of bitmart
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchMyTrades (symbol, since, limit, params)fetch all the trades made from a single order
Kind: instance method of bitmart
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades to retrieve |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchOrderTrades (id, symbol, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitmart
Returns: object - a balance structure
See
- https://developer-pro.bitmart.com/en/spot/#get-spot-wallet-balance
- https://developer-pro.bitmart.com/en/futures/#get-contract-assets-detail
- https://developer-pro.bitmart.com/en/spot/#get-account-balance
- https://developer-pro.bitmart.com/en/spot/#get-margin-account-details-isolated
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchBalance (params)fetch the trading fees for a market
Kind: instance method of bitmart
Returns: object - a fee structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchTradingFee (symbol, params)create a trade order
Kind: instance method of bitmart
Returns: object - an order structure
See
- https://developer-pro.bitmart.com/en/spot/#place-spot-order
- https://developer-pro.bitmart.com/en/spot/#place-margin-order
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitmart api endpoint |
| params.marginMode |
string | undefined
|
'cross' or 'isolated' |
bitmart.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitmart
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.cancelOrder (id, symbol, params)cancel all open orders in a market
Kind: instance method of bitmart
Returns: Array.<object> - a list of order structures
See: https://developer-pro.bitmart.com/en/spot/#cancel-all-orders
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market to cancel orders in |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.cancelAllOrders (symbol, params)fetch all unfilled currently open orders
Kind: instance method of bitmart
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitmart
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchClosedOrders (symbol, since, limit, params)fetches information on multiple canceled orders made by the user
Kind: instance method of bitmart
Returns: object - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
timestamp in ms of the earliest order, default is undefined |
| limit |
int | undefined
|
max number of orders to return, default is undefined |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchCanceledOrders (symbol, since, limit, params)fetches information on an order made by the user
Kind: instance method of bitmart
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchOrder (symbol, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitmart
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchDepositAddress (code, params)make a withdrawal
Kind: instance method of bitmart
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.withdraw (code, amount, address, tag, params)fetch information on a deposit
Kind: instance method of bitmart
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| id | string |
deposit id |
| code |
string | undefined
|
not used by bitmart fetchDeposit () |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchDeposit (id, code, params)fetch all deposits made to an account
Kind: instance method of bitmart
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchDeposits (code, since, limit, params)fetch data on a currency withdrawal via the withdrawal id
Kind: instance method of bitmart
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| id | string |
withdrawal id |
| code |
string | undefined
|
not used by bitmart.fetchWithdrawal |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchWithdrawal (id, code, params)fetch all withdrawals made from an account
Kind: instance method of bitmart
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchWithdrawals (code, since, limit, params)repay borrowed margin and interest
Kind: instance method of bitmart
Returns: object - a margin loan structure
See: https://developer-pro.bitmart.com/en/spot/#margin-repay-isolated
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code of the currency to repay |
| amount | string |
the amount to repay |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitmart api endpoint |
| params.marginMode |
string | undefined
|
'isolated' is the default and 'cross' is unavailable |
bitmart.repayMargin (code, amount, symbol, params)create a loan to borrow margin
Kind: instance method of bitmart
Returns: object - a margin loan structure
See: https://developer-pro.bitmart.com/en/spot/#margin-borrow-isolated
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code of the currency to borrow |
| amount | string |
the amount to borrow |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitmart api endpoint |
| params.marginMode |
string | undefined
|
'isolated' is the default and 'cross' is unavailable |
bitmart.borrowMargin (code, amount, symbol, params)fetch the rate of interest to borrow a currency for margin trading
Kind: instance method of bitmart
Returns: object - a borrow rate structure
See: https://developer-pro.bitmart.com/en/spot/#get-trading-pair-borrowing-rate-and-amount
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchBorrowRate (code, params)fetch the borrow interest rates of all currencies, currently only works for isolated margin
Kind: instance method of bitmart
Returns: object - a list of borrow rate structures
See: https://developer-pro.bitmart.com/en/spot/#get-trading-pair-borrowing-rate-and-amount
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchBorrowRates (params)transfer currency internally between wallets on the same account, currently only supports transfer between spot and margin
Kind: instance method of bitmart
Returns: object - a transfer structure
See: https://developer-pro.bitmart.com/en/spot/#margin-asset-transfer
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
amount to transfer |
| fromAccount | string |
account to transfer from |
| toAccount | string |
account to transfer to |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.transfer (code, amount, fromAccount, toAccount, params)fetch the interest owed by the user for borrowing currency for margin trading
Kind: instance method of bitmart
Returns: Array.<object> - a list of borrow interest structures
See: https://developer-pro.bitmart.com/en/spot/#get-borrow-record-isolated
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| symbol | string |
unified market symbol when fetch interest in isolated markets |
| since |
int | undefined
|
the earliest time in ms to fetch borrrow interest for |
| limit |
int | undefined
|
the maximum number of structures to retrieve |
| params | object |
extra parameters specific to the bitmart api endpoint |
bitmart.fetchBorrowInterest (code, symbol, since, limit, params)Kind: global class
Extends: Exchange
- fetchCurrencies
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchOrder
- fetchOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchMyTrades
- fetchLedger
- fetchTransactions
- fetchTicker
- fetchTickers
- fetchOHLCV
- fetchTrades
- createOrder
- cancelOrder
- cancelOrders
- cancelAllOrders
- fetchPositions
- withdraw
- fetchFundingRates
- fetchFundingRateHistory
- setLeverage
- setMarginMode
- fetchDepositAddress
- fetchDepositWithdrawFees
fetches all available currencies on an exchange
Kind: instance method of bitmex
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the mexc3 api endpoint |
bitmex.fetchCurrencies (params)retrieves data on all markets for bitmex
Kind: instance method of bitmex
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitmex.fetchMarkets (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitmex
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitmex
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchOrderBook (symbol, limit, params)fetches information on an order made by the user
Kind: instance method of bitmex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchOrder (symbol, params)fetches information on multiple orders made by the user
Kind: instance method of bitmex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchOrders (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of bitmex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitmex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchClosedOrders (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bitmex
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchMyTrades (symbol, since, limit, params)fetch the history of changes, actions done by the user or operations that altered balance of the user
Kind: instance method of bitmex
Returns: object - a ledger structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest ledger entry, default is undefined |
| limit |
int | undefined
|
max number of ledger entrys to return, default is undefined |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchLedger (code, since, limit, params)DEPRECATED use fetchDepositsWithdrawals instead
Kind: instance method of bitmex
Returns: object - a list of transaction structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code for the currency of the transactions, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest transaction, default is undefined |
| limit |
int | undefined
|
max number of transactions to return, default is undefined |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchTransactions (code, since, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitmex
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitmex
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchTickers (symbols, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitmex
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchOHLCV (symbol, timeframe, since, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitmex
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchTrades (symbol, since, limit, params)create a trade order
Kind: instance method of bitmex
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitmex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
not used by bitmex cancelOrder () |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.cancelOrder (id, symbol, params)cancel multiple orders
Kind: instance method of bitmex
Returns: object - an list of order structures
| Param | Type | Description |
|---|---|---|
| ids | Array.<string> |
order ids |
| symbol |
string | undefined
|
not used by bitmex cancelOrders () |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.cancelOrders (ids, symbol, params)cancel all open orders
Kind: instance method of bitmex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.cancelAllOrders (symbol, params)fetch all open positions
Kind: instance method of bitmex
Returns: Array.<object> - a list of position structure
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchPositions (symbols, params)make a withdrawal
Kind: instance method of bitmex
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.withdraw (code, amount, address, tag, params)fetch the funding rate for multiple markets
Kind: instance method of bitmex
Returns: object - a dictionary of funding rates structures, indexe by market symbols
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
list of unified market symbols |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchFundingRates (symbols, params)Fetches the history of funding rates
Kind: instance method of bitmex
Returns: Array.<object> - a list of funding rate structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market to fetch the funding rate history for |
| since |
int | undefined
|
timestamp in ms of the earliest funding rate to fetch |
| limit |
int | undefined
|
the maximum amount of funding rate structures to fetch |
| params | object |
extra parameters specific to the bitmex api endpoint |
| params.until |
int | undefined
|
timestamp in ms for ending date filter |
| params.reverse |
bool | undefined
|
if true, will sort results newest first |
| params.start |
int | undefined
|
starting point for results |
| params.columns |
string | undefined
|
array of column names to fetch in info, if omitted, will return all columns |
| params.filter |
string | undefined
|
generic table filter, send json key/value pairs, such as {"key": "value"}, you can key on individual fields, and do more advanced querying on timestamps, see the timestamp docs for more details |
bitmex.fetchFundingRateHistory (symbol, since, limit, params)set the level of leverage for a market
Kind: instance method of bitmex
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| leverage | float |
the rate of leverage |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.setLeverage (leverage, symbol, params)set margin mode to 'cross' or 'isolated'
Kind: instance method of bitmex
Returns: object - response from the exchange
| Param | Type | Description |
|---|---|---|
| marginMode | string |
'cross' or 'isolated' |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.setMarginMode (marginMode, symbol, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitmex
Returns: object - an address structure
See: https://www.bitmex.com/api/explorer/#!/User/User_getDepositAddress
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitmex api endpoint |
| params.network | string |
deposit chain, can view all chains via this.publicGetWalletAssets, default is eth, unless the currency has a default chain within this.options['networks'] |
bitmex.fetchDepositAddress (code, params)fetch deposit and withdraw fees
Kind: instance method of bitmex
Returns: object - a list of fee structures
See: https://www.bitmex.com/api/explorer/#!/Wallet/Wallet_getAssetsConfig
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitmex api endpoint |
bitmex.fetchDepositWithdrawFees (codes, params)Kind: global class
Extends: Exchange
- fetchCurrencies
- fetchMarkets
- fetchTicker
- fetchTickers
- fetchOrderBook
- fetchTrades
- fetchTradingFees
- fetchOHLCV
- fetchBalance
- createOrder
- cancelOrder
- cancelOrders
- cancelAllOrders
- fetchOrder
- fetchOrders
- fetchClosedOrders
- fetchMyTrades
- fetchDeposits
- fetchWithdrawals
- fetchWithdrawal
- withdraw
- fetchDepositWithdrawFees
fetches all available currencies on an exchange
Kind: instance method of bitopro
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchCurrencies (params)retrieves data on all markets for bitopro
Kind: instance method of bitopro
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitopro.fetchMarkets (params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitopro
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitopro
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchTickers (symbols, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitopro
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchOrderBook (symbol, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitopro
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchTrades (symbol, since, limit, params)fetch the trading fees for multiple markets
Kind: instance method of bitopro
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchTradingFees (params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitopro
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchOHLCV (symbol, timeframe, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitopro
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchBalance (params)create a trade order
Kind: instance method of bitopro
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitopro
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.cancelOrder (id, symbol, params)cancel multiple orders
Kind: instance method of bitopro
Returns: object - an list of order structures
| Param | Type | Description |
|---|---|---|
| ids | Array.<string> |
order ids |
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.cancelOrders (ids, symbol, params)cancel all open orders
Kind: instance method of bitopro
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.cancelAllOrders (symbol, params)fetches information on an order made by the user
Kind: instance method of bitopro
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchOrder (symbol, params)fetches information on multiple orders made by the user
Kind: instance method of bitopro
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitopro
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchClosedOrders (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bitopro
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchMyTrades (symbol, since, limit, params)fetch all deposits made to an account
Kind: instance method of bitopro
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of bitopro
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchWithdrawals (code, since, limit, params)fetch data on a currency withdrawal via the withdrawal id
Kind: instance method of bitopro
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| id | string |
withdrawal id |
| code | string |
unified currency code of the currency withdrawn, default is undefined |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchWithdrawal (id, code, params)make a withdrawal
Kind: instance method of bitopro
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.withdraw (code, amount, address, tag, params)fetch deposit and withdraw fees
Kind: instance method of bitopro
Returns: object - a list of fee structures
See: https://github.com/bitoex/bitopro-offical-api-docs/blob/master/v3-1/rest-1/open/currencies.md
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitopro api endpoint |
bitopro.fetchDepositWithdrawFees (codes, params)Kind: global class
Extends: Exchange
- fetchTime
- fetchCurrencies
- fetchMarkets
- fetchTradingFees
- fetchTicker
- fetchTickers
- fetchOrderBook
- fetchOHLCV
- fetchTrades
- fetchBalance
- createDepositAddress
- fetchDepositAddress
- fetchDeposits
- fetchWithdrawals
- withdraw
- createOrder
- cancelOrder
- cancelAllOrders
- cancelOrders
- fetchOrder
- fetchOpenOrders
- fetchClosedOrders
- fetchOrderTrades
- fetchMyTrades
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of bitpanda
Returns: int - the current integer timestamp in milliseconds from the exchange server
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchTime (params)fetches all available currencies on an exchange
Kind: instance method of bitpanda
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchCurrencies (params)retrieves data on all markets for bitpanda
Kind: instance method of bitpanda
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitpanda.fetchMarkets (params)fetch the trading fees for multiple markets
Kind: instance method of bitpanda
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchTradingFees (params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitpanda
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitpanda
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchTickers (symbols, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitpanda
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchOrderBook (symbol, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitpanda
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchOHLCV (symbol, timeframe, since, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitpanda
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchTrades (symbol, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitpanda
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchBalance (params)create a currency deposit address
Kind: instance method of bitpanda
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code of the currency for the deposit address |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.createDepositAddress (code, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitpanda
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchDepositAddress (code, params)fetch all deposits made to an account
Kind: instance method of bitpanda
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of bitpanda
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchWithdrawals (code, since, limit, params)make a withdrawal
Kind: instance method of bitpanda
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.withdraw (code, amount, address, tag, params)create a trade order
Kind: instance method of bitpanda
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitpanda
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
not used by bitmex cancelOrder () |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.cancelOrder (id, symbol, params)cancel all open orders
Kind: instance method of bitpanda
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.cancelAllOrders (symbol, params)cancel multiple orders
Kind: instance method of bitpanda
Returns: object - an list of order structures
| Param | Type | Description |
|---|---|---|
| ids | Array.<string> |
order ids |
| symbol |
string | undefined
|
unified market symbol, default is undefined |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.cancelOrders (ids, symbol, params)fetches information on an order made by the user
Kind: instance method of bitpanda
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
not used by bitpanda fetchOrder |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchOrder (symbol, params)fetch all unfilled currently open orders
Kind: instance method of bitpanda
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitpanda
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchClosedOrders (symbol, since, limit, params)fetch all the trades made from a single order
Kind: instance method of bitpanda
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades to retrieve |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchOrderTrades (id, symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bitpanda
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitpanda api endpoint |
bitpanda.fetchMyTrades (symbol, since, limit, params)Kind: global class
Extends: Exchange
- fetchStatus
- fetchTime
- fetchCurrencies
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchTicker
- fetchOHLCV
- fetchBidsAsks
- fetchTickers
- fetchTrades
- createOrder
- fetchOrder
- fetchClosedOrders
- fetchOpenOrders
- cancelOrder
- fetchMyTrades
- fetchDeposits
- fetchWithdrawals
- withdraw
- fetchDepositWithdrawFees
the latest known information on the availability of the exchange API
Kind: instance method of bitrue
Returns: object - a status structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchStatus (params)fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of bitrue
Returns: int - the current integer timestamp in milliseconds from the exchange server
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchTime (params)fetches all available currencies on an exchange
Kind: instance method of bitrue
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchCurrencies (params)retrieves data on all markets for bitrue
Kind: instance method of bitrue
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitrue.fetchMarkets (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitrue
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitrue
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitrue
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchTicker (symbol, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitrue
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchOHLCV (symbol, timeframe, since, limit, params)fetches the bid and ask price and volume for multiple markets
Kind: instance method of bitrue
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchBidsAsks (symbols, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitrue
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchTickers (symbols, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitrue
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchTrades (symbol, since, limit, params)create a trade order
Kind: instance method of bitrue
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.createOrder (symbol, type, side, amount, price, params)fetches information on an order made by the user
Kind: instance method of bitrue
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchOrder (symbol, params)fetches information on multiple closed orders made by the user
Kind: instance method of bitrue
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchClosedOrders (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of bitrue
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchOpenOrders (symbol, since, limit, params)cancels an open order
Kind: instance method of bitrue
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.cancelOrder (id, symbol, params)fetch all trades made by the user
Kind: instance method of bitrue
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchMyTrades (symbol, since, limit, params)fetch all deposits made to an account
Kind: instance method of bitrue
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of bitrue
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchWithdrawals (code, since, limit, params)make a withdrawal
Kind: instance method of bitrue
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.withdraw (code, amount, address, tag, params)fetch deposit and withdraw fees
Kind: instance method of bitrue
Returns: object - a list of fee structures
See: https://github.com/Bitrue-exchange/Spot-official-api-docs#exchangeInfo_endpoint
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitrue api endpoint |
bitrue.fetchDepositWithdrawFees (codes, params)Kind: global class
Extends: Exchange
- fetchLedger
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchTicker
- fetchOHLCV
- fetchTrades
- fetchTradingFees
- fetchMyTrades
- createOrder
- cancelOrder
- cancelOrders
- cancelAllOrders
- fetchOpenOrders
- fetchOrder
- fetchOrderTrades
- fetchDeposit
- fetchDeposits
- fetchDepositAddress
- fetchTransactionFees
- fetchDepositWithdrawFees
- withdraw
fetch the history of changes, actions done by the user or operations that altered balance of the user
Kind: instance method of bitso
Returns: object - a ledger structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest ledger entry, default is undefined |
| limit |
int | undefined
|
max number of ledger entrys to return, default is undefined |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchLedger (code, since, limit, params)retrieves data on all markets for bitso
Kind: instance method of bitso
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitso.fetchMarkets (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitso
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitso
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitso
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchTicker (symbol, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitso
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchOHLCV (symbol, timeframe, since, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitso
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchTrades (symbol, since, limit, params)fetch the trading fees for multiple markets
Kind: instance method of bitso
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchTradingFees (params)fetch all trades made by the user
Kind: instance method of bitso
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchMyTrades (symbol, since, limit, params)create a trade order
Kind: instance method of bitso
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitso
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
not used by bitso cancelOrder () |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.cancelOrder (id, symbol, params)cancel multiple orders
Kind: instance method of bitso
Returns: object - an list of order structures
| Param | Type | Description |
|---|---|---|
| ids | Array.<string> |
order ids |
| symbol |
string | undefined
|
unified market symbol |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.cancelOrders (ids, symbol, params)cancel all open orders
Kind: instance method of bitso
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | undefined |
bitso does not support canceling orders for only a specific market |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.cancelAllOrders (symbol, params)fetch all unfilled currently open orders
Kind: instance method of bitso
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchOpenOrders (symbol, since, limit, params)fetches information on an order made by the user
Kind: instance method of bitso
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
not used by bitso fetchOrder |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchOrder (symbol, params)fetch all the trades made from a single order
Kind: instance method of bitso
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades to retrieve |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchOrderTrades (id, symbol, since, limit, params)fetch information on a deposit
Kind: instance method of bitso
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| id | string |
deposit id |
| code |
string | undefined
|
bitso does not support filtering by currency code and will ignore this argument |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchDeposit (id, code, params)fetch all deposits made to an account
Kind: instance method of bitso
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the exmo api endpoint |
bitso.fetchDeposits (code, since, limit, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitso
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchDepositAddress (code, params)DEPRECATED please use fetchDepositWithdrawFees instead
Kind: instance method of bitso
Returns: Array.<object> - a list of fee structures
See: https://bitso.com/api_info#fees
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchTransactionFees (codes, params)fetch deposit and withdraw fees
Kind: instance method of bitso
Returns: Array.<object> - a list of fee structures
See: https://bitso.com/api_info#fees
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.fetchDepositWithdrawFees (codes, params)make a withdrawal
Kind: instance method of bitso
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitso api endpoint |
bitso.withdraw (code, amount, address, tag, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchCurrencies
- fetchOrderBook
- fetchTicker
- fetchTickers
- fetchTrades
- fetchOHLCV
- fetchBalance
- fetchTradingFee
- fetchTradingFees
- fetchTransactionFees
- fetchDepositWithdrawFees
- createOrder
- cancelOrder
- cancelAllOrders
- fetchOrder
- fetchMyTrades
- fetchTransactions
- fetchWithdrawals
- fetchLedger
- fetchOpenOrders
- fetchDepositAddress
- withdraw
retrieves data on all markets for bitstamp
Kind: instance method of bitstamp
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitstamp.fetchMarkets (params)fetches all available currencies on an exchange
Kind: instance method of bitstamp
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchCurrencies (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitstamp
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitstamp
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitstamp
Returns: object - a dictionary of ticker structures
See: https://www.bitstamp.net/api/#all-tickers
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchTickers (symbols, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitstamp
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchTrades (symbol, since, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitstamp
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchOHLCV (symbol, timeframe, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitstamp
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchBalance (params)fetch the trading fees for a market
Kind: instance method of bitstamp
Returns: object - a fee structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchTradingFee (symbol, params)fetch the trading fees for multiple markets
Kind: instance method of bitstamp
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchTradingFees (params)DEPRECATED please use fetchDepositWithdrawFees instead
Kind: instance method of bitstamp
Returns: Array.<object> - a list of fee structures
See: https://www.bitstamp.net/api/#balance
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchTransactionFees (codes, params)fetch deposit and withdraw fees
Kind: instance method of bitstamp
Returns: Array.<object> - a list of fee structures
See: https://www.bitstamp.net/api/#balance
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchDepositWithdrawFees (codes, params)create a trade order
Kind: instance method of bitstamp
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitstamp
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.cancelOrder (id, symbol, params)cancel all open orders
Kind: instance method of bitstamp
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.cancelAllOrders (symbol, params)fetches information on an order made by the user
Kind: instance method of bitstamp
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchOrder (symbol, params)fetch all trades made by the user
Kind: instance method of bitstamp
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchMyTrades (symbol, since, limit, params)DEPRECATED use fetchDepositsWithdrawals instead
Kind: instance method of bitstamp
Returns: object - a list of transaction structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code for the currency of the transactions, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest transaction, default is undefined |
| limit |
int | undefined
|
max number of transactions to return, default is undefined |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchTransactions (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of bitstamp
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchWithdrawals (code, since, limit, params)fetch the history of changes, actions done by the user or operations that altered balance of the user
Kind: instance method of bitstamp
Returns: object - a ledger structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest ledger entry, default is undefined |
| limit |
int | undefined
|
max number of ledger entrys to return, default is undefined |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchLedger (code, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of bitstamp
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchOpenOrders (symbol, since, limit, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitstamp
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.fetchDepositAddress (code, params)make a withdrawal
Kind: instance method of bitstamp
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitstamp api endpoint |
bitstamp.withdraw (code, amount, address, tag, params)Kind: global class
Extends: Exchange
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitstamp1
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitstamp1 api endpoint |
bitstamp1.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitstamp1
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitstamp1 api endpoint |
bitstamp1.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitstamp1
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitstamp1 api endpoint |
bitstamp1.fetchTrades (symbol, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitstamp1
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitstamp1 api endpoint |
bitstamp1.fetchBalance (params)create a trade order
Kind: instance method of bitstamp1
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitstamp1 api endpoint |
bitstamp1.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitstamp1
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitstamp1 api endpoint |
bitstamp1.cancelOrder (id, symbol, params)fetch all trades made by the user
Kind: instance method of bitstamp1
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitstamp1 api endpoint |
bitstamp1.fetchMyTrades (symbol, since, limit, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchCurrencies
- fetchTickers
- fetchTicker
- fetchBidsAsks
- fetchTime
- fetchTrades
- fetchTradingFee
- fetchTradingFees
- fetchOHLCV
- fetchOpenOrders
- fetchOrderTrades
- createOrder
- cancelOrder
- cancelAllOrders
- fetchDeposit
- fetchDeposits
- fetchPendingDeposits
- fetchWithdrawal
- fetchWithdrawals
- fetchPendingWithdrawals
- fetchOrder
- fetchMyTrades
- fetchClosedOrders
- createDepositAddress
- fetchDepositAddress
- fetchDepositWithdrawFees
- withdraw
retrieves data on all markets for bittrex
Kind: instance method of bittrex
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bittrex.fetchMarkets (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bittrex
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bittrex
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchOrderBook (symbol, limit, params)fetches all available currencies on an exchange
Kind: instance method of bittrex
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchCurrencies (params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bittrex
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchTickers (symbols, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bittrex
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchTicker (symbol, params)fetches the bid and ask price and volume for multiple markets
Kind: instance method of bittrex
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned |
| params | object |
extra parameters specific to the binance api endpoint |
bittrex.fetchBidsAsks (symbols, params)fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of bittrex
Returns: int - the current integer timestamp in milliseconds from the exchange server
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchTime (params)get the list of most recent trades for a particular symbol
Kind: instance method of bittrex
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchTrades (symbol, since, limit, params)fetch the trading fees for a market
Kind: instance method of bittrex
Returns: object - a fee structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchTradingFee (symbol, params)fetch the trading fees for multiple markets
Kind: instance method of bittrex
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchTradingFees (params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bittrex
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchOHLCV (symbol, timeframe, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of bittrex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchOpenOrders (symbol, since, limit, params)fetch all the trades made from a single order
Kind: instance method of bittrex
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades to retrieve |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchOrderTrades (id, symbol, since, limit, params)create a trade order
Kind: instance method of bittrex
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bittrex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.cancelOrder (id, symbol, params)cancel all open orders
Kind: instance method of bittrex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.cancelAllOrders (symbol, params)fetch data on a currency deposit via the deposit id
Kind: instance method of bittrex
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| id | string |
deposit id |
| code |
string | undefined
|
filter by currency code |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchDeposit (id, code, params)fetch all deposits made to an account
Kind: instance method of bittrex
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bittrex api endpoint |
| params.endDate |
int | undefined
|
Filters out result after this timestamp. Uses ISO-8602 format. |
| params.nextPageToken |
string | undefined
|
The unique identifier of the item that the resulting query result should start after, in the sort order of the given endpoint. Used for traversing a paginated set in the forward direction. |
| params.previousPageToken |
string | undefined
|
The unique identifier of the item that the resulting query result should end before, in the sort order of the given endpoint. Used for traversing a paginated set in the reverse direction. |
bittrex.fetchDeposits (code, since, limit, params)fetch all pending deposits made from an account
Kind: instance method of bittrex
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bittrex api endpoint |
| params.endDate |
int | undefined
|
Filters out result after this timestamp. Uses ISO-8602 format. |
| params.nextPageToken |
string | undefined
|
The unique identifier of the item that the resulting query result should start after, in the sort order of the given endpoint. Used for traversing a paginated set in the forward direction. |
| params.previousPageToken |
string | undefined
|
The unique identifier of the item that the resulting query result should end before, in the sort order of the given endpoint. Used for traversing a paginated set in the reverse direction. |
bittrex.fetchPendingDeposits (code, since, limit, params)fetch data on a currency withdrawal via the withdrawal id
Kind: instance method of bittrex
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| id | string |
withdrawal id |
| code |
string | undefined
|
filter by currency code |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchWithdrawal (id, code, params)fetch all withdrawals made from an account
Kind: instance method of bittrex
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bittrex api endpoint |
| params.endDate |
int | undefined
|
Filters out result after this timestamp. Uses ISO-8602 format. |
| params.nextPageToken |
string | undefined
|
The unique identifier of the item that the resulting query result should start after, in the sort order of the given endpoint. Used for traversing a paginated set in the forward direction. |
| params.previousPageToken |
string | undefined
|
The unique identifier of the item that the resulting query result should end before, in the sort order of the given endpoint. Used for traversing a paginated set in the reverse direction. |
bittrex.fetchWithdrawals (code, since, limit, params)fetch all pending withdrawals made from an account
Kind: instance method of bittrex
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bittrex api endpoint |
| params.endDate |
int | undefined
|
Filters out result after this timestamp. Uses ISO-8602 format. |
| params.nextPageToken |
string | undefined
|
The unique identifier of the item that the resulting query result should start after, in the sort order of the given endpoint. Used for traversing a paginated set in the forward direction. |
| params.previousPageToken |
string | undefined
|
The unique identifier of the item that the resulting query result should end before, in the sort order of the given endpoint. Used for traversing a paginated set in the reverse direction. |
bittrex.fetchPendingWithdrawals (code, since, limit, params)fetches information on an order made by the user
Kind: instance method of bittrex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchOrder (symbol, params)fetch all trades made by the user
Kind: instance method of bittrex
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchMyTrades (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of bittrex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchClosedOrders (symbol, since, limit, params)create a currency deposit address
Kind: instance method of bittrex
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code of the currency for the deposit address |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.createDepositAddress (code, params)fetch the deposit address for a currency associated with this account
Kind: instance method of bittrex
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchDepositAddress (code, params)fetch deposit and withdraw fees
Kind: instance method of bittrex
Returns: object - a list of fee structures
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.fetchDepositWithdrawFees (codes, params)make a withdrawal
Kind: instance method of bittrex
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bittrex api endpoint |
bittrex.withdraw (code, amount, address, tag, params)Kind: global class
Extends: Exchange
- fetchTime
- fetchMarkets
- fetchCurrencies
- fetchTicker
- fetchTickers
- fetchTrades
- fetchTradingFees
- fetchOrderBook
- fetchOHLCV
- fetchBalance
- fetchDepositAddress
- createOrder
- cancelOrder
- cancelAllOrders
- fetchOrder
- fetchOrders
- fetchOpenOrders
- fetchMyTrades
- withdraw
- fetchWithdrawals
- fetchDeposits
- fetchDepositWithdrawFees
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of bitvavo
Returns: int - the current integer timestamp in milliseconds from the exchange server
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchTime (params)retrieves data on all markets for bitvavo
Kind: instance method of bitvavo
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bitvavo.fetchMarkets (params)fetches all available currencies on an exchange
Kind: instance method of bitvavo
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchCurrencies (params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bitvavo
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bitvavo
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchTickers (symbols, params)get the list of most recent trades for a particular symbol
Kind: instance method of bitvavo
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchTrades (symbol, since, limit, params)fetch the trading fees for multiple markets
Kind: instance method of bitvavo
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchTradingFees (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bitvavo
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchOrderBook (symbol, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bitvavo
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchOHLCV (symbol, timeframe, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bitvavo
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchBalance (params)fetch the deposit address for a currency associated with this account
Kind: instance method of bitvavo
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchDepositAddress (code, params)create a trade order
Kind: instance method of bitvavo
Returns: object - an order structure
See: https://docs.bitvavo.com/#tag/Orders/paths/~1order/post
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bitvavo api endpoint |
| params.timeInForce |
string | undefined
|
"GTC", "IOC", or "PO" |
| params.stopPrice |
float | undefined
|
The price at which a trigger order is triggered at |
| params.triggerPrice |
float | undefined
|
The price at which a trigger order is triggered at |
| params.postOnly |
bool | undefined
|
If true, the order will only be posted to the order book and not executed immediately |
| params.stopLossPrice |
float | undefined
|
The price at which a stop loss order is triggered at |
| params.takeProfitPrice |
float | undefined
|
The price at which a take profit order is triggered at |
| params.triggerType |
string | undefined
|
"price" |
| params.triggerReference |
string | undefined
|
"lastTrade", "bestBid", "bestAsk", "midPrice" Only for stop orders: Use this to determine which parameter will trigger the order |
| params.selfTradePrevention |
string | undefined
|
"decrementAndCancel", "cancelOldest", "cancelNewest", "cancelBoth" |
| params.disableMarketProtection |
bool | undefined
|
don't cancel if the next fill price is 10% worse than the best fill price |
| params.responseRequired |
bool | undefined
|
Set this to 'false' when only an acknowledgement of success or failure is required, this is faster. |
bitvavo.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bitvavo
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.cancelOrder (id, symbol, params)cancel all open orders
Kind: instance method of bitvavo
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.cancelAllOrders (symbol, params)fetches information on an order made by the user
Kind: instance method of bitvavo
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchOrder (symbol, params)fetches information on multiple orders made by the user
Kind: instance method of bitvavo
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchOrders (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of bitvavo
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchOpenOrders (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of bitvavo
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchMyTrades (symbol, since, limit, params)make a withdrawal
Kind: instance method of bitvavo
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.withdraw (code, amount, address, tag, params)fetch all withdrawals made from an account
Kind: instance method of bitvavo
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchWithdrawals (code, since, limit, params)fetch all deposits made to an account
Kind: instance method of bitvavo
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchDeposits (code, since, limit, params)fetch deposit and withdraw fees
Kind: instance method of bitvavo
Returns: object - a list of fee structures
See: https://docs.bitvavo.com/#tag/General/paths/~1assets/get
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bitvavo api endpoint |
bitvavo.fetchDepositWithdrawFees (codes, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchCurrencies
- fetchTime
- fetchStatus
- fetchOHLCV
- fetchTicker
- fetchTickers
- fetchOrderBook
- fetchTrades
- fetchBalance
- fetchDepositAddress
- fetchDeposits
- fetchWithdrawals
- createOrder
- cancelOrder
- cancelOrders
- fetchOpenOrders
- fetchOpenOrder
- fetchClosedOrders
- fetchTransactionFees
- fetchDepositWithdrawFees
- fetchFundingRateHistory
- fetchMarketLeverageTiers
retrieves data on all markets for bkex
Kind: instance method of bkex
Returns: Array.<object> - an array of objects representing market data
See
- https://bkexapi.github.io/docs/api_en.htm?shell#basicInformation-1
- https://bkexapi.github.io/docs/api_en.htm?shell#contract-market-symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
bkex.fetchMarkets (params)fetches all available currencies on an exchange
Kind: instance method of bkex
Returns: object - an associative dictionary of currencies
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchCurrencies (params)fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of bkex
Returns: int - the current integer timestamp in milliseconds from the exchange server
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchTime (params)the latest known information on the availability of the exchange API
Kind: instance method of bkex
Returns: object - a status structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchStatus (params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of bkex
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See
- https://bkexapi.github.io/docs/api_en.htm?shell#quotationData-1
- https://bkexapi.github.io/docs/api_en.htm?shell#contract-kline
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchOHLCV (symbol, timeframe, since, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bkex
Returns: object - a ticker structure
See
- https://bkexapi.github.io/docs/api_en.htm?shell#quotationData-2
- https://bkexapi.github.io/docs/api_en.htm?shell#contract-ticker-data
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of bkex
Returns: object - a dictionary of ticker structures
See
- https://bkexapi.github.io/docs/api_en.htm?shell#quotationData-2
- https://bkexapi.github.io/docs/api_en.htm?shell#contract-ticker-data
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchTickers (symbols, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bkex
Returns: object - A dictionary of order book structures indexed by market symbols
See
- https://bkexapi.github.io/docs/api_en.htm?shell#quotationData-4
- https://bkexapi.github.io/docs/api_en.htm?shell#contract-deep-data
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchOrderBook (symbol, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of bkex
Returns: Array.<object> - a list of trade structures
See
- https://bkexapi.github.io/docs/api_en.htm?shell#quotationData-5
- https://bkexapi.github.io/docs/api_en.htm?shell#contract-trades-history
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchTrades (symbol, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bkex
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchBalance (params)fetch the deposit address for a currency associated with this account
Kind: instance method of bkex
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchDepositAddress (code, params)fetch all deposits made to an account
Kind: instance method of bkex
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of bkex
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchWithdrawals (code, since, limit, params)create a trade order
Kind: instance method of bkex
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bkex
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.cancelOrder (id, symbol, params)cancel multiple orders
Kind: instance method of bkex
Returns: object - an list of order structures
| Param | Type | Description |
|---|---|---|
| ids | Array.<string> |
order ids |
| symbol |
string | undefined
|
unified market symbol, default is undefined |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.cancelOrders (ids, symbol, params)fetch all unfilled currently open orders
Kind: instance method of bkex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchOpenOrders (symbol, since, limit, params)fetch an open order by it's id
Kind: instance method of bkex
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified market symbol, default is undefined |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchOpenOrder (id, symbol, params)fetches information on multiple closed orders made by the user
Kind: instance method of bkex
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchClosedOrders (symbol, since, limit, params)DEPRECATED please use fetchDepositWithdrawFees instead
Kind: instance method of bkex
Returns: object - a list of fee structures
See: https://bkexapi.github.io/docs/api_en.htm?shell#basicInformation-2
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchTransactionFees (codes, params)fetch deposit and withdraw fees
Kind: instance method of bkex
Returns: object - a list of fee structures
See: https://bkexapi.github.io/docs/api_en.htm?shell#basicInformation-2
| Param | Type | Description |
|---|---|---|
| codes |
Array.<string> | undefined
|
list of unified currency codes |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchDepositWithdrawFees (codes, params)fetches historical funding rate prices
Kind: instance method of bkex
Returns: Array.<object> - a list of funding rate structures
See: https://bkexapi.github.io/docs/api_en.htm?shell#contract-fundingRate
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market to fetch the funding rate history for |
| since |
int | undefined
|
timestamp in ms of the earliest funding rate to fetch |
| limit |
int | undefined
|
the maximum amount of funding rate structures to fetch |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchFundingRateHistory (symbol, since, limit, params)retrieve information on the maximum leverage, for different trade sizes for a single market
Kind: instance method of bkex
Returns: object - a leverage tiers structure
See: https://bkexapi.github.io/docs/api_en.htm?shell#contract-riskLimit
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| params | object |
extra parameters specific to the bkex api endpoint |
bkex.fetchMarketLeverageTiers (symbol, params)Kind: global class
Extends: Exchange
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of bl3p
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bl3p api endpoint |
bl3p.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of bl3p
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the bl3p api endpoint |
bl3p.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of bl3p
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the bl3p api endpoint |
bl3p.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of bl3p
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the bl3p api endpoint |
bl3p.fetchTrades (symbol, since, limit, params)fetch the trading fees for multiple markets
Kind: instance method of bl3p
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the bl3p api endpoint |
bl3p.fetchTradingFees (params)create a trade order
Kind: instance method of bl3p
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the bl3p api endpoint |
bl3p.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of bl3p
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the bl3p api endpoint |
bl3p.cancelOrder (id, symbol, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchOrderBook
- fetchL3OrderBook
- fetchTicker
- fetchTickers
- createOrder
- cancelOrder
- cancelAllOrders
- fetchTradingFees
- fetchCanceledOrders
- fetchClosedOrders
- fetchOpenOrders
- fetchMyTrades
- fetchDepositAddress
- fetchWithdrawalWhitelist
- withdraw
- fetchWithdrawals
- fetchWithdrawal
- fetchDeposits
- fetchDeposit
- fetchBalance
- fetchOrder
retrieves data on all markets for blockchaincom
Kind: instance method of blockchaincom
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
blockchaincom.fetchMarkets (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of blockchaincom
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchOrderBook (symbol, limit, params)fetches level 3 information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of blockchaincom
Returns: object - an order book structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| limit |
int | undefined
|
max number of orders to return, default is undefined |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchL3OrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of blockchaincom
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchTicker (symbol, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of blockchaincom
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchTickers (symbols, params)create a trade order
Kind: instance method of blockchaincom
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of blockchaincom
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.cancelOrder (id, symbol, params)cancel all open orders
Kind: instance method of blockchaincom
Returns: object - an list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market to cancel orders in, all markets are used if undefined, default is undefined |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.cancelAllOrders (symbol, params)fetch the trading fees for multiple markets
Kind: instance method of blockchaincom
Returns: object - a dictionary of fee structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchTradingFees (params)fetches information on multiple canceled orders made by the user
Kind: instance method of blockchaincom
Returns: object - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
timestamp in ms of the earliest order, default is undefined |
| limit |
int | undefined
|
max number of orders to return, default is undefined |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchCanceledOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of blockchaincom
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchClosedOrders (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of blockchaincom
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchOpenOrders (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of blockchaincom
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchMyTrades (symbol, since, limit, params)fetch the deposit address for a currency associated with this account
Kind: instance method of blockchaincom
Returns: object - an address structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchDepositAddress (code, params)fetch the list of withdrawal addresses on the whitelist
Kind: instance method of blockchaincom
Returns: object - dictionary with keys beneficiaryId, name, currency
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchWithdrawalWhitelist (params)make a withdrawal
Kind: instance method of blockchaincom
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.withdraw (code, amount, address, tag, params)fetch all withdrawals made from an account
Kind: instance method of blockchaincom
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchWithdrawals (code, since, limit, params)fetch data on a currency withdrawal via the withdrawal id
Kind: instance method of blockchaincom
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| id | string |
withdrawal id |
| code |
string | undefined
|
not used by blockchaincom.fetchWithdrawal |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchWithdrawal (id, code, params)fetch all deposits made to an account
Kind: instance method of blockchaincom
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchDeposits (code, since, limit, params)fetch information on a deposit
Kind: instance method of blockchaincom
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| id | string |
deposit id |
| code |
string | undefined
|
not used by blockchaincom fetchDeposit () |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchDeposit (id, code, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of blockchaincom
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchBalance (params)fetches information on an order made by the user
Kind: instance method of blockchaincom
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
not used by blockchaincom fetchOrder |
| params | object |
extra parameters specific to the blockchaincom api endpoint |
blockchaincom.fetchOrder (symbol, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchTickers
- fetchTicker
- fetchOrderBook
- fetchTrades
- fetchDeposits
- fetchWithdrawals
- fetchOHLCV
- fetchBalance
- createOrder
- cancelOrder
- fetchOrder
- fetchOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchMyTrades
retrieves data on all markets for btcalpha
Kind: instance method of btcalpha
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
btcalpha.fetchMarkets (params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of btcalpha
Returns: object - a dictionary of ticker structures
See: https://btc-alpha.github.io/api-docs/#tickers
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchTickers (symbols, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of btcalpha
Returns: object - a ticker structure
See: https://btc-alpha.github.io/api-docs/#tickers
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchTicker (symbol, params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of btcalpha
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchOrderBook (symbol, limit, params)get the list of most recent trades for a particular symbol
Kind: instance method of btcalpha
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchTrades (symbol, since, limit, params)fetch all deposits made to an account
Kind: instance method of btcalpha
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of btcalpha
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchWithdrawals (code, since, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of btcalpha
Returns: Array.<Array.<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchOHLCV (symbol, timeframe, since, limit, params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of btcalpha
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchBalance (params)create a trade order
Kind: instance method of btcalpha
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of btcalpha
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.cancelOrder (id, symbol, params)fetches information on an order made by the user
Kind: instance method of btcalpha
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
not used by btcalpha fetchOrder |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchOrder (symbol, params)fetches information on multiple orders made by the user
Kind: instance method of btcalpha
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchOrders (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of btcalpha
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of btcalpha
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchClosedOrders (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of btcalpha
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the btcalpha api endpoint |
btcalpha.fetchMyTrades (symbol, since, limit, params)Kind: global class
Extends: Exchange
- fetchBalance
- fetchOrderBook
- fetchTicker
- fetchTrades
- createOrder
- cancelOrder
- fetchOrder
- fetchOrders
- fetchOpenOrders
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of btcbox
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the btcbox api endpoint |
btcbox.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of btcbox
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the btcbox api endpoint |
btcbox.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of btcbox
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the btcbox api endpoint |
btcbox.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of btcbox
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the btcbox api endpoint |
btcbox.fetchTrades (symbol, since, limit, params)create a trade order
Kind: instance method of btcbox
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the btcbox api endpoint |
btcbox.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of btcbox
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the btcbox api endpoint |
btcbox.cancelOrder (id, symbol, params)fetches information on an order made by the user
Kind: instance method of btcbox
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified symbol of the market the order was made in |
| params | object |
extra parameters specific to the btcbox api endpoint |
btcbox.fetchOrder (symbol, params)fetches information on multiple orders made by the user
Kind: instance method of btcbox
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the btcbox api endpoint |
btcbox.fetchOrders (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of btcbox
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the btcbox api endpoint |
btcbox.fetchOpenOrders (symbol, since, limit, params)Kind: global class
Extends: Exchange
- fetchTransactions
- fetchDeposits
- fetchWithdrawals
- fetchMarkets
- fetchTime
- fetchBalance
- fetchOHLCV
- fetchOrderBook
- fetchTicker
- fetchTrades
- createOrder
- cancelOrders
- cancelOrder
- fetchOrder
- fetchOrders
- fetchOpenOrders
- fetchClosedOrders
- fetchMyTrades
- withdraw
deprecated use fetchDepositsWithdrawals instead
Kind: instance method of btcmarkets
Returns: object - a list of transaction structure
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code for the currency of the transactions, default is undefined |
| since |
int | undefined
|
timestamp in ms of the earliest transaction, default is undefined |
| limit |
int | undefined
|
max number of transactions to return, default is undefined |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchTransactions (code, since, limit, params)fetch all deposits made to an account
Kind: instance method of btcmarkets
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch deposits for |
| limit |
int | undefined
|
the maximum number of deposits structures to retrieve |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchDeposits (code, since, limit, params)fetch all withdrawals made from an account
Kind: instance method of btcmarkets
Returns: Array.<object> - a list of transaction structures
| Param | Type | Description |
|---|---|---|
| code |
string | undefined
|
unified currency code |
| since |
int | undefined
|
the earliest time in ms to fetch withdrawals for |
| limit |
int | undefined
|
the maximum number of withdrawals structures to retrieve |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchWithdrawals (code, since, limit, params)retrieves data on all markets for btcmarkets
Kind: instance method of btcmarkets
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
btcmarkets.fetchMarkets (params)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
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchTime (params)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
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchBalance (params)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
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
the length of time each candle represents |
| since |
int | undefined
|
timestamp in ms of the earliest candle to fetch |
| limit |
int | undefined
|
the maximum amount of candles to fetch |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchOHLCV (symbol, timeframe, since, limit, params)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
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchOrderBook (symbol, limit, params)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
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of btcmarkets
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchTrades (symbol, since, limit, params)create a trade order
Kind: instance method of btcmarkets
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
'market' or 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.createOrder (symbol, type, side, amount, price, params)cancel multiple orders
Kind: instance method of btcmarkets
Returns: object - an list of order structures
| Param | Type | Description |
|---|---|---|
| ids | Array.<string> |
order ids |
| symbol |
string | undefined
|
not used by btcmarkets cancelOrders () |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.cancelOrders (ids, symbol, params)cancels an open order
Kind: instance method of btcmarkets
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
not used by btcmarket cancelOrder () |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.cancelOrder (id, symbol, params)fetches information on an order made by the user
Kind: instance method of btcmarkets
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
not used by btcmarkets fetchOrder |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchOrder (symbol, params)fetches information on multiple orders made by the user
Kind: instance method of btcmarkets
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchOrders (symbol, since, limit, params)fetch all unfilled currently open orders
Kind: instance method of btcmarkets
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchOpenOrders (symbol, since, limit, params)fetches information on multiple closed orders made by the user
Kind: instance method of btcmarkets
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol of the market orders were made in |
| since |
int | undefined
|
the earliest time in ms to fetch orders for |
| limit |
int | undefined
|
the maximum number of orde structures to retrieve |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchClosedOrders (symbol, since, limit, params)fetch all trades made by the user
Kind: instance method of btcmarkets
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol |
string | undefined
|
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch trades for |
| limit |
int | undefined
|
the maximum number of trades structures to retrieve |
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.fetchMyTrades (symbol, since, limit, params)make a withdrawal
Kind: instance method of btcmarkets
Returns: object - a transaction structure
| Param | Type | Description |
|---|---|---|
| code | string |
unified currency code |
| amount | float |
the amount to withdraw |
| address | string |
the address to withdraw to |
| tag |
string | undefined
|
|
| params | object |
extra parameters specific to the btcmarkets api endpoint |
btcmarkets.withdraw (code, amount, address, tag, params)Kind: global class
Extends: Exchange
sign in, must be called prior to using other authenticated methods
Kind: instance method of btctradeua
Returns: response from exchange
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the btctradeua api endpoint |
btctradeua.signIn (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of btctradeua
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the btctradeua api endpoint |
btctradeua.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of btctradeua
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the btctradeua api endpoint |
btctradeua.fetchOrderBook (symbol, limit, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of btctradeua
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the btctradeua api endpoint |
btctradeua.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of btctradeua
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the btctradeua api endpoint |
btctradeua.fetchTrades (symbol, since, limit, params)create a trade order
Kind: instance method of btctradeua
Returns: object - an order structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to create an order in |
| type | string |
must be 'limit' |
| side | string |
'buy' or 'sell' |
| amount | float |
how much of currency you want to trade in units of base currency |
| price |
float | undefined
|
the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
extra parameters specific to the btctradeua api endpoint |
btctradeua.createOrder (symbol, type, side, amount, price, params)cancels an open order
Kind: instance method of btctradeua
Returns: object - An order structure
| Param | Type | Description |
|---|---|---|
| id | string |
order id |
| symbol |
string | undefined
|
not used by btctradeua cancelOrder () |
| params | object |
extra parameters specific to the btctradeua api endpoint |
btctradeua.cancelOrder (id, symbol, params)fetch all unfilled currently open orders
Kind: instance method of btctradeua
Returns: Array.<object> - a list of order structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified market symbol |
| since |
int | undefined
|
the earliest time in ms to fetch open orders for |
| limit |
int | undefined
|
the maximum number of open orders structures to retrieve |
| params | object |
extra parameters specific to the btctradeua api endpoint |
btctradeua.fetchOpenOrders (symbol, since, limit, params)Kind: global class
Extends: Exchange
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchTickers
- fetchTicker
- fetchTrades
- fetchOHLCV
- createOrder
- cancelOrder
- fetchOpenOrders
- fetchOrders
- fetchMyTrades
retrieves data on all markets for btcturk
Kind: instance method of btcturk
Returns: Array.<object> - an array of objects representing market data
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the exchange api endpoint |
btcturk.fetchMarkets (params)query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of btcturk
Returns: object - a balance structure
| Param | Type | Description |
|---|---|---|
| params | object |
extra parameters specific to the btcturk api endpoint |
btcturk.fetchBalance (params)fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of btcturk
Returns: object - A dictionary of order book structures indexed by market symbols
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the order book for |
| limit |
int | undefined
|
the maximum amount of order book entries to return |
| params | object |
extra parameters specific to the btcturk api endpoint |
btcturk.fetchOrderBook (symbol, limit, params)fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
Kind: instance method of btcturk
Returns: object - a dictionary of ticker structures
| Param | Type | Description |
|---|---|---|
| symbols |
Array.<string> | undefined
|
unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
extra parameters specific to the btcturk api endpoint |
btcturk.fetchTickers (symbols, params)fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of btcturk
Returns: object - a ticker structure
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch the ticker for |
| params | object |
extra parameters specific to the btcturk api endpoint |
btcturk.fetchTicker (symbol, params)get the list of most recent trades for a particular symbol
Kind: instance method of btcturk
Returns: Array.<object> - a list of trade structures
| Param | Type | Description |
|---|---|---|
| symbol | string |
unified symbol of the market to fetch trades for |
| since |
int | undefined
|
timestamp in ms of the earliest trade to fetch |
| limit |
int | undefined
|
the maximum amount of trades to fetch |
| params | object |
extra parameters specific to the btcturk api endpoint |
btcturk.fetchTrades (symbol, since, limit, params)fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of btcturk
Returns: Array.<Array.<int>> - A list of candl
https://ccxt.pro
Exchanges
Install
Manual
- Supported Exchanges
- Exchanges By Country
- Install
- Manual
- Error Handling
- Troubleshooting
- Examples
- Knowledge Base (wip)
- Contributing
- API Reference (wip)
- Frequently Asked Questions
- New Exchanges