Breakaway
Get started with the breakaway
Simply make an HTTPS [GET] request or call in your browser:
[GET] https://api.taapi.io/breakaway?secret=MY_SECRET&exchange=binance&symbol=BTC/USDT&interval=1h
API response
The breakaway endpoint returns a JSON response like this:
{
value: "100" // breakaway pattern found at this candle
}
// OR
{
value: "-100" // breakaway bearish variation (if applicable) found at this candle (not all patterns have bearish variations)
}
// OR
{
value: "0" // breakaway pattern NOT found at this candle
}
Example responses from TAAPI.IO when querying breakaway endpoint.
API parameters
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 breakaway value X amount of candles back. So, if you are fetching the breakaway on the hourly and you want to know what the breakaway 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.
fromTimestamp
New
Optional
String
The start of the time range in Unix epoch time. For example:
1685577600
toTimestamp
New
Optional
String
The end of the time range in Unix epoch time. For example:
1731456000 If you only use fromTimestamp, the API will return all results from that time until present.
gaps
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.
More examples
Let's say you want to know the breakaway 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/breakaway?secret=MY_SECRET&exchange=binance&symbol=BTC/USDT&interval=30m&backtrack=1
Get breakaway values on each of the past X candles in one call
Let's say you want to know what the breakaway 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/breakaway?secret=MY_SECRET&exchange=binance&symbol=BTC/USDT&interval=1d&results=10
Here's the example response:
{
"value": [
0,
0,
0,
100, // <-- Pattern found at this candle
0,
0,
-100, // <-- Bearish variation pattern found at this candle
0,
0,
0 // <-- Most recent value
]
}