Btcturk - Ccxt — ContextQMD

btcturk{docsify-ignore}

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

fetchMarkets
fetchBalance
fetchOrderBook
fetchTickers
fetchTicker
fetchTrades
fetchOHLCV
createOrder
cancelOrder
fetchOpenOrders
fetchOrders
fetchMyTrades

fetchMarkets{docsify-ignore}

retrieves data on all markets for btcturk

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

See: https://docs.btcturk.com/public-endpoints/exchange-info

Param	Type	Required	Description
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

btcturk.fetchMarkets ([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 <code>btcturk</code>
Returns: <code>object</code> - a balance structure

See: https://docs.btcturk.com/private-endpoints/account-balance

Param	Type	Required	Description
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

btcturk.fetchBalance ([params])

fetchOrderBook{docsify-ignore}

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

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

See: https://docs.btcturk.com/public-endpoints/orderbook

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

javascript

btcturk.fetchOrderBook (symbol[, limit, 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 <code>btcturk</code>
Returns: <code>object</code> - a dictionary of ticker structures

See: https://docs.btcturk.com/public-endpoints/ticker

Param	Type	Required	Description
symbols	<code>Array<string></code>, <code>undefined</code>	Yes	unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

btcturk.fetchTickers (symbols[, 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 <code>btcturk</code>
Returns: <code>object</code> - a ticker structure

See: https://docs.btcturk.com/public-endpoints/ticker

Param	Type	Required	Description
symbol	<code>string</code>	Yes	unified symbol of the market to fetch the ticker for
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

btcturk.fetchTicker (symbol[, params])

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See: https://docs.btcturk.com/public-endpoints/trades

Param	Type	Required	Description
symbol	<code>string</code>	Yes	unified symbol of the market to fetch trades for
since	<code>int</code>	No	timestamp in ms of the earliest trade to fetch
limit	<code>int</code>	No	the maximum amount of trades to fetch
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

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

See: https://docs.btcturk.com/public-endpoints/get-kline-data

Param	Type	Required	Description
symbol	<code>string</code>	Yes	unified symbol of the market to fetch OHLCV data for
timeframe	<code>string</code>	Yes	the length of time each candle represents
since	<code>int</code>	No	timestamp in ms of the earliest candle to fetch
limit	<code>int</code>	No	the maximum amount of candles to fetch
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint
params.until	<code>int</code>	No	timestamp in ms of the latest candle to fetch

javascript

btcturk.fetchOHLCV (symbol, timeframe[, since, limit, params])

createOrder{docsify-ignore}

create a trade order

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

See: https://docs.btcturk.com/private-endpoints/submit-order

Param	Type	Required	Description
symbol	<code>string</code>	Yes	unified 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>	Yes	how much of currency you want to trade in units of base currency
price	<code>float</code>	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

btcturk.createOrder (symbol, type, side, amount[, price, params])

cancelOrder{docsify-ignore}

cancels an open order

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

See: https://docs.btcturk.com/private-endpoints/cancel-order

Param	Type	Required	Description
id	<code>string</code>	Yes	order id
symbol	<code>string</code>	Yes	not used by btcturk cancelOrder ()
params	<code>object</code>	No	extra parameters specific to the exchange API endpoint

javascript

btcturk.cancelOrder (id, symbol[, params])

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See: https://docs.btcturk.com/private-endpoints/open-orders

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

javascript

btcturk.fetchOpenOrders (symbol[, since, limit, params])

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

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

See: https://docs.btcturk.com/private-endpoints/all-orders

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

javascript

btcturk.fetchOrders (symbol[, since, limit, params])

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See: https://docs.btcturk.com/private-endpoints/user-transactions

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

javascript

btcturk.fetchMyTrades (symbol[, since, limit, params])