returns the per-session volume profile for ticker (market_type) between start_date and end_date, used to compare volume on economic-data release days against the baseline. the session window is configurable via start_time, end_time, and timezone.
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.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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).
"SPY"
"EURUSD"
"BTCUSD"
"ES"
market venue for the ticker. one of: forex, futures, crypto, stock. determines supported symbols and whether session-based intraday aggregation is available.
forex, futures, crypto, stock "stock"
"forex"
inclusive start date, YYYY-MM-DD, interpreted in the request timezone. sessions on or after this date are included in the calculation.
"2024-01-01"
inclusive end date, YYYY-MM-DD, interpreted in the request timezone. sessions on or before this date are included in the calculation.
"2024-12-31"
optional session start time, HH:MM:SS, interpreted in the request timezone. omit together with end_time to use daily OHLC data. provide together with end_time to aggregate intraday bars into a custom session (forex, futures, and crypto only; ignored for stocks).
optional session end time, HH:MM:SS, interpreted in the request timezone. omit together with start_time to use daily OHLC data. provide together with start_time to aggregate intraday bars into a custom session (forex, futures, and crypto only; ignored for stocks).
IANA timezone used to interpret all date and time parameters and to group sessions into calendar days. defaults to America/New_York.
Successful Response