Skip to main content
GET
/
intraday_calculation
/
initial-balance-breakout-by-time
/
{market_type}
/
{ticker}
cURL
curl --request GET \
  --url 'https://api.edgeful.com/intraday_calculation/initial-balance-breakout-by-time/<market_type>/<ticker>?start_date=<start_date>&end_date=<end_date>&start_time=<start_time>&end_time=<end_time>&timezone=<timezone>' \
  --header 'Authorization: Bearer <api-key>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://edgeful.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
ticker
string
required

ticker symbol. format varies by market_type: stocks use a plain symbol (e.g., SPY), forex uses a 6-character pair (e.g., EURUSD), crypto uses a contract pair (e.g., BTCUSD), futures uses the root symbol (e.g., ES).

Examples:

"SPY"

"EURUSD"

"BTCUSD"

"ES"

​
market_type
enum<string>
required

market venue for the ticker. one of: forex, futures, crypto, stock. determines supported symbols and whether session-based intraday aggregation is available.

Available options:
forex,
futures,
crypto,
stock
Examples:

"stock"

"forex"

Query Parameters

​
start_date
string
required

inclusive start date, YYYY-MM-DD, interpreted in the request timezone. sessions on or after this date are included in the calculation.

Example:

"2024-01-01"

​
end_date
string
required

inclusive end date, YYYY-MM-DD, interpreted in the request timezone. sessions on or before this date are included in the calculation.

Example:

"2024-12-31"

​
ib_period
string
default:60min

length of the initial balance window measured from the session open (e.g., 30min, 60min).

​
ib_breakout_time
number
default:150

minute threshold from session open used to split breakouts into early vs late buckets.

​
start_time
string
required

required intraday session start time, HH:MM:SS, interpreted in the request timezone. use the session preset that matches the market and trading session you want to analyze.

Examples:

"09:30:00"

"08:00:00"

​
end_time
string
required

required intraday session end time, HH:MM:SS, interpreted in the request timezone. use the session preset that matches the market and trading session you want to analyze.

Examples:

"16:00:00"

"17:00:00"

​
breakout_criteria
string
default:wick

rule used to confirm a breakout; wick accepts a wick touch, close requires a candle close beyond the level.

​
break_type
string
default:all

type of break to analyze; single_break, double_break, or all.

​
ib_size
enum<integer>
default:0

IB-size bucket used to filter sessions; ANY includes all sizes.

Available options:
0,
1,
2,
3,
4,
5
​
days_to_use
string[]

optional list of weekdays (e.g., Monday, Friday) to include; all weekdays are used when omitted.

​
timeframe
string
default:5min

intraday candle granularity used for the calculation. accepted values: 1min, 5min, 15min, 30min, 1hour. route-specific defaults are shown in the default field.

​
timezone
string
required

required IANA timezone used to interpret the requested intraday session window and group sessions into calendar days.

Examples:

"America/New_York"

"Europe/London"

"Asia/Tokyo"

Response

Successful Response