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

cut the catalog to one market; all is a market of the wip and screener surfaces only.

Available options:
futures,
stock,
forex,
crypto
surface
enum<string>
default:report

report lists report pages; wip or screener lists what those templates are composed from.

Available options:
report,
wip,
screener

Response

Successful Response

count
integer | null

report surface: number of families listed.

families
CatalogFamily · object[] | null

report surface: the report pages.

surface
string | null

wip or screener surfaces: the surface described.

markets
string[] | null

wip or screener surfaces: the markets listed.

sessions
any | null

wip or screener surfaces: sessions per market.

tickers
any | null

wip or screener surfaces: tickers per market.

reports
any | null

wip or screener surfaces: report keys with their exclusions or suffix rule.

customizations
any | null

wip or screener surfaces: customization setting keys with fields, options and defaults.

filters
any | null

wip surface: the percentage range.

min_reports
integer | null

screener surface: fewest reports per template.

max_reports
integer | null

screener surface: most reports per template.