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) |
The URL for the feed you would like more details on, or the id of the Feed. If a URL is passed, it MUST be URL-encoded. |
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
This endpoint does not return any errors.