feeds

Fetch and parse a feed

Fetch an RSS, Atom, or JSON feed and return its articles as normalized JSON. Results are cached for five minutes.

Needs no credential: the RSS app on the screen calls it. Limited to 120 calls a minute from one IP address.

Notes.

  • fetchedAt is a top-level key beside data, not inside it.
  • Cached for 5 minutes (Cache-Control: public, max-age=60, s-maxage=300).
get/v1/feeds/fetch

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/feeds/fetch
  • Auth: none required

Query parameters

urlstring required

The feed URL (RSS, Atom or JSON Feed). A web page URL also works when the site has a feed at a usual path (/feed, /rss.xml).

langstring

With translate=1: translate the article text to this language (BCP 47).

translate'1'
dtstring

With translate=1: the screen's app-data token. Translation is billed to its workspace. Without a valid token the feed comes back untranslated.

Response

Success.

fetchedAtstring required

When the feed was fetched. It is beside data, not in it.

Changes

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