Get the ID and subscribe URL of one or more matching feeds by domain or URL.
Resource Information
| |
|
| Method |
GET |
| URL |
https://public-api.wordpress.com/rest/v1.1/read/feed/ |
| Requires authentication? |
No |
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. |
| url |
(string) |
The domain or URL of the site you would like to retrieve the feed(s) ID for. It MUST be URL-encoded. |
| q |
(string) |
Query text |
| offset |
(int) |
offset to page results to |
| number |
(int) |
number of results to return |
| exclude_followed |
(boolean) |
Exclude already followed sites in search results Default: true. |
| sort |
(string) |
relevance or last_updated |
| page_handle |
(string) |
A handle for getting the next page of results when sorting by last_updated |
| algorithm |
(string) |
Specify a particular algorithm to use to choose posts (optional) |
Response Parameters
| Parameter |
Type |
Description |
| feeds |
(array) |
Found feeds, represented by their subscribe URL and feed ID. |
Resource Errors
This endpoint does not return any errors.
