Pearson’s Correlation Coefficient

Get started with the correl

Simply make an HTTPS [GET] request or call in your browser:

			[GET] https://api.taapi.io/correl?secret=MY_SECRET&exchange=binance&symbol=BTC/USDT&interval=1h
		

API response

The correl endpoint returns a JSON response like this:

			{
  "value": 0.9892090524735393
}
		
Example response from TAAPI.IO when querying correl endpoint.

API parameters

secret
Required String
The secret which is emailed to you when you request an API key.
exchange
Required String
The exchange you want to calculate the indicator from: binance, binancefutures or one of our supported exchanges. For other crypto / stock exchanges, please refer to our Client or Manual integration methods.
symbol
Required String
Symbol names are always uppercase, with the coin separated by a forward slash and the market: COIN/MARKET. For example: BTC/USDT Bitcoin to Tether, or LTC/BTC Litecoin to Bitcoin...
interval
Required String
Interval or time frame: We support the following time frames: 1m, 5m, 15m, 30m, 1h, 2h, 4h, 12h, 1d, 1w. So if you're interested in values on hourly candles, use interval=1h, for daily values use interval=1d, etc.
backtrack
Optional Integer
The backtrack parameter removes candles from the data set and calculates the correl value X amount of candles back. So, if you are fetching the correl on the hourly and you want to know what the correl was 5 hours ago, set backtrack=5. The default is 0.
chart
Optional String
The chart parameter accepts one of two values: candles or heikinashi. candles is the default, but if you set this to heikinashi, the indicator values will be calculated using Heikin Ashi candles. Note: Pro & Expert Plans only.
addResultTimestamp
Optional Boolean
true or false. Defaults to false. By setting to true the API will return a timestamp with every result (real-time and backtracked) to which candle the value corresponds. This is especially helpful when requesting a series of historical values using the results parameter.
gaps
New Optional Boolean
true or false. Defaults to true. By setting to false, the API will ensure that there are no candles missing. This often happens on lower timeframes in thin markets. Gaps will be filled by a new candle with 0 volume, and OHLC set the the close price of the latest candle with volume.
results
New Optional String
number or max. Use this parameter to access historical values on the past X candles until the most recent candle. Use max to return all available historical values. Returns an array with the oldest value on top and most recent value returned the last.
optInTimePeriod
Optional Integer

Default: 30

More examples

Let's say you want to know the correl value on the last closed candle on the 30m timeframe. You are not interest in the real-time value, so you use the backtrack=1 optional parameter to go back 1 candle in history to the last closed candle.

				[GET] https://api.taapi.io/correl?secret=MY_SECRET&exchange=binance&symbol=BTC/USDT&interval=30m&backtrack=1
			
Get correl values on each of the past X candles in one call

Let's say you want to know what the correl daily value was each day for the previous 10 days. You can get this returned by our API easily and efficiently in one call using the results=10 parameter:

				[GET] https://api.taapi.io/correl?secret=MY_SECRET&exchange=binance&symbol=BTC/USDT&interval=1d&results=10
			

Here's the example response:

				[
  {
    "value": 0.9892090524735393,
    "backtrack": 0
  },
  {
    "value": 0.990113623494274,
    "backtrack": 1
  },
  {
    "value": 0.9899717849779044,
    "backtrack": 2
  },
  {
    "value": 0.9849160568735004,
    "backtrack": 3
  },
  {
    "value": 0.9855303305703713,
    "backtrack": 4
  },
  {
    "value": 0.9862014246211634,
    "backtrack": 5
  },
  {
    "value": 0.9864441610258721,
    "backtrack": 6
  },
  {
    "value": 0.9845139361441337,
    "backtrack": 7
  },
  {
    "value": 0.9842575722337813,
    "backtrack": 8
  },
  {
    "value": 0.984389282582452,
    "backtrack": 9
  }
]
			

Looking for even more integration examples in different languages like NodeJS, PHP, Python, Curl or Ruby? Continue to [GET] REST - Direct documentation.