GET /read/feed/$feed_url_or_id

Get details about a feed.

Resource Information

   
Method GET
URL https://public-api.wordpress.com/rest/v1.1/read/feed/$feed_url_or_id
Requires authentication? No

Method Parameters

Parameter Type Description
$feed_url_or_id (none)

Query Parameters

Parameter Type Description
context (string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
false:
(default)
true:
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.

Response Parameters

Parameter Type Description
blog_ID (string) The site ID, 0 if this not a hosted site.
feed_ID (string) The ID for this feed
name (string) The name of the site
URL (string) The main URL for the site
feed_URL (string) The feed URL that WordPress polls for changes
subscribers_count (int) The number of subscribers for this feed
is_following (boolean) Is the current user following this feed?
last_update (string) The timestamp of the most recent entry in the feed
last_checked (string) The timestamp of when we last checked the feed
marked_for_refresh (boolean) Is the feed queued up to be refreshed soon?
next_refresh_time (string) The timestamp for when we are going to refresh this feed

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
410 feed_gone The feed has been deleted
404 no_such_feed No feed found for that URL

Example

curl 'https://public-api.wordpress.com/rest/v1/read/feed/http%3A%2F%2Fen.blog.wordpress.com%2Ffeed'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/read/feed/http%3A%2F%2Fen.blog.wordpress.com%2Ffeed',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "blog_ID": "3584907",
    "feed_ID": "15115391",
    "name": "The WordPress.com Blog",
    "URL": "http:\/\/en.blog.wordpress.com\/",
    "feed_URL": "http:\/\/en.blog.wordpress.com\/feed",
    "subscribers_count": 32159,
    "is_following": false,
    "last_update": "2018-08-14T12:00:27+00:00",
    "last_checked": "2018-08-15T04:59:14+00:00",
    "marked_for_refresh": false,
    "next_refresh_time": null,
    "meta": {
        "links": {
            "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/read\/feed\/15115391",
            "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/read\/sites\/3584907"
        }
    },
    "resolved_feed_url": "http:\/\/en.blog.wordpress.com\/feed\/",
    "image": "http:\/\/0.gravatar.com\/blavatar\/e6392390e3bcfadff3671c5a5653d95b?s=96&d=http%3A%2F%2Fs0.wp.com%2Fi%2Fbuttonw-com.png",
    "description": "The latest news on WordPress.com and the WordPress community."
}