Ichimoku Cloud

The Ichimoku Cloud is a collection of technical indicators that show support and resistance levels, as well as momentum and trend direction. It does this by taking multiple averages and plotting them on the chart. It also uses these figures to compute a “cloud” which attempts to forecast where the price may find support or resistance in the future. This implementation returns the standard cloud values [conversion line, base line, spanA, spanB], but returns along with it the spanA-B values for the current price, as well as for the lagging period.

Get started with the ichimoku

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

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

The ichimoku endpoint returns a JSON response like this:

			{
  "conversion": 22767.545,
  "base": 21722.95,
  "spanA": 22265.4975,
  "spanB": 21458.95,
  "currentSpanA": 19534.550000000003,
  "currentSpanB": 19444.485,
  "laggingSpanA": 19304.7425,
  "laggingSpanB": 19270.5
}
		
Example response from TAAPI.IO when querying ichimoku 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 ichimoku value X amount of candles back. So, if you’re fetching the ichimoku on the hourly and you want to know what the ichimoku was 5 hours ago, set backtrack=5. The default is 0 and a maximum is 50.
backtracks
Optional Integer
The backtracks parameter returns the ichimoku value calculated on every candle for the past X candles. For example, if you want to know what the ichimoku 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.
conversionPeriod
Optional Integer

Default: 9

basePeriod
Optional Integer

Default: 26

spanPeriod
Optional Integer

Default: 52

displacement
Optional Integer

Default: 26

More examples

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

Let's say you want to know what the ichimoku 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/ichimoku?secret=MY_SECRET&exchange=binance&symbol=BTC/USDT&interval=1d&backtracks=10
			

Here's the example response:

				[
  {
    "conversion": 38601.35,
    "base": 36916.35,
    "spanA": 38025.7725,
    "spanB": 36240,
    "currentSpanA": 34029.705,
    "currentSpanB": 33524,
    "laggingSpanA": 34549.1725,
    "laggingSpanB": 35740,
    "backtrack": 0
  },
  {
    "conversion": 38149.869999999995,
    "base": 36508.5,
    "spanA": 37758.85,
    "spanB": 36071.35,
    "currentSpanA": 34067.7525,
    "currentSpanB": 33524,
    "laggingSpanA": 34464.56,
    "laggingSpanB": 35740,
    "backtrack": 1
  },
  {
    "conversion": 37743.665,
    "base": 36401.55,
    "spanA": 37329.185,
    "spanB": 35690,
    "currentSpanA": 34145.1775,
    "currentSpanB": 33524,
    "laggingSpanA": 34338.2575,
    "laggingSpanB": 35743.31,
    "backtrack": 2
  },
  {
    "conversion": 37743.665,
    "base": 36401.55,
    "spanA": 37072.6075,
    "spanB": 35583.05,
    "currentSpanA": 34069.4825,
    "currentSpanB": 33524,
    "laggingSpanA": 34338.2575,
    "laggingSpanB": 35746.630000000005,
    "backtrack": 3
  },
  {
    "conversion": 37743.665,
    "base": 36401.55,
    "spanA": 37072.6075,
    "spanB": 35583.05,
    "currentSpanA": 34136.94,
    "currentSpanB": 33524,
    "laggingSpanA": 34338.2575,
    "laggingSpanB": 35746.630000000005,
    "backtrack": 4
  },
  {
    "conversion": 37743.665,
    "base": 36401.55,
    "spanA": 37072.6075,
    "spanB": 35583.05,
    "currentSpanA": 34142.167499999996,
    "currentSpanB": 33524,
    "laggingSpanA": 34338.2575,
    "laggingSpanB": 35746.630000000005,
    "backtrack": 5
  },
  {
    "conversion": 37743.665,
    "base": 36168.05,
    "spanA": 37072.6075,
    "spanB": 35583.05,
    "currentSpanA": 34142.167499999996,
    "currentSpanB": 33524,
    "laggingSpanA": 34194.5,
    "laggingSpanB": 35746.630000000005,
    "backtrack": 6
  },
  {
    "conversion": 37649.075,
    "base": 35904.520000000004,
    "spanA": 36955.8575,
    "spanB": 35583.05,
    "currentSpanA": 34109.755,
    "currentSpanB": 33558.985,
    "laggingSpanA": 33936.2625,
    "laggingSpanB": 35782.604999999996,
    "backtrack": 7
  },
  {
    "conversion": 37436.725000000006,
    "base": 35486.11,
    "spanA": 36776.7975,
    "spanB": 35488.46,
    "currentSpanA": 34109.755,
    "currentSpanB": 33915.5,
    "laggingSpanA": 33541.1475,
    "laggingSpanB": 35885,
    "backtrack": 8
  },
  {
    "conversion": 37141.490000000005,
    "base": 35486.11,
    "spanA": 36461.4175,
    "spanB": 35276.11,
    "currentSpanA": 34109.755,
    "currentSpanB": 34122,
    "laggingSpanA": 33671.1375,
    "laggingSpanB": 35885,
    "backtrack": 9
  }
]
			

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