Price direction

The Price Direction indicator tell’s which way the price is moving (up or down), within the period. It simply looks if the close is higher or lower than the open (green or red candles). It then averages the amount of green and red candles and returns a number (float) between -1 and 1, where -1 indicates that all candles are red, and a 1 if all candles are green.

Get started with the pd

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

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

The pd endpoint returns a JSON response like this:

			{
  "value": 0.6
}
		
Example response from TAAPI.IO when querying pd 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 or bitstamp. More exchanges supported natively are coming soon. 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 pd value X amount of candles back. So, if you’re fetching the pd on the hourly and you want to know what the pd was 5 hours ago, set backtrack=5. The default is 0 and a maximum is 50.
backtracks
Optional Integer
The backtracks parameter returns the pd value calculated on every candle for the past X candles. For example, if you want to know what the pd was every hour for the past 12 hours, you use backtracks=12. As a result, you will get 12 values back.
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.
period
Optional Integer

How many candles to take into consideration

Default: 5

More examples

Let's say you want to know the pd 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/pd?secret=MY_SECRET&exchange=binance&symbol=BTC/USDT&interval=30m&backtrack=1
			
Get pd values on each of the past X candles in one call

Let's say you want to know what the pd 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 backtracks=10 parameter:

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

Here's the example response:

				[
  {
    "value": 0.2,
    "backtrack": 0
  },
  {
    "value": -0.2,
    "backtrack": 1
  },
  {
    "value": -0.2,
    "backtrack": 2
  },
  {
    "value": 0.2,
    "backtrack": 3
  },
  {
    "value": -0.2,
    "backtrack": 4
  },
  {
    "value": -0.2,
    "backtrack": 5
  },
  {
    "value": 0.2,
    "backtrack": 6
  },
  {
    "value": 0.6,
    "backtrack": 7
  },
  {
    "value": 0.2,
    "backtrack": 8
  },
  {
    "value": 0.6,
    "backtrack": 9
  }
]
			

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