ContextQMD
Back to Ccxt

Bigone

wiki/exchanges/bigone.md

4.5.5219.7 KB
Original Source

<a name="bigone" id="bigone"></a>

bigone{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

<a name="fetchCurrencies" id="fetchcurrencies"></a>

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of <code>bigone</code>
Returns: <code>dict</code> - an associative dictionary of currencies

ParamTypeRequiredDescription
params<code>dict</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchCurrencies ([params])

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for bigone

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

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

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchMarkets ([params])

<a name="fetchTicker" id="fetchticker"></a>

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 <code>bigone</code>
Returns: <code>object</code> - a ticker structure

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchTicker (symbol[, params])

<a name="fetchTickers" id="fetchtickers"></a>

fetchTickers{docsify-ignore}

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

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - a dictionary of ticker structures

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

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nounified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchTickers ([symbols, params])

<a name="fetchTime" id="fetchtime"></a>

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of <code>bigone</code>
Returns: <code>int</code> - the current integer timestamp in milliseconds from the exchange server

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

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchTime ([params])

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

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

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchOrderBook (symbol[, limit, params])

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchTrades (symbol[, since, limit, params])

<a name="fetchOHLCV" id="fetchohlcv"></a>

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the earliest candle to fetch
javascript
bigone.fetchOHLCV (symbol, timeframe[, since, limit, params])

<a name="fetchBalance" id="fetchbalance"></a>

fetchBalance{docsify-ignore}

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

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - a balance structure

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchBalance ([params])

<a name="createMarketBuyOrderWithCost" id="createmarketbuyorderwithcost"></a>

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol and cost

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - an order structure

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
cost<code>float</code>Yeshow much you want to trade in units of the quote currency
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.createMarketBuyOrderWithCost (symbol, cost[, params])

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - an order structure

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of currency you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.triggerPrice<code>float</code>Nothe price at which a trigger order is triggered at
params.postOnly<code>bool</code>Noif true, the order will only be posted to the order book and not executed immediately
params.timeInForce<code>string</code>No"GTC", "IOC", or "PO"
params.cost<code>float</code>Nospot market buy only the quote quantity that can be used as an alternative for the amount EXCHANGE SPECIFIC PARAMETERS
params.operator<code>string</code>Nostop order only GTE or LTE (default)
params.client_order_id<code>string</code>Nomust 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
javascript
bigone.createOrder (symbol, type, side, amount[, price, params])

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - An order structure

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

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>YesNot used by bigone cancelOrder ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.cancelOrder (id, symbol[, params])

<a name="cancelAllOrders" id="cancelallorders"></a>

cancelAllOrders{docsify-ignore}

cancel all open orders

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.cancelAllOrders (symbol[, params])

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - An order structure

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

ParamTypeRequiredDescription
id<code>string</code>Yesthe order id
symbol<code>string</code>Yesnot used by bigone fetchOrder
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchOrder (id, symbol[, params])

<a name="fetchOrders" id="fetchorders"></a>

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchOrders (symbol[, since, limit, params])

<a name="fetchMyTrades" id="fetchmytrades"></a>

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchMyTrades (symbol[, since, limit, params])

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch open orders for
limit<code>int</code>Nothe maximum number of open orders structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchOpenOrders (symbol[, since, limit, params])

<a name="fetchClosedOrders" id="fetchclosedorders"></a>

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

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

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchClosedOrders (symbol[, since, limit, params])

<a name="fetchDepositAddress" id="fetchdepositaddress"></a>

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - an address structure

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

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchDepositAddress (code[, params])

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

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

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchDeposits (code[, since, limit, params])

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

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

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.fetchWithdrawals (code[, since, limit, params])

<a name="transfer" id="transfer"></a>

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - a transfer structure

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

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesamount to transfer
fromAccount<code>string</code>Yes'SPOT', 'FUND', or 'CONTRACT'
toAccount<code>string</code>Yes'SPOT', 'FUND', or 'CONTRACT'
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.transfer (code, amount, fromAccount, toAccount[, params])

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of <code>bigone</code>
Returns: <code>object</code> - a transaction structure

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

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesthe address to withdraw to
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bigone.withdraw (code, amount, address, tag[, params])