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": 235431,
        "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": 2327,
        "posts": [
            {
                "ID": 7785,
                "site_ID": 4,
                "author": {
                    "ID": 5,
                    "login": "matt",
                    "email": false,
                    "name": "Matt",
                    "first_name": "Matt",
                    "last_name": "Mullenweg",
                    "nice_name": "matt",
                    "URL": "http:\/\/matt.wordpress.com",
                    "avatar_URL": "https:\/\/1.gravatar.com\/avatar\/767fc9c115a1b989744c755db47feb60?s=96&d=retro&r=G",
                    "profile_URL": "http:\/\/en.gravatar.com\/matt",
                    "site_ID": 492382
                },
                "date": "2016-12-15T15:59:27+00:00",
                "modified": "2016-12-15T15:59:27+00:00",
                "title": "Roller Coaster at Pleasure Pier",
                "URL": "http:\/\/matt.blog\/2016\/12\/15\/roller-coaster-at-pleasure-pier\/",
                "short_URL": "http:\/\/wp.me\/p4-21z",
                "content": "<p><img data-attachment-id=\"7786\" data-permalink=\"http:\/\/matt.blog\/2016\/12\/15\/roller-coaster-at-pleasure-pier\/img_3976\/\" data-orig-file=\"https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg?w=4032&h=3024\" data-orig-size=\"4032,3024\" data-comments-opened=\"1\" data-image-meta=\"{&quot;aperture&quot;:&quot;1.8&quot;,&quot;credit&quot;:&quot;&quot;,&quot;camera&quot;:&quot;iPhone 7 Plus&quot;,&quot;caption&quot;:&quot;&quot;,&quot;created_timestamp&quot;:&quot;1480263307&quot;,&quot;copyright&quot;:&quot;&quot;,&quot;focal_length&quot;:&quot;3.99&quot;,&quot;iso&quot;:&quot;20&quot;,&quot;shutter_speed&quot;:&quot;0.00044903457566233&quot;,&quot;title&quot;:&quot;&quot;,&quot;orientation&quot;:&quot;1&quot;}\" data-image-title=\"img_3976\" data-image-description=\"\" data-medium-file=\"https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg?w=4032&h=3024?w=300\" data-large-file=\"https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg?w=4032&h=3024?w=1024\" class=\"alignnone size-full wp-image-7786\" src=\"https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg?w=4032&h=3024\" alt=\"IMG_3976.jpg\" width=\"4032\" height=\"3024\" srcset=\"https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg 4032w, https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg?w=150&amp;h=113 150w, https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg?w=300&amp;h=225 300w, https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg?w=768&amp;h=576 768w, https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg?w=1024&amp;h=768 1024w\" sizes=\"(max-width: 4032px) 100vw, 4032px\" \/><\/p>\n",
                "excerpt": "",
                "slug": "roller-coaster-at-pleasure-pier",
                "guid": "http:\/\/matt.blog\/?p=7785",
                "status": "publish",
                "sticky": false,
                "password": "",
                "parent": false,
                "type": "post",
                "comments_open": true,
                "pings_open": true,
                "likes_enabled": true,
                "sharing_enabled": true,
                "comment_count": 5,
                "like_count": 74,
                "i_like": false,
                "is_reblogged": false,
                "is_following": false,
                "global_ID": "3a4b5aebc7701f97e1c9b47809526ebc",
                "featured_image": "",
                "post_thumbnail": null,
                "format": "image",
                "geo": false,
                "menu_order": 0,
                "publicize_URLs": [],
                "tags": {},
                "categories": {
                    "Moblog": {
                        "ID": 26114,
                        "name": "Moblog",
                        "slug": "moblog",
                        "description": "",
                        "post_count": 2274,
                        "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": {
                    "7786": {
                        "ID": 7786,
                        "URL": "https:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg",
                        "guid": "http:\/\/matt.files.wordpress.com\/2016\/12\/img_3976.jpg",
                        "mime_type": "image\/jpeg",
                        "width": 4032,
                        "height": 3024
                    }
                },
                "metadata": [
                    {
                        "id": "66984",
                        "key": "_wpas_done_2191330",
                        "value": "1"
                    },
                    {
                        "id": "66981",
                        "key": "_wpas_done_4543378",
                        "value": "1"
                    },
                    {
                        "id": "66987",
                        "key": "_wpas_done_590",
                        "value": "1"
                    },
                    {
                        "id": "66975",
                        "key": "_wpas_done_591",
                        "value": "1"
                    },
                    {
                        "id": "66989",
                        "key": "_wpas_done_592",
                        "value": "1"
                    },
                    {
                        "id": "66976",
                        "key": "_wpas_google_plus_publicize_failure",
                        "value": {
                            "errors": {
                                "keyring-request-error": [
                                    {
                                        "headers": {},
                                        "body": "{\n \"error\": {\n  \"errors\": [\n   {\n    \"domain\": \"global\",\n    \"reason\": \"authError\",\n    \"message\": \"Invalid Credentials\",\n    \"locationType\": \"header\",\n    \"location\": \"Authorization\"\n   }\n  ],\n  \"code\": 401,\n  \"message\": \"Invalid Credentials\"\n }\n}\n",
                                        "response": {
                                            "code": 401,
                                            "message": "Unauthorized"
                                        },
                                        "cookies": [],
                                        "filename": null,
                                        "http_response": {
                                            "data": null,
                                            "headers": null,
                                            "status": null
                                        }
                                    }
                                ]
                            },
                            "error_data": []
                        }
                    }
                ],
                "meta": {
                    "links": {
                        "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/posts\/7785",
                        "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/posts\/7785\/help",
                        "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4",
                        "replies": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/posts\/7785\/replies\/",
                        "likes": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/4\/posts\/7785\/likes\/"
                    }
                },
                "current_user_can": {
                    "publish_post": false,
                    "delete_post": false,
                    "edit_post": false
                },
                "capabilities": {
                    "publish_post": false,
                    "delete_post": false,
                    "edit_post": false
                }
            }
        ]
    }
}