Batch Routing API

Introduction

NextBillion.ai Batch Routing API is designed to support multiple requests in a single go. Users first need to submit a valid batch of multiple routing requests and retrieve the result asynchronously. Currently, this method accepts only Isochrone API requests.

Let’s take a look at the available methods to create batch requests and retrieve their results.

Create a Batch request

The Batch Routing service allows users to submit a valid batch of routing requests using the HTTP POST method. The individual queries in a batch can be formed using the attributes supported by the standard routing endpoints. The limitations and validations applicable for individual queries in a batch are consistent with those for standard routing endpoints. Know more about these limitations by visiting the individual endpoint documentation which is being added in a batch routing request.

Request Parameters

Request Body

Response Schema

Sample Request

1
curl --location 'https://api.nextbillion.io/batch?key=<your_api_key>' \
2
--header 'Content-Type: application/json' \
3
--data '{
4
    "requests": [
5
        {
6
            "query": "/isochrone/json?mode=4w&coordinates=38.517410585895064,-121.48676022290115&denoise=1&contours_minutes=3&key=<your_api_key>"
7
        },
8
        {
9
             "query": "/isochrone/json?mode=4w&coordinates=37.71775363,-122.20668736&denoise=1&contours_minutes=2&key=<your_api_key>"
10
        }
11

12
    ]
13
}'

Sample Response

1
{
2
    "status": "pending",
3
    "track_id": "1f41eb60-334b-4f9c-ba8c-0d9ed59d2790"
4
}

Retrieve a Batch result

In order to retrieve the result of a previously submitted batch routing request, users can submit a GET request to the following endpoint while specifying the track_id generated once the batch was successfully created.

Request Parameters

Response Schema

Sample Request

1
curl --location 'https://api.nextbillion.io/batch?track_id=1f41eb60-334b-4f9c-ba8c-0d9ed59d2790&key=<your_api_key>'

Sample Response

1
{
2
    "status": "success",
3
    "track_id": "1f41eb60-334b-4f9c-ba8c-0d9ed59d2790",
4
    "responses":[...]
5
}

API Query Limits

1. Only the Isochrone API requests can be added as individual queries in a batch, for now.
2. The maximum number of individual queries that can be added to a single batch are limited to 20.
3. NextBillion.ai allows a maximum rate limit of 6000 queries per minute or 100 queries/second for continuous requests.
   Note: We can increase the quota if needed, on request. Contact [email protected] for more details.

API Error Codes