Welcome to the REST API. Below, you’ll find a full listing of all the available endpoints. As we add more endpoints, they will be automatically documented here and available through the Developer Console.

For more information about a particular endpoint, click on its name under the Resource header. You’ll be taken to the endpoint’s documentation page, which includes what query parameters the endpoint will accept, what the JSON object’s parameters will be in the response, and an example query/response.

This documentation is for our most recent version of the REST API, version 1.1. Documentation is still available for version 1 of the REST API.

Users

View user information data such as username, name, email, blog and Gravatar.
Resource Description
GET/sites/$site/users List the users of a site.
GET/users/suggest Get a list of possible users to suggest for @mentions.
GET/me Get metadata about the current user.
GET/me/likes/ Get a list of the current user's likes.

Sites

View general site information and options.
Resource Description
GET/sites/$site Get information about a site.
GET/sites/$site/shortcodes Get a list of shortcodes available on a site. Note: The current user must have publishing access.
GET/sites/$site/shortcodes/render Get a rendered shortcode for a site. Note: The current user must have publishing access.
GET/sites/$site/embeds Get a list of embeds available on a site. Note: The current user must have publishing access.
GET/sites/$site/embeds/render Get a rendered embed for a site. Note: The current user must have publishing access.
GET/me/sites Get a list of the current user's sites.

Posts

View and manage posts including reblogs and likes.
Resource Description
GET/sites/$site/posts/ Get a list of matching posts.
GET/sites/$site/posts/$post_ID Get a single post (by ID).
POST/sites/$site/posts/$post_ID Edit a post.
GET/sites/$site/posts/slug:$post_slug Get a single post (by slug).
POST/sites/$site/posts/new Create a post.
POST/sites/$site/posts/$post_ID/delete Delete a post. Note: If the post object is of type post or page and the trash is enabled, this request will send the post to the trash. A second request will permanently delete the post.
POST/sites/$site/posts/$post_ID/restore Restore a post or page from the trash to its previous status.
GET/sites/$site/posts/$post_ID/likes/ Get a list of the likes for a post.
POST/sites/$site/posts/$post_ID/likes/new Like a post.
POST/sites/$site/posts/$post_ID/likes/mine/delete Unlike a post.
GET/sites/$site/posts/$post_ID/likes/mine/ Get the current user's like status for a post.
POST/sites/$site/posts/$post_ID/reblogs/new Reblog a post.
GET/sites/$site/posts/$post_ID/reblogs/mine Get reblog status for a post.
POST/sites/$site/posts/$post/related Search within a site for related posts.

Comments

View and manage a post's comments.
Resource Description
GET/sites/$site/comments/ Get a list of recent comments.
GET/sites/$site/posts/$post_ID/replies/ Get a list of recent comments on a post.
GET/sites/$site/comments/$comment_ID Get a single comment.
POST/sites/$site/comments/$comment_ID Edit a comment.
POST/sites/$site/posts/$post_ID/replies/new Create a comment on a post.
POST/sites/$site/comments/$comment_ID/replies/new Create a comment as a reply to another comment.
POST/sites/$site/comments/$comment_ID/delete Delete a comment.
GET/sites/$site/comments/$comment_ID/likes/ Get the likes for a comment.
POST/sites/$site/comments/$comment_ID/likes/new Like a comment.
POST/sites/$site/comments/$comment_ID/likes/mine/delete Remove your like from a comment.
GET/sites/$site/comments/$comment_ID/likes/mine/ Get your like status for a comment.

Taxonomy

View and manage a site's tags and categories.
Resource Description
GET/sites/$site/categories/slug:$category Get information about a single category.
POST/sites/$site/categories/slug:$category Edit a category.
GET/sites/$site/categories Get a list of a site's categories.
GET/sites/$site/tags Get a list of a site's tags.
GET/sites/$site/tags/slug:$tag Get information about a single tag.
POST/sites/$site/tags/slug:$tag Edit a tag.
POST/sites/$site/categories/new Create a new category.
POST/sites/$site/tags/new Create a new tag.
POST/sites/$site/categories/slug:$category/delete Delete a category.
POST/sites/$site/tags/slug:$tag/delete Delete a tag.

Follow

Follow and unfollow blogs.
Resource Description
GET/sites/$site/follows/ List a site's followers in reverse chronological order.
POST/sites/$site/follows/new Follow a blog.
POST/sites/$site/follows/mine/delete Unfollow a blog.
GET/sites/$site/follows/mine Get blog following status for the current user.

Freshly Pressed

View Freshly Pressed posts from the WordPress.com homepage.
Resource Description
GET/freshly-pressed/ Get a list of Freshly Pressed posts.

Notifications

View and manage a user's notifications.
Resource Description
POST/notifications/seen Set the timestamp of the most recently seen notification.
POST/notifications/read Mark a set of notifications as read.

Insights

View analytics for your application.
Resource Description
GET/insights Get a list of stats/metrics/insights that the current user has access to.
GET/insights/$slug Get raw data for a particular graph.

Reader

Manage and view a user's subscriptions to the WordPress.com Reader.
Resource Description
GET/read/menu/ Get default reader menu.
GET/read/feed/$feed_url_or_id Get details about a feed.
GET/read/following/ Get a list of posts from the blogs a user follows.
GET/read/liked/ Get a list of posts from the blogs a user likes.
GET/read/tags/$tag/posts Get a list of posts from a tag.
GET/read/tags Get a list of tags subscribed to by the user.
GET/read/tags/$tag Get details about a specified tag.
GET/read/tags/$tag/mine Get the subscribed status of the user to a given tag.
POST/read/tags/$tag/mine/new Subscribe to a new tag.
POST/read/tags/$tag/mine/delete Unsubscribe from a tag.
GET/read/following/mine Get a list of the feeds the user is following.
POST/read/following/mine/new Follow the specified blog.
POST/read/following/mine/delete Unfollow the specified blog.
GET/read/recommendations/mine/ Get a list of blog recommendations for the current user.

Stats

View stats for a site.
Resource Description
GET/sites/$site/stats Get a site's stats
GET/sites/$site/stats/summary View a site's summarized views, visitors, likes and comments
GET/sites/$site/stats/top-posts View a site's top posts and pages by views
GET/sites/$site/stats/video/$post_id View the details of a single video
GET/sites/$site/stats/referrers View a site's referrers
GET/sites/$site/stats/clicks View a site's outbound clicks
GET/sites/$site/stats/tags View a site's views by tags and categories
GET/sites/$site/stats/top-authors View a site's top authors
GET/sites/$site/stats/comments View a site's top comment authors and most-commented posts
GET/sites/$site/stats/video-plays View a site's video plays
GET/sites/$site/stats/post/$post_id View a post's views
GET/sites/$site/stats/country-views View a site's views by country
GET/sites/$site/stats/followers View a site's followers
GET/sites/$site/stats/comment-followers View a site's comment followers
POST/sites/$site/stats/referrers/spam/new Report a referrer as spam
POST/sites/$site/stats/referrers/spam/delete Unreport a referrer as spam
GET/sites/$site/stats/publicize View a site's publicize follower counts
GET/sites/$site/stats/search-terms View search terms used to find the site
GET/sites/$site/stats/streak Get stats for Calendar Heatmap. Returns data with each post timestamp.

Media

Manage a site's media library.
Resource Description
GET/sites/$site/media/ Get a list of items in the media library.
GET/sites/$site/media/$media_ID Get a single media item (by ID).
POST/sites/$site/media/$media_ID Edit basic information about a media item.
POST/sites/$site/media/new Upload a new piece of media.
POST/sites/$site/media/$media_ID/delete Delete a piece of media. Note: Media is deleted and not trashed.

Batch

Batch several API GET requests into one.
Resource Description
GET/batch/ Run several GET endpoints and return them as an array.