Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).

Query Parameters

market_type
enum<string>
required

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

Available options:
all,
stock,
futures
session_name
enum<string>
default:NY

trading session to subscribe to; 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; futures only.

end_time
string
default:""

custom session end time, HH:MM, interpreted in timezone. provide together with start_time; futures only.

timezone
enum<string>
default:America/New_York

IANA timezone used to interpret custom session bounds. choose one of the preset live-session timezones from the docs dropdown.

Available options:
America/New_York,
Europe/London,
Asia/Tokyo
overnight
boolean
default:false

set to true when the custom session spans midnight.

tickers
string
default:""

comma-separated ticker symbols (e.g., ES,NQ,CL). optional for standard sessions; required for custom sessions. omitted or empty includes all standard-session tickers.

reports
string
default:""

optional comma-separated exact report keys for standard sessions (e.g., gap_fill_50,opening_range_15min). omitted or empty includes all reports. custom sessions ignore this filter.

Response

Successful Response