22 KiB
foxbit{docsify-ignore}
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchTicker
- fetchTickers
- fetchTradingFees
- fetchOrderBook
- fetchTrades
- fetchOHLCV
- fetchBalance
- fetchOpenOrders
- fetchClosedOrders
- createOrder
- createOrders
- cancelOrder
- cancelAllOrders
- fetchOrder
- fetchOrders
- fetchMyTrades
- fetchDepositAddress
- fetchDeposits
- fetchWithdrawals
- fetchTransactions
- fetchStatus
- editOrder
- withdraw
- fetchLedger
fetchMarkets{docsify-ignore}
Retrieves data on all markets for foxbit.
Kind: instance method of foxbit
Returns: Array<object> - an array of objects representing market data
See: https://docs.foxbit.com.br/rest/v3/#tag/Market-Data/operation/MarketsController_index
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchMarkets ([params])
fetchTicker{docsify-ignore}
Get last 24 hours ticker information, in real-time, for given market.
Kind: instance method of foxbit
Returns: object - a ticker structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Market-Data/operation/MarketsController_ticker
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the ticker for |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchTicker (symbol[, params])
fetchTickers{docsify-ignore}
Retrieve the ticker data of all markets.
Kind: instance method of foxbit
Returns: object - a dictionary of ticker structures
See: https://docs.foxbit.com.br/rest/v3/#tag/Market-Data/operation/MarketsController_tickers
| Param | Type | Required | Description |
|---|---|---|---|
| symbols | Array<string>, undefined |
Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchTickers (symbols[, params])
fetchTradingFees{docsify-ignore}
fetch the trading fees for multiple markets
Kind: instance method of foxbit
Returns: object - a dictionary of fee structures indexed by market symbols
See: https://docs.foxbit.com.br/rest/v3/#tag/Member-Info/operation/MembersController_listTradingFees
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchTradingFees ([params])
fetchOrderBook{docsify-ignore}
Exports a copy of the order book of a specific market.
Kind: instance method of foxbit
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs.foxbit.com.br/rest/v3/#tag/Market-Data/operation/MarketsController_findOrderbook
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch the order book for |
| limit | int |
No | the maximum amount of order book entries to return, the maximum is 100 |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchOrderBook (symbol[, limit, params])
fetchTrades{docsify-ignore}
Retrieve the trades of a specific market.
Kind: instance method of foxbit
Returns: Array<Trade> - a list of trade structures
See: https://docs.foxbit.com.br/rest/v3/#tag/Market-Data/operation/MarketsController_publicTrades
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch trades for |
| since | int |
No | timestamp in ms of the earliest trade to fetch |
| limit | int |
No | the maximum amount of trades to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchTrades (symbol[, since, limit, params])
fetchOHLCV{docsify-ignore}
Fetch historical candlestick data containing the open, high, low, and close price, and the volume of a market.
Kind: instance method of foxbit
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.foxbit.com.br/rest/v3/#tag/Market-Data/operation/MarketsController_findCandlesticks
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to fetch OHLCV data for |
| timeframe | string |
Yes | the length of time each candle represents |
| since | int |
No | timestamp in ms of the earliest candle to fetch |
| limit | int |
No | the maximum amount of candles to fetch |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchOHLCV (symbol, timeframe[, since, limit, params])
fetchBalance{docsify-ignore}
Query for balance and get the amount of funds available for trading or funds locked in orders.
Kind: instance method of foxbit
Returns: object - a balance structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Account/operation/AccountsController_all
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchBalance ([params])
fetchOpenOrders{docsify-ignore}
Fetch all unfilled currently open orders.
Kind: instance method of foxbit
Returns: Array<Order> - a list of order structures
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/OrdersController_listOrders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| since | int |
No | the earliest time in ms to fetch open orders for |
| limit | int |
No | the maximum number of open order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchOpenOrders (symbol[, since, limit, params])
fetchClosedOrders{docsify-ignore}
Fetch all currently closed orders.
Kind: instance method of foxbit
Returns: Array<Order> - a list of order structures
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/OrdersController_listOrders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchClosedOrders (symbol[, since, limit, params])
createOrder{docsify-ignore}
Create an order with the specified characteristics
Kind: instance method of foxbit
Returns: object - an order structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/OrdersController_create
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified symbol of the market to create an order in |
| type | string |
Yes | 'market', 'limit', 'stop_market', 'stop_limit', 'instant' |
| side | string |
Yes | 'buy' or 'sell' |
| amount | float |
Yes | how much you want to trade in units of the base currency |
| price | float |
No | the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.timeInForce | string |
No | "GTC", "FOK", "IOC", "PO" |
| params.triggerPrice | float |
No | The time in force for the order. One of GTC, FOK, IOC, PO. See .features or foxbit's doc to see more details. |
| params.postOnly | bool |
No | true or false whether the order is post-only |
| params.clientOrderId | string |
No | a unique identifier for the order |
foxbit.createOrder (symbol, type, side, amount[, price, params])
createOrders{docsify-ignore}
create a list of trade orders
Kind: instance method of foxbit
Returns: object - an order structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/createBatch
| Param | Type | Required | Description |
|---|---|---|---|
| orders | Array |
Yes | list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.createOrders (orders[, params])
cancelOrder{docsify-ignore}
Cancel open orders.
Kind: instance method of foxbit
Returns: object - an order structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/OrdersController_cancel
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | unified symbol of the market the order was made in |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.cancelOrder (id, symbol[, params])
cancelAllOrders{docsify-ignore}
Cancel all open orders or all open orders for a specific market.
Kind: instance method of foxbit
Returns: Array<object> - a list of order structures
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/OrdersController_cancel
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market to cancel orders in |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.cancelAllOrders (symbol[, params])
fetchOrder{docsify-ignore}
Get an order by ID.
Kind: instance method of foxbit
Returns: object - An order structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/OrdersController_findByOrderId
| Param | Type | Required | Description |
|---|---|---|---|
| id | Yes | ||
| symbol | string |
Yes | it is not used in the foxbit API |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchOrder (id, symbol[, params])
fetchOrders{docsify-ignore}
fetches information on multiple orders made by the user
Kind: instance method of foxbit
Returns: Array<Order> - a list of order structures
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/OrdersController_listOrders
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol of the market orders were made in |
| since | int |
No | the earliest time in ms to fetch orders for |
| limit | int |
No | the maximum number of order structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.state | string |
No | Enum: ACTIVE, CANCELED, FILLED, PARTIALLY_CANCELED, PARTIALLY_FILLED |
| params.side | string |
No | Enum: BUY, SELL |
foxbit.fetchOrders (symbol[, since, limit, params])
fetchMyTrades{docsify-ignore}
Trade history queries will only have data available for the last 3 months, in descending order (most recents trades first).
Kind: instance method of foxbit
Returns: Array<Trade> - a list of trade structures
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/TradesController_all
| Param | Type | Required | Description |
|---|---|---|---|
| symbol | string |
Yes | unified market symbol |
| since | int |
No | the earliest time in ms to fetch trades for |
| limit | int |
No | the maximum number of trade structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchMyTrades (symbol[, since, limit, params])
fetchDepositAddress{docsify-ignore}
Fetch the deposit address for a currency associated with this account.
Kind: instance method of foxbit
Returns: object - an address structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Deposit/operation/DepositsController_depositAddress
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| params | object |
No | extra parameters specific to the exchange API endpoint |
| params.networkCode | string |
No | the blockchain network to create a deposit address on |
foxbit.fetchDepositAddress (code[, params])
fetchDeposits{docsify-ignore}
Fetch all deposits made to an account.
Kind: instance method of foxbit
Returns: Array<object> - a list of transaction structures
See: https://docs.foxbit.com.br/rest/v3/#tag/Deposit/operation/DepositsController_listOrders
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
No | unified currency code |
| since | int |
No | the earliest time in ms to fetch deposits for |
| limit | int |
No | the maximum number of deposit structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchDeposits ([code, since, limit, params])
fetchWithdrawals{docsify-ignore}
Fetch all withdrawals made from an account.
Kind: instance method of foxbit
Returns: Array<object> - a list of transaction structures
See: https://docs.foxbit.com.br/rest/v3/#tag/Withdrawal/operation/WithdrawalsController_listWithdrawals
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
No | unified currency code |
| since | int |
No | the earliest time in ms to fetch withdrawals for |
| limit | int |
No | the maximum number of withdrawal structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchWithdrawals ([code, since, limit, params])
fetchTransactions{docsify-ignore}
Fetch all transactions (deposits and withdrawals) made from an account.
Kind: instance method of foxbit
Returns: Array<object> - a list of transaction structures
See
- https://docs.foxbit.com.br/rest/v3/#tag/Withdrawal/operation/WithdrawalsController_listWithdrawals
- https://docs.foxbit.com.br/rest/v3/#tag/Deposit/operation/DepositsController_listOrders
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
No | unified currency code |
| since | int |
No | the earliest time in ms to fetch withdrawals for |
| limit | int |
No | the maximum number of withdrawal structures to retrieve |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchTransactions ([code, since, limit, params])
fetchStatus{docsify-ignore}
The latest known information on the availability of the exchange API.
Kind: instance method of foxbit
Returns: object - a status structure
See: https://status.foxbit.com/
| Param | Type | Required | Description |
|---|---|---|---|
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchStatus ([params])
editOrder{docsify-ignore}
Simultaneously cancel an existing order and create a new one.
Kind: instance method of foxbit
Returns: object - an order structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Trading/operation/OrdersController_cancelReplace
| Param | Type | Required | Description |
|---|---|---|---|
| id | string |
Yes | order id |
| symbol | string |
Yes | unified symbol of the market to create an order in |
| type | string |
Yes | 'market' or 'limit' |
| side | string |
Yes | 'buy' or 'sell' |
| amount | float |
Yes | how much of the currency you want to trade in units of the base currency |
| price | float |
No | the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders, used as stop_price on stop market orders |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.editOrder (id, symbol, type, side, amount[, price, params])
withdraw{docsify-ignore}
Make a withdrawal.
Kind: instance method of foxbit
Returns: object - a transaction structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Withdrawal/operation/WithdrawalsController_createWithdrawal
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code |
| amount | float |
Yes | the amount to withdraw |
| address | string |
Yes | the address to withdraw to |
| tag | string |
Yes | |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.withdraw (code, amount, address, tag[, params])
fetchLedger{docsify-ignore}
fetch the history of changes, actions done by the user or operations that altered balance of the user
Kind: instance method of foxbit
Returns: object - a ledger structure
See: https://docs.foxbit.com.br/rest/v3/#tag/Account/operation/AccountsController_getTransactions
| Param | Type | Required | Description |
|---|---|---|---|
| code | string |
Yes | unified currency code, default is undefined |
| since | int |
No | timestamp in ms of the earliest ledger entry, default is undefined |
| limit | int |
No | max number of ledger entrys to return, default is undefined |
| params | object |
No | extra parameters specific to the exchange API endpoint |
foxbit.fetchLedger (code[, since, limit, params])