With this method, the TAAPI.IO Client does the heavy lifting of fetching candle data from the exchanges, and passing it on to the API. This means that it’s the client talking directly to the exchanges, and therefore, you need to watch your usage and stay under the exchange’s rate-limits. For more information on an exchange’s rate-limits, you need to find their technical documentation on their home page.
Pros
Calculate TA for any crypto asset, for any market / symbol / time frame on 124 different crypto exchanges.
Candles are pulled instantly from the exchanges, making TA indicator calculations real time.
Execute bulk calls very easily.
Use this client as a wrapper, if you use NodeJS.
Cons
You need to watch the rate-limits for the exchange yourself.
One extra step if you’re not using NodeJS (More info below).
Why do it like this?
It’s a tall order to fetch all symbols on all time frames for all the exchanges, and guarantee that this is reliable, and always up-to-date. However, we are working on exactly this, as a second priority to our primary focus (TA). When a stable version of this is ready, we’ll be sure to let you know!
Getting Started
Our client is NodeJS based (check the NPM Package on npmjs.com), and that can be used either as a wrapper or as a server. Below are some guides based on programming language and operation systems:
NodeJS
If you’re working with NodeJS, then things are very simple, as you already have NodeJS installed on your platform. Simply install our NPM Package (taapi), and you’re good to go:
Make sure you have your project setup, otherwise, create a new one:
Create a new folder: mkdir myCryptoProject
Enter that folder: cd myCryptoProject
Init a new project: npm init
Install TAAPI.IO npm package: npm i taapi
Create your entry file: touch index.js
Boot up your favorite IDE, and paste the below into index.js
// Require taapi: npm i taapi --save
const taapi = require("taapi");
// Setup client with authentication
const client = taapi.client("MY_SECRET");
// Get the BTC/USDT RSI value on the 1 minute time frame from binance
client.getIndicator("rsi", "binance", "BTC/USDT", "1m").then(function(result) {
console.log("Result: ", result);
})
.catch(function(error){
console.log(error.message);
});
Be sure to check out the below required and optional parameters!
Other programming languages
To get started with anything but NodeJS, you need to install the taapi npm package and run it as a server. Don’t be scared if this is already getting too geeky. It really is fairly simple. Follow these steps (unix commands used):
Once installed, create a folder for the taapi local server: mkdir taapiServer and cd to this directory: cd taapiServer .
Init a new NodeJS project: npm init (and follow the init steps)
Install taapi: npm install taapi
Create an empty index.js file: touch index.js
Boot up your favorite editor and paste the below into the index.js file:
// Require taapi
const taapi = require("taapi");
// Setup server with authentication
const server = taapi.server("MY_SECRET");
// Define port - Optional and defaults to 4101
// server.setServerPort(3000);
// Start the server
server.start();
You’re now up and running and can use this server with your favorite programming language.
Hint: Use PM2 (Process Manager for NodeJS). It makes it easy to run the server as a background process.
npm install pm2 -g // Install pm2 globally
pm2 start index.js –name ‘taapi-server’ // Start the taapi server in the background
pm2 status // Check the status
pm2 log taapi-server // Check the log
pm2 –help
Usage
Now that you’re all setup, and have all the candle data you need, you can start using TAAPI.IO. Below are a couple of examples in different languages.
NodeJS
Check the above example, just below Getting Started for a NodeJS example.
PHP
// Define query
$query = http_build_query(array(
'indicator' => 'rsi',
'exchange' => 'binance',
'symbol' => 'BTC/USDT',
'interval' => '1h'
));
// Define endpoint. Change the port if you changed it when setting up the server
$url = "http://localhost:4101/indicator?{$query}";
// create curl resource
$ch = curl_init();
// set url
curl_setopt($ch, CURLOPT_URL, $url);
//return the transfer as a string
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
// $output contains the output string
$output = curl_exec($ch);
// close curl resource to free up system resources
curl_close($ch);
// View result
print_r(json_decode($output));
Python
# Import the requests library
import requests
# Define endpoint
endpoint = 'http://localhost:4101/indicator'
# Define a parameters dict for the parameters to be sent to the API
parameters = {
'indicator': 'rsi',
'exchange': 'binance',
'symbol': 'BTC/USDT',
'interval': '1h'
}
# Send get request and save the response as response object
response = requests.get(url = endpoint, params = parameters)
# Extract data in json format
result = response.json()
# Print result
print(result)
Mandatory Parameters
Using this “Client” method requires at least the below parameters:
The exchange you want to calculate TA from: binance, kucoin, …
symbol
String
Symbol names are always upper-case, with the coin separated by a forward slash and the market: COIN/MARKET. Example: BTC/USDT Bitcoin to Tether, or LTC/BTC Litecoin to Bitcoin.
interval
String
Interval or time frame: Binance have the following time frames or intervals: [1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M].
Depending on the indicator you call, there may or may not be more mandatory parameters. Additionally, there may be several other optional paramters, also depending on the indicator. Please refer to the Indicators page for more information.
Optional Parameters
Below is a list of optional parameters that all the indicators will take:
Parameter
Type
backtrack
Integer
This backtrack parameter, removes candles from the data set, and thus calculates the indicator value, x amount of candles back. So, if you’re fetching the RSI on the hourly, and you want to know what the RSI was 5 hours ago, set backtrack=5. Default here is 0, and a max of 50.
candlesCount
Integer
Default amount of candles being fetched is 100, use this parameter to override this number. Note, some exchanges do not allow more than 100 candles to be fetched. But most allow at least 200.
Note on exchanges and limits
The different exchanges have different limits as to how many candles one can fetch in one go. Therefore, a default of 100 is set here. We’re updating our documentation to reflect each exchange’s individual limits. But for now, it’s best to double check that the amount of candles that you expect are returned (use the /candles endpoint), and check that the last one has the expected timestamp. Candles are always returned with the oldest first and newest last.
You can override how many candles the client should attempt to fetch. See more info / examples at the NPM Package
Bulk Queries
Often multiple indicators are needed to build a working trading strategy. This TAAPI.IO Client makes it very easy to accomplish this. You can also do this with the GraphQL method, building your own GraphQL queries.
Bulk calls are in principal not limited to any plan, but it is only useful with the Pro & Expert plans, as these are the only plans that allows for more than 1 call / second. The same rate limits apply, as with calling single indicators.
These new features are available as of version v1.2.2 of the NPM Client. If you are an existing user of the Client, just do an update:
npm update taapi
Getting Started
Initalize the Client just like above calling a single indicator. But instead of using the “getIndicator” method, you can add bulk calls with: “addBulkQuery” and “executeBulkQueries“. Example:
// Require taapi: npm i taapi --save
const taapi = require("taapi");
// Setup client with authentication
const client = taapi.client("MY_SECRET");
// Init bulk queries. This resets all previously added queries
client.initBulkQueries();
// Get the BTC/USDT rsi, ao, adx, cmf, macd, atr, rsi 5 hours ago, 50 MA values on the 1 hour time frame from binance
client.addBulkQuery("rsi", "binance", "BTC/USDT", "1h");
client.addBulkQuery("ao", "binance", "BTC/USDT", "1h");
client.addBulkQuery("adx", "binance", "BTC/USDT", "1h");
client.addBulkQuery("cmf", "binance", "BTC/USDT", "1h");
client.addBulkQuery("macd", "binance", "BTC/USDT", "1h");
client.addBulkQuery("atr", "binance", "BTC/USDT", "1h", null, 0, "my_custom_id"); // Override id
client.addBulkQuery("rsi", "binance", "BTC/USDT", "1h", null, 5); // RSI 5 hours ago
client.addBulkQuery("ma", "binance", "BTC/USDT", "1h", {optInTimePeriod: 50}); // 50 MA
client.executeBulkQueries().then(result => {
console.log(result);
}).catch(error => {
console.log(error);
});
The above example will output an array of objects with results, like:
id: The ID of the call. If no ID is provided, an auto-generated id will be returned.
indicator: The indicator called.
result: The result of the calculation. This output will depend on the indicator.
The addBulkQuery method will take the following parameters in this order:
Parameter
Type
Description
indicator
String
The indicator to be calculated. See the Indicators page for a list of more than 200 available indicators.
exchange
String
The exchange to fetch data from. See the below Supported Exchanges.
symbol
String
The symbol to fetch candles from.
interval
String
The interval or time frame to fetch candles from.
params
Object
An object describing extra mandatory / optional indicator parameters. These differ from indicator to indicator.
backtrack
Integer
This will remove candles from the set, thus backtracking a calculation back in time.
id
String
Override the auto-generated id.
candlesCount
Interger
Override the amount of candles that should be attempted to fetch from the exchange. Several exchanges only support fetching 100 candles, which is also this settings default.
Examples
The next example with fetch the RSI from 3 different exchanges:
// Require taapi: npm i taapi --save
const taapi = require("taapi");
// Setup client with authentication
const client = taapi.client("MY_SECRET");
// Init bulk queries. This resets all previously added queries
client.initBulkQueries();
// Get the BTC/USDT rsi from Binance, Kucoin and Kraken
client.addBulkQuery("rsi", "binance", "BTC/USDT", "1h");
client.addBulkQuery("rsi", "kucoin", "BTC/USDT", "1h");
client.addBulkQuery("rsi", "kraken", "BTC/USDT", "1h");
client.executeBulkQueries().then(result => {
console.log(result);
}).catch(error => {
console.log(error);
});
The good folks over at CCXT has done a fantastic job implementing all of these exchanges, for people to query and fetch data in a unified format. Please be sure to shoot them a donation!
