btcturk
btcturk cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
btcturk
Kind: global class
Extends: Exchange
- fetchMarkets
- fetchBalance
- fetchOrderBook
- fetchTickers
- fetchTicker
- fetchTrades
- fetchOHLCV
- createOrder
- cancelOrder
- fetchOpenOrders
- fetchOrders
- fetchMyTrades
fetchMarkets
retrieves data on all markets for btcturk
Kind: instance method of btcturk
Returns: Array<object> - an array of objects representing market data
See: https://docs.btcturk.com/public-endpoints/exchange-info
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
btcturk.fetchMarkets (params?)fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of btcturk
Returns: object - a balance structure
See: https://docs.btcturk.com/private-endpoints/account-balance
| Param | Type | Required | Description |
|---|---|---|---|
| params | object | No | extra parameters specific to the exchange API endpoint |
btcturk.fetchBalance (params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of btcturk
Returns: object - A dictionary of order book structures indexed by market symbols
See: https://docs.btcturk.com/public-endpoints/orderbook
| 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 |
btcturk.fetchOrderBook (symbol, limit?, params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of btcturk
Returns: object - a dictionary of ticker structures
See: https://docs.btcturk.com/public-endpoints/ticker
| 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 |
btcturk.fetchTickers (symbols, params?)fetchTicker
fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
Kind: instance method of btcturk
Returns: object - a ticker structure
See: https://docs.btcturk.com/public-endpoints/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 |
btcturk.fetchTicker (symbol, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of btcturk
Returns: Array<Trade> - a list of trade structures
See: https://docs.btcturk.com/public-endpoints/trades
| 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 |
btcturk.fetchTrades (symbol, since?, limit?, params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of btcturk
Returns: Array<Array<int>> - 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 | 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 latest candle to fetch |
btcturk.fetchOHLCV (symbol, timeframe, since?, limit?, params?)createOrder
create a trade order
Kind: instance method of btcturk
Returns: object - an order structure
See: https://docs.btcturk.com/private-endpoints/submit-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 |
btcturk.createOrder (symbol, type, side, amount, price?, params?)cancelOrder
cancels an open order
Kind: instance method of btcturk
Returns: object - An order structure
See: https://docs.btcturk.com/private-endpoints/cancel-order
| Param | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | order id |
| symbol | string | Yes | not used by btcturk cancelOrder () |
| params | object | No | extra parameters specific to the exchange API endpoint |
btcturk.cancelOrder (id, symbol, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of btcturk
Returns: Array<Order> - a list of order structures
See: https://docs.btcturk.com/private-endpoints/open-orders
| 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 |
btcturk.fetchOpenOrders (symbol, since?, limit?, params?)fetchOrders
fetches information on multiple orders made by the user
Kind: instance method of btcturk
Returns: Array<Order> - a list of order structures
See: https://docs.btcturk.com/private-endpoints/all-orders
| 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 |
btcturk.fetchOrders (symbol, since?, limit?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of btcturk
Returns: Array<Trade> - a list of trade structures
See: https://docs.btcturk.com/private-endpoints/user-transactions
| 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 |
btcturk.fetchMyTrades (symbol, since?, limit?, params?)