Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Use your Edgeful API key as the bearer token. In the API Reference authorization drawer, paste only the key (for example, ef_live_<random>).

Path Parameters

market_type
enum<string>
required

type of market to stream data for. use all to stream both stocks and futures together.

Available options:
all,
futures,
stock
Examples:

"futures"

"stock"

Query Parameters

session
enum<string>
default:NY

standard session to stream; one of NY, LONDON, ASIA. ignored when start_time and end_time are provided.

Available options:
NY,
LONDON,
ASIA
start_time
string
default:""

custom session start time, HH:MM, interpreted in timezone. provide together with end_time to define a custom intraday window; futures only.

end_time
string
default:""

custom session end time, HH:MM, interpreted in timezone. provide together with start_time to define a custom intraday window; futures only.

overnight
boolean
default:false

set to true when the custom session spans midnight (i.e., start_time is after end_time).

timezone
enum<string>
default:America/New_York

IANA timezone used to interpret start_time and end_time for custom sessions. choose one of the preset live-session timezones from the docs dropdown.

Available options:
America/New_York,
Europe/London,
Asia/Tokyo
date_range
enum<string>
default:6mo

historical lookback window attached to each ticker's report data; 3mo or 6mo.

Available options:
3mo,
6mo
tickers
string
default:""

comma-separated list of ticker symbols to include (e.g., ES,NQ,CL). empty string streams all available tickers.

customizations
string
default:""

report variant preferences as report_type:value pairs (e.g., gap_fill_standard:100,initial_balance_standard:60min_wick).

reports
string
default:""

comma-separated list of report types to include (e.g., gap_fill_standard,initial_balance_standard). empty string includes all reports.

Response

Successful Response