watchers

WATCHER: get a signed callback when a FRED economic series'...

WATCHER: get a signed callback when a FRED economic series' latest value crosses a level. Arm once, pay once. Pass seriesId (e.g. DGS10 = 10yr Treasury, UNRATE = unemployment, CPIAUCSL = CPI, FEDFUNDS = fed funds). conditionType 'above'/'below'; threshold is the series value. Fires once per crossing as new data posts; bounded by maxFires/expiry. Free public-domain (FRED). Signed (verify offline) + retried; recoverable via watchers.status. Returns a watcherId.

post/api/watchers/fred-series

Request

  • Base URL: https://2s.io
  • URL: https://2s.io/api/watchers/fred-series
  • Auth: API key in header PAYMENT-SIGNATURE

Request body

seriesIdstring required

FRED series id, e.g. DGS10, UNRATE, CPIAUCSL, FEDFUNDS.

conditionType'above' | 'below' required

Fire when the latest value goes above or below the threshold.

thresholdnumber required

The series value to cross, e.g. 5 (for DGS10 = 5% 10yr yield).

callbackUrlstring uri required

Signed event POSTed here (verify X-2s-Signature). Any http(s) URL.

payloadobject

Arbitrary JSON echoed back in every callback.

expiresInSecondsinteger

Active window in seconds (default 30d, max 90d).

maxFiresinteger

Stop after this many callbacks (default 1).

labelstring

Optional free-text tag.

Response

(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.