Skip to main content
POST
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>).

Body

application/json
market
enum<string> | null

default market; a change resets the ticker to that market's default.

Available options:
futures,
stock,
forex,
crypto
ticker
string | null

default ticker, known on the default market.

Required string length: 1 - 30
session
string | null

default session: a standard session id the default report allows on the market.

Required string length: 1 - 80
date_range
enum<string> | null

default date range preset.

Available options:
1m,
3m,
6m,
ytd,
1yr,
2yr,
3yr,
5yr
report
string | null

default report: a report catalog slug, or custom: of a saved custom report.

Required string length: 1 - 80

Response

Successful Response

status
string
required

updated or unchanged.

defaults
DefaultsTuple · object
required

the reconciled defaults after this write.

previous
DefaultsTuple · object
required

the defaults before this write, for undo.

changed
Changed · object
required

the fields that changed, with their new values.

url
string
required

the default report page in Edgeful.