JSON Feed

Last updated
JSON Feed
Filename extension
.json
Internet media type application/feed+json
Type of format Web syndication
Extended from JSON
Open format?yes
Website https://jsonfeed.org/

JSON Feed is a Web feed file format for Web syndication in JSON instead of XML as used by RSS and Atom. [1]

Contents

A range of software libraries and web frameworks support content syndication via JSON Feed. [2] Supporting clients include NetNewsWire, NewsBlur, [3] ReadKit and Reeder.

Notable publishers include NPR [4] and the Microblogging platform Micro.blog, which uses it as the response format for many API calls. [5]

Example

This is an example feed using the 1.1 Specification. [6] More details can be found on the website, including other optional properties like expired and hubs. Custom objects may also be used by publishers, but feed readers that do not understand it must ignore it.

{"version":"https://jsonfeed.org/version/1.1","title":"My Example Feed","home_page_url":"https://example.org/","feed_url":"https://example.org/feed.json","description":"Optional to provide more detail beyond the title.","user_comment":"Optional and should be ignored by feed readers.","next_url":"https://example.org/pagination?feed=feed.json&p=17","icon":"https://example.org/favicon-timeline-512x512.png","favicon":"https://example.org/favicon-sourcelist-64x64.png","authors":[{"name":"Optional Author","url":"https://example.org/authors/optional-author","avatar":"https://example.org/authors/optional-author/avatar-512x512.png"}],"language":"en-US","items":[{"id":"2","content_text":"This is a second item.","url":"https://example.org/second-item","language":"es-mx","attachments":[{"url":"https://example.org/second-item/audio.ogg","mime_type":"audio/ogg","title":"Optional Title","size_in_bytes":31415927,"duration_in_seconds":1800}]},{"id":"required-unique-string-that-does-not-change: number, guid, url, etc.","url":"https://example.org/initial-post","external_url":"https://en.wikipedia.org/w/index.php?title=JSON_Feed","title":"Optional Title","content_html":"<p>Optional content for the feed reader. You may also use content_text or both at the same time.</p>","content_text":"Optional text for simple feeds.","summary":"Optional summary of the item.","image":"https://example.org/initial-post/main-img.png","banner_image":"https://example.org/initial-post/details-banner.png","date_published":"2021-10-25T19:30:00-01:00","date_modified":"2021-10-26T19:45:00-01:00","authors":[{"name":"Optional Author","url":"https://example.org/authors/optional-author","avatar":"https://example.org/authors/optional-author/avatar-512x512.png"}],"tags":["Optional Tag","Example"],"language":"en-US"}]}

See also

Related Research Articles

<span class="mw-page-title-main">RSS</span> Family of web feed formats

RSS is a web feed that allows users and applications to access updates to websites in a standardized, computer-readable format. Subscribing to RSS feeds can allow a user to keep track of many different websites in a single news aggregator, which constantly monitor sites for new content, removing the need for the user to manually check them. News aggregators can be built into a browser, installed on a desktop computer, or installed on a mobile device.

<span class="mw-page-title-main">Favicon</span> Icon associated with a particular web site

A favicon, also known as a shortcut icon, website icon, tab icon, URL icon, or bookmark icon, is a file containing one or more small icons associated with a particular website or web page. A web designer can create such an icon and upload it to a website by several means, and graphical web browsers will then make use of it. Browsers that provide favicon support typically display a page's favicon in the browser's address bar and next to the page's name in a list of bookmarks. Browsers that support a tabbed document interface typically show a page's favicon next to the page's title on the tab, and site-specific browsers use the favicon as a desktop icon.

<span class="mw-page-title-main">Atom (web standard)</span> Web standards

The name Atom applies to a pair of related Web standards. The Atom Syndication Format is an XML language used for web feeds, while the Atom Publishing Protocol is a simple HTTP-based protocol for creating and updating web resources.

<span class="mw-page-title-main">Web feed</span> Data format

On the World Wide Web, a web feed is a data format used for providing users with frequently updated content. Content distributors syndicate a web feed, thereby allowing users to subscribe a channel to it by adding the feed resource address to a news aggregator client. Users typically subscribe to a feed by manually entering the URL of a feed or clicking a link in a web browser or by dragging the link from the web browser to the aggregator, thus "RSS and Atom files provide news updates from a website in a simple form for your computer."

<span class="mw-page-title-main">NetNewsWire</span> News aggregator for macOS

NetNewsWire is a free and open-source news aggregator for macOS and iOS. It was introduced by Brent and Sheila Simmons on July 12, 2002, under their company Ranchero Software.

The data URI scheme is a uniform resource identifier (URI) scheme that provides a way to include data in-line in Web pages as if they were external resources. It is a form of file literal or here document. This technique allows normally separate elements such as images and style sheets to be fetched in a single Hypertext Transfer Protocol (HTTP) request, which may be more efficient than multiple HTTP requests, and used by several browser extensions to package images as well as other multimedia content in a single HTML file for page saving. As of 2024, data URIs are fully supported by all major browsers.

In computer hypertext, a URI fragment is a string of characters that refers to a resource that is subordinate to another, primary resource. The primary resource is identified by a Uniform Resource Identifier (URI), and the fragment identifier points to the subordinate resource.

Sitemaps is a protocol in XML format meant for a webmaster to inform search engines about URLs on a website that are available for web crawling. It allows webmasters to include additional information about each URL: when it was last updated, how often it changes, and how important it is in relation to other URLs of the site. This allows search engines to crawl the site more efficiently and to find URLs that may be isolated from the rest of the site's content. The Sitemaps protocol is a URL inclusion protocol and complements robots.txt, a URL exclusion protocol.

RDFa or Resource Description Framework in Attributes is a W3C Recommendation that adds a set of attribute-level extensions to HTML, XHTML and various XML-based document types for embedding rich metadata within Web documents. The Resource Description Framework (RDF) data-model mapping enables its use for embedding RDF subject-predicate-object expressions within XHTML documents. It also enables the extraction of RDF model triples by compliant user agents.

A media type is a two-part identifier for file formats and format contents transmitted on the Internet. Their purpose is somewhat similar to file extensions in that they identify the intended data format. The Internet Assigned Numbers Authority (IANA) is the official authority for the standardization and publication of these classifications. Media types were originally defined in Request for Comments RFC 2045 (MIME) Part One: Format of Internet Message Bodies in November 1996 as a part of the MIME specification, for denoting type of email message content and attachments; hence the original name, MIME type. Media types are also used by other internet protocols such as HTTP and document file formats such as HTML, for similar purposes.

GeoRSS is a specification for encoding location as part of a Web feed. (Web feeds are used to describe feeds of content, such as news articles, Audio blogs, video blogs and text blog entries. These web feeds are rendered by programs such as aggregators and web browsers.) The name "GeoRSS" is derived from RSS, the most known Web feed and syndication format.

Microblogging is a form of blogging using short posts without titles known as microposts. Microblogs "allow users to exchange small elements of content such as short sentences, individual images, or video links", which may be the major reason for their popularity. Some popular social networks such as Twitter, Mastodon, Tumblr, Koo, and Instagram can be viewed as collections of microblogs.

<span class="mw-page-title-main">EPUB</span> E-book format

EPUB is an e-book file format that uses the ".epub" file extension. The term is short for electronic publication and is sometimes stylized as ePub. EPUB is supported by many e-readers, and compatible software is available for most smartphones, tablets, and computers. EPUB is a technical standard published by the International Digital Publishing Forum (IDPF). It became an official standard of the IDPF in September 2007, superseding the older Open eBook (OEB) standard.

Yahoo! Meme was a microblogging site launched by the Yahoo Latin America team in August 2009. The platform was conceived as a mash up of functionality derived from Twitter and Tumblr. Its beta version was originally launched to a Brazilian audience with later versions expanding into Spanish, English, Chinese, and Indonesian audiences.

Microdata is a WHATWG HTML specification used to nest metadata within existing content on web pages. Search engines, web crawlers, and browsers can extract and process Microdata from a web page and use it to provide a richer browsing experience for users. Search engines benefit greatly from direct access to this structured data because it allows them to understand the information on web pages and provide more relevant results to users. Microdata uses a supporting vocabulary to describe an item and name-value pairs to assign values to its properties. Microdata is an attempt to provide a simpler way of annotating HTML elements with machine-readable tags than the similar approaches of using RDFa and microformats.

In computing, Open Data Protocol (OData) is an open protocol that allows the creation and consumption of queryable and interoperable Web service APIs in a standard way. Microsoft initiated OData in 2007. Versions 1.0, 2.0, and 3.0 are released under the Microsoft Open Specification Promise. Version 4.0 was standardized at OASIS, with a release in March 2014. In April 2015 OASIS submitted OData v4 and OData JSON Format v4 to ISO/IEC JTC 1 for approval as an international standard. In December 2016, ISO/IEC published OData 4.0 Core as ISO/IEC 20802-1:2016 and the OData JSON Format as ISO/IEC 20802-2:2016.

The Open Publication Distribution System (OPDS) catalog format is a syndication format for electronic publications based on Atom and HTTP. OPDS catalogs enable the aggregation, distribution, discovery, and acquisition of electronic publications. OPDS catalogs use existing or emergent open standards and conventions, with a priority on simplicity.

Schema.org is a reference website that publishes documentation and guidelines for using structured data mark-up on web-pages. Its main objective is to standardize HTML tags to be used by webmasters for creating rich results about a certain topic of interest. It is a part of the semantic web project, which aims to make document mark-up codes more readable and meaningful to both humans and machines.

<span class="mw-page-title-main">Yesod (web framework)</span>

Yesod is a web framework based on the programming language Haskell for productive development of type-safe, representational state transfer (REST) model based, high performance web applications, developed by Michael Snoyman, et al. It is free and open-source software released under an MIT License.

Micro.blog is a microblogging and social networking service created by Manton Reece. It is the first large multi-user social media service to support the Webmention and Micropub standards published by the World Wide Web Consortium, and is part of the Fediverse, supporting ActivityPub.

References

  1. Brent Simmons; Manton Reece (2017-05-17). "JSON Feed: Version 1".
  2. Brent Simmons; Manton Reece. "JSON Feed: Code".
  3. Samuel Clay (23 May 2017). "NewsBlur now supports the new JSON Feed spec". The NewsBlur Blog. Retrieved 17 July 2020.
  4. Kasbergen, Nara (12 December 2017). "NPR now supports JSON Feed!". Medium. Retrieved 17 July 2020.
  5. "JSON Feed". Indie Microblogging. Manton Reece. Retrieved 2022-12-24.
  6. "JSON Feed - JSON Feed Version 1.1". www.jsonfeed.org. Retrieved 2021-10-25.