watchers

WATCHER: get a signed callback when a new news article is...

WATCHER: get a signed callback when a new news article is published about a US company. Arm once, pay once. Pass ticker; optionally keyword to only fire on headlines containing it. Fires once per new article (deduped by id); bounded by maxFires/expiry. Existing articles at arm time are baselined. News via Finnhub. Signed (verify offline) + retried; recoverable via watchers.status. Returns a watcherId.

post/api/watchers/company-news

Request

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

Request body

tickerstring required

US-listed ticker, e.g. AAPL.

keywordstring

Optional: only fire on headlines containing this text (case-insensitive).

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 articles (default 25).

labelstring

Optional free-text tag.

Response

(unresolved $ref)

Changes

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