GET /batch/

Run several GET endpoints and return them as an array.

Resource Information

   
Method GET
URL https://public-api.wordpress.com/rest/v1.3/batch/
Requires authentication? No

Query Parameters

Parameter Type Description
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.
urls (array) Array of endpoints to call

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
400 invalid_input Invalid request input

Example

curl 'https://public-api.wordpress.com/rest/v1/batch/?urls\[\]=/sites/4/&urls\[\]=/sites/4/posts?number=1'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/batch/?urls[]=/sites/4/&urls[]=/sites/4/posts?number=1',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "\/sites\/4\/": {
        "ID": 4,
        "name": "Matt on Not-WordPress",
        "description": "Stuff and things.",
        "URL": "http:\/\/matt.blog",
        "jetpack": false,
        "subscribers_count": 236400,
        "lang": false,
        "icon": {
            "img": "https:\/\/secure.gravatar.com\/blavatar\/1dda380e30f5105e49d00ff16adc24a4",
            "ico": "https:\/\/secure.gravatar.com\/blavatar\/1dda380e30f5105e49d00ff16adc24a4"
        },
        "logo": {
            "id": 0,
            "sizes": [],
            "url": ""
        },
        "visible": null,
        "is_private": false,
        "is_following": false,
        "meta": {
            "links": {
                "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4",
                "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/help",
                "posts": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/posts\/",
                "comments": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/comments\/",
                "xmlrpc": "https:\/\/matt.wordpress.com\/xmlrpc.php"
            }
        }
    },
    "\/sites\/4\/posts?number=1": {
        "found": 2359,
        "posts": [
            {
                "ID": 7943,
                "site_ID": 4,
                "author": {
                    "ID": 5,
                    "login": "matt",
                    "email": false,
                    "name": "Matt",
                    "first_name": "Matt",
                    "last_name": "Mullenweg",
                    "nice_name": "matt",
                    "URL": "https:\/\/matt.blog\/",
                    "avatar_URL": "https:\/\/1.gravatar.com\/avatar\/767fc9c115a1b989744c755db47feb60?s=96&d=retro&r=G",
                    "profile_URL": "https:\/\/en.gravatar.com\/matt",
                    "ip_address": false,
                    "site_ID": 4,
                    "site_visible": true
                },
                "date": "2018-09-30T15:47:36+00:00",
                "modified": "2018-09-30T15:49:20+00:00",
                "title": "New Automattic Pen",
                "URL": "http:\/\/matt.blog\/2018\/09\/30\/new-automattic-pen\/",
                "short_URL": "https:\/\/wp.me\/p4-247",
                "content": "<p><img data-attachment-id=\"7942\" data-permalink=\"http:\/\/matt.blog\/2018\/09\/30\/new-automattic-pen\/50f08088-82b2-40ac-9092-84fa2b790ba3\/\" data-orig-file=\"https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg?w=2048&h=2048\" data-orig-size=\"2048,2048\" data-comments-opened=\"1\" data-image-meta=\"{&quot;aperture&quot;:&quot;0&quot;,&quot;credit&quot;:&quot;&quot;,&quot;camera&quot;:&quot;&quot;,&quot;caption&quot;:&quot;&quot;,&quot;created_timestamp&quot;:&quot;0&quot;,&quot;copyright&quot;:&quot;&quot;,&quot;focal_length&quot;:&quot;0&quot;,&quot;iso&quot;:&quot;0&quot;,&quot;shutter_speed&quot;:&quot;0&quot;,&quot;title&quot;:&quot;&quot;,&quot;orientation&quot;:&quot;0&quot;}\" data-image-title=\"50f08088-82b2-40ac-9092-84fa2b790ba3\" data-image-description=\"\" data-medium-file=\"https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg?w=2048&h=2048?w=300\" data-large-file=\"https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg?w=2048&h=2048?w=1024\" class=\"wp-image-7942 size-full\" src=\"https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg?w=2048&h=2048\" width=\"2048\" height=\"2048\" srcset=\"https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg 2048w, https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg?w=150&amp;h=150 150w, https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg?w=300&amp;h=300 300w, https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg?w=768&amp;h=768 768w, https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg?w=1024&amp;h=1024 1024w\" sizes=\"(max-width: 2048px) 100vw, 2048px\" \/><\/p>\n<p>Has your WP.com username on it, too. <a href=\"https:\/\/automattic.com\/work-with-us\/\">Automattic is hiring!<\/a><\/p>\n",
                "excerpt": "<p>Has your WP.com username on it, too. Automattic is hiring!<\/p>\n",
                "slug": "new-automattic-pen",
                "guid": "http:\/\/matt.blog\/2018\/09\/30\/new-automattic-pen\/",
                "status": "publish",
                "sticky": false,
                "password": "",
                "parent": false,
                "type": "post",
                "comments_open": true,
                "pings_open": true,
                "likes_enabled": true,
                "sharing_enabled": true,
                "comment_count": 1,
                "like_count": 54,
                "i_like": false,
                "is_reblogged": false,
                "is_following": false,
                "global_ID": "8c747ae84a5c0fe9ebb996735449310b",
                "featured_image": "",
                "post_thumbnail": null,
                "format": "standard",
                "geo": false,
                "menu_order": 0,
                "publicize_URLs": [],
                "tags": {},
                "categories": {
                    "Moblog": {
                        "ID": 26114,
                        "name": "Moblog",
                        "slug": "moblog",
                        "description": "",
                        "post_count": 2306,
                        "feed_url": "http:\/\/matt.blog\/category\/moblog\/feed\/",
                        "parent": 0,
                        "meta": {
                            "links": {
                                "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/categories\/slug:moblog",
                                "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/categories\/slug:moblog\/help",
                                "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4"
                            }
                        }
                    }
                },
                "attachments": {
                    "7942": {
                        "ID": 7942,
                        "URL": "https:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg",
                        "guid": "http:\/\/matt.files.wordpress.com\/2018\/09\/50f08088-82b2-40ac-9092-84fa2b790ba3.jpg",
                        "mime_type": "image\/jpeg",
                        "width": 2048,
                        "height": 2048
                    }
                },
                "metadata": [
                    {
                        "id": "68429",
                        "key": "_wpas_done_2191330",
                        "value": "1"
                    },
                    {
                        "id": "68426",
                        "key": "_wpas_done_4543371",
                        "value": "1"
                    },
                    {
                        "id": "68433",
                        "key": "_wpas_done_590",
                        "value": "1"
                    },
                    {
                        "id": "68436",
                        "key": "_wpas_done_592",
                        "value": "1"
                    }
                ],
                "meta": {
                    "links": {
                        "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/posts\/7943",
                        "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/posts\/7943\/help",
                        "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4",
                        "replies": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/posts\/7943\/replies\/",
                        "likes": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/posts\/7943\/likes\/"
                    }
                },
                "current_user_can": {
                    "publish_post": false,
                    "delete_post": false,
                    "edit_post": false
                },
                "capabilities": {
                    "publish_post": false,
                    "delete_post": false,
                    "edit_post": false
                }
            }
        ]
    }
}