okcoin

okcoin{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchTime
• fetchMarkets
• fetchCurrencies
• fetchOrderBook
• fetchTicker
• fetchTickers
• fetchTrades
• fetchOHLCV
• fetchBalance
• createMarketBuyOrderWithCost
• createOrder
• cancelOrder
• cancelOrders
• fetchOrder
• fetchOpenOrders
• fetchClosedOrders
• fetchDepositAddress
• fetchDepositAddressesByNetwork
• transfer
• withdraw
• fetchDeposits
• fetchWithdrawals
• fetchMyTrades
• fetchOrderTrades
• fetchLedger
• watchTrades
• watchOrders
• watchTicker
• watchOHLCV
• watchOrderBook
• watchBalance

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

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

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

okcoin.fetchTime (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for okcoin

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

See: https://www.okcoin.com/docs-v5/en/#rest-api-public-data-get-instruments

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

okcoin.fetchMarkets (params?)

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of okcoin
Returns: object - an associative dictionary of currencies

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

okcoin.fetchCurrencies (params?)

fetchOrderBook{docsify-ignore}

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

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

See: https://www.okcoin.com/docs-v5/en/#rest-api-market-data-get-order-book

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

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

fetchTicker{docsify-ignore}

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

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

See: https://www.okcoin.com/docs-v5/en/#rest-api-market-data-get-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

okcoin.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 okcoin
Returns: object - a dictionary of ticker structures

See: https://www.okcoin.com/docs-v5/en/#rest-api-market-data-get-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

okcoin.fetchTickers (symbols, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See

• https://www.okcoin.com/docs-v5/en/#rest-api-market-data-get-trades
• https://www.okcoin.com/docs-v5/en/#rest-api-market-data-get-trades-history

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

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

See

• https://www.okcoin.com/docs-v5/en/#rest-api-market-data-get-candlesticks
• https://www.okcoin.com/docs-v5/en/#rest-api-market-data-get-candlesticks-history

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

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

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

okcoin.fetchBalance (params?)

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol and cost

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

See: https://www.okcoin.com/docs-v5/en/#rest-api-trade-place-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

okcoin.createMarketBuyOrderWithCost (symbol, cost, params?)

createOrder{docsify-ignore}

create a trade order

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

See

• https://www.okcoin.com/docs-v5/en/#rest-api-trade-place-order
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-place-algo-order
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-place-multiple-orders
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-cancel-advance-algo-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	Yes	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.reduceOnly	bool	No	MARGIN orders only, or swap/future orders in net mode
params.postOnly	bool	No	true to place a post only order
params.triggerPrice	float	No	conditional orders only, the price at which the order is to be triggered
params.takeProfit	object	No	takeProfit object in params containing the triggerPrice at which the attached take profit order will be triggered (perpetual swap markets only)
params.takeProfit.triggerPrice	float	No	take profit trigger price
params.takeProfit.price	float	No	used for take profit limit orders, not used for take profit market price orders
params.takeProfit.type	string	No	'market' or 'limit' used to specify the take profit price type
params.stopLoss	object	No	stopLoss object in params containing the triggerPrice at which the attached stop loss order will be triggered (perpetual swap markets only)
params.stopLoss.triggerPrice	float	No	stop loss trigger price
params.stopLoss.price	float	No	used for stop loss limit orders, not used for stop loss market price orders
params.stopLoss.type	string	No	'market' or 'limit' used to specify the stop loss price type
params.cost	float	No	spot market buy only the quote quantity that can be used as an alternative for the amount

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

cancelOrder{docsify-ignore}

cancels an open order

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

See

• https://www.okcoin.com/docs-v5/en/#rest-api-trade-cancel-order
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-cancel-algo-order
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-cancel-advance-algo-order

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
params.trigger	bool	No	True if cancel trigger or conditional orders
params.advanced	bool	No	True if canceling advanced orders only

okcoin.cancelOrder (id, symbol, params?)

cancelOrders{docsify-ignore}

cancel multiple orders

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

See

• https://www.okcoin.com/docs-v5/en/#rest-api-trade-cancel-multiple-orders
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-cancel-algo-order
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-cancel-advance-algo-order

Param	Type	Required	Description
ids	Array<string>	Yes	order ids
symbol	string	Yes	unified market symbol
params	object	No	extra parameters specific to the exchange API endpoint

okcoin.cancelOrders (ids, symbol, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See

• https://www.okcoin.com/docs-v5/en/#rest-api-trade-get-order-details
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-get-algo-order-list

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

okcoin.fetchOrder (id, symbol, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See

• https://www.okcoin.com/docs-v5/en/#rest-api-trade-get-order-list
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-get-algo-order-list

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
params.trigger	bool	No	True if fetching trigger or conditional orders
params.ordType	string	No	"conditional", "oco", "trigger", "move_order_stop", "iceberg", or "twap"

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

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See

• https://www.okcoin.com/docs-v5/en/#rest-api-trade-get-algo-order-history
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-get-order-history-last-3-months
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-get-order-history-last-7-days

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.trigger	bool	No	True if fetching trigger or conditional orders
params.ordType	string	No	"conditional", "oco", "trigger", "move_order_stop", "iceberg", or "twap"

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

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

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

See: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address

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

okcoin.fetchDepositAddress (code, params?)

fetchDepositAddressesByNetwork{docsify-ignore}

fetch a dictionary of addresses for a currency, indexed by network

Kind: instance method of okcoin
Returns: object - a dictionary of address structures indexed by the network

See: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address

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

okcoin.fetchDepositAddressesByNetwork (code, params?)

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

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

See: https://www.okcoin.com/docs-v5/en/#rest-api-funding-funds-transfer

Param	Type	Required	Description
code	string	Yes	unified currency code
amount	float	Yes	amount to transfer
fromAccount	string	Yes	account to transfer from
toAccount	string	Yes	account to transfer to
params	object	No	extra parameters specific to the exchange API endpoint

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

withdraw{docsify-ignore}

make a withdrawal

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

See: https://www.okcoin.com/docs-v5/en/#rest-api-funding-withdrawal

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

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

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://www.okcoin.com/docs-v5/en/#rest-api-funding-get-deposit-history

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

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

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

See: https://www.okcoin.com/docs-v5/en/#rest-api-funding-get-withdrawal-history

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

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

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See

• https://www.okcoin.com/docs-v5/en/#rest-api-trade-get-transaction-details-last-3-days
• https://www.okcoin.com/docs-v5/en/#rest-api-trade-get-transaction-details-last-3-months

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

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

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

Kind: instance method of okcoin
Returns: Array<object> - a list of trade structures

Param	Type	Required	Description
id	string	Yes	order id
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 to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

okcoin.fetchOrderTrades (id, symbol, since?, limit?, params?)

fetchLedger{docsify-ignore}

fetch the history of changes, actions done by the user or operations that altered the balance of the user

Kind: instance method of okcoin
Returns: object - a ledger structure

See

• https://www.okcoin.com/docs-v5/en/#rest-api-funding-asset-bills-details
• https://www.okcoin.com/docs-v5/en/#rest-api-account-get-bills-details-last-7-days
• https://www.okcoin.com/docs-v5/en/#rest-api-account-get-bills-details-last-3-months

Param	Type	Required	Description
code	string	No	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 entries to return, default is undefined
params	object	No	extra parameters specific to the exchange API endpoint

okcoin.fetchLedger (code?, since?, limit?, params?)

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of okcoin
Returns: Array<object> - a list of trade structures

See: https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-trades-channel

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

okcoin.watchTrades (symbol, since?, limit?, params?)

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

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

See: https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-order-channel

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

okcoin.watchOrders (symbol, since?, limit?, params?)

watchTicker{docsify-ignore}

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

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

See: https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-tickers-channel

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

okcoin.watchTicker (symbol, params?)

watchOHLCV{docsify-ignore}

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

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

See: https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-candlesticks-channel

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

okcoin.watchOHLCV (symbol, timeframe, since?, limit?, params?)

watchOrderBook{docsify-ignore}

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

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

See: https://www.okcoin.com/docs-v5/en/#websocket-api-public-channel-order-book-channel

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

okcoin.watchOrderBook (symbol, limit?, params?)

watchBalance{docsify-ignore}

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

Kind: instance method of okcoin
Returns: object - a balance structure

See: https://www.okcoin.com/docs-v5/en/#websocket-api-private-channel-account-channel

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

okcoin.watchBalance (params?)