bigone

bigone{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchCurrencies
• fetchMarkets
• fetchTicker
• fetchTickers
• fetchTime
• fetchOrderBook
• fetchTrades
• fetchOHLCV
• fetchBalance
• createMarketBuyOrderWithCost
• createOrder
• cancelOrder
• cancelAllOrders
• fetchOrder
• fetchOrders
• fetchMyTrades
• fetchOpenOrders
• fetchClosedOrders
• fetchDepositAddress
• fetchDeposits
• fetchWithdrawals
• transfer
• withdraw

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of bigone
Returns: dict - an associative dictionary of currencies

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

bigone.fetchCurrencies (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for bigone

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

See: https://open.big.one/docs/spot_asset_pair.html

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

bigone.fetchMarkets (params?)

fetchTicker{docsify-ignore}

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

Kind: instance method of bigone
Returns: object - a ticker structure

See: https://open.big.one/docs/spot_tickers.html

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

bigone.fetchTicker (symbol, params?)

fetchTickers{docsify-ignore}

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

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

See: https://open.big.one/docs/spot_tickers.html

Param	Type	Required	Description
symbols	Array<string>	No	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

bigone.fetchTickers (symbols?, params?)

fetchTime{docsify-ignore}

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

See: https://open.big.one/docs/spot_ping.html

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

bigone.fetchTime (params?)

fetchOrderBook{docsify-ignore}

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

See: https://open.big.one/docs/contract_misc.html#get-orderbook-snapshot

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to fetch the order book for
limit	int	No	the maximum amount of order book entries to return
params	object	No	extra parameters specific to the exchange API endpoint

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

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://open.big.one/docs/spot_asset_pair_trade.html

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

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

fetchOHLCV{docsify-ignore}

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

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

See: https://open.big.one/docs/spot_asset_pair_candle.html

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
params.until	int	No	timestamp in ms of the earliest candle to fetch

bigone.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 bigone
Returns: object - a balance structure

See

• https://open.big.one/docs/fund_accounts.html
• https://open.big.one/docs/spot_accounts.html

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

bigone.fetchBalance (params?)

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol and cost

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

See: https://open.big.one/docs/spot_orders.html#create-order

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to create an order in
cost	float	Yes	how much you want to trade in units of the quote currency
params	object	No	extra parameters specific to the exchange API endpoint

bigone.createMarketBuyOrderWithCost (symbol, cost, params?)

createOrder{docsify-ignore}

create a trade order

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

See: https://open.big.one/docs/spot_orders.html#create-order

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to create an order in
type	string	Yes	'market' or 'limit'
side	string	Yes	'buy' or 'sell'
amount	float	Yes	how much of currency you want to trade in units of base currency
price	float	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	object	No	extra parameters specific to the exchange API endpoint
params.triggerPrice	float	No	the price at which a trigger order is triggered at
params.postOnly	bool	No	if true, the order will only be posted to the order book and not executed immediately
params.timeInForce	string	No	"GTC", "IOC", or "PO"
params.cost	float	No	spot market buy only the quote quantity that can be used as an alternative for the amount EXCHANGE SPECIFIC PARAMETERS
params.operator	string	No	stop order only GTE or LTE (default)
params.client_order_id	string	No	must match ^[a-zA-Z0-9-_]{1,36}$ this regex. client_order_id is unique in 24 hours, If created 24 hours later and the order closed, it will be released and can be reused

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

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://open.big.one/docs/spot_orders.html#cancel-order

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

bigone.cancelOrder (id, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel all open orders

Kind: instance method of bigone
Returns: Array<object> - a list of order structures

See: https://open.big.one/docs/spot_orders.html#cancel-all-orders

Param	Type	Required	Description
symbol	string	Yes	unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params	object	No	extra parameters specific to the exchange API endpoint

bigone.cancelAllOrders (symbol, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See: https://open.big.one/docs/spot_orders.html#get-one-order

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

bigone.fetchOrder (id, symbol, params?)

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://open.big.one/docs/spot_orders.html#get-user-orders-in-one-asset-pair

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

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

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://open.big.one/docs/spot_trade.html#trades-of-user

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
since	int	No	the earliest time in ms to fetch trades for
limit	int	No	the maximum number of trades structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://open.big.one/docs/spot_orders.html#get-user-orders-in-one-asset-pair

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
since	int	No	the earliest time in ms to fetch open orders for
limit	int	No	the maximum number of open orders structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

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

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See: https://open.big.one/docs/spot_orders.html#get-user-orders-in-one-asset-pair

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

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

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of bigone
Returns: object - an address structure

See: https://open.big.one/docs/spot_deposit.html#get-deposite-address-of-one-asset-of-user

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

bigone.fetchDepositAddress (code, params?)

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://open.big.one/docs/spot_deposit.html#deposit-of-user

Param	Type	Required	Description
code	string	Yes	unified currency code
since	int	No	the earliest time in ms to fetch deposits for
limit	int	No	the maximum number of deposits structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

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

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

See: https://open.big.one/docs/spot_withdrawal.html#get-withdrawals-of-user

Param	Type	Required	Description
code	string	Yes	unified currency code
since	int	No	the earliest time in ms to fetch withdrawals for
limit	int	No	the maximum number of withdrawals structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

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

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of bigone
Returns: object - a transfer structure

See: https://open.big.one/docs/spot_transfer.html#transfer-of-user

Param	Type	Required	Description
code	string	Yes	unified currency code
amount	float	Yes	amount to transfer
fromAccount	string	Yes	'SPOT', 'FUND', or 'CONTRACT'
toAccount	string	Yes	'SPOT', 'FUND', or 'CONTRACT'
params	object	No	extra parameters specific to the exchange API endpoint

bigone.transfer (code, amount, fromAccount, toAccount, params?)

withdraw{docsify-ignore}

make a withdrawal

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

See: https://open.big.one/docs/spot_withdrawal.html#create-withdrawal-of-user

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

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