---
title: "The Route Range Batch API sends batches of up to **100** queries as a single call to the [Route Range API](/rest/api/maps/route/post-route-range?view=rest-maps-2024-07-01-preview)."
method: POST
path: "/route/range:batch"
---

# The Route Range Batch API sends batches of up to \*\*100\*\* queries as a single call to the \[Route Range API\](/rest/api/maps/route/post-route-range?view=rest-maps-2024-07-01-preview).

`POST /route/range:batch`

>[!Important]
>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.

### Submit Synchronous Batch Request
The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.
```
POST https://atlas.microsoft.com/route/range:batch?api-version=2024-07-01-preview
```
### POST Body for Batch Request
To send the _route range_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 2 _route_range_ queries:


```
{
  "batchItems": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.86605,
          50.9745
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201669,
          47.615076
        ]
      },
      "properties": {
        "timeBudgetInSec": 2000
      }
    }
  ]
}
```

A _route range_ batchItem object can accept any of the supported _snap to roads_ [Request body](/rest/api/maps/route/post-snap-to-roads?view=rest-maps-2024-07-01-preview#request-body) 


The batch should contain at least **1** query.


### Batch Response Model
The batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests` i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item is of one of the following types:

  - [`RouteRangeResponse`](/rest/api/maps/route/post-route-range#response) - If the query completed successfully.

  - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.

## Query parameters

- `api-version` string, required

## Parameters

- `../../../Common/preview/1.0/common.json#/components/parameters/ClientId` — unresolved $ref

## Request body

- RouteRangeBatchRequestBody — The list of route range queries/requests to process. The list can contain a max of 100 queries and must contain at least 1 query.
  - `batchItems` RouteRangeBatchRequestItem[] — The list of queries to process. — unresolved $ref

## Response `200`

Batch request successfully processed. The response body contains all the batch results.

- RouteRangeBatchResponse — This object is returned from a successful Route Range Batch service call.
  - `summary` object — Summary for the batch request
    - `successfulRequests` integer — Number of successful requests in the batch
    - `totalRequests` integer — Total number of requests in the batch
  - `batchItems` RouteRangeBatchResponseItem[] — Array containing the batch results.
    - `optionalId` string — Id of the request which would show in corresponding batchItem.
    - `type` 'FeatureCollection' — Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).
    - `features` RouteRangeFeaturesItem[] — `GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details.
      - `type` 'Feature' — Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946).
      - `geometry` RouteRangeGeometry — A valid `GeoJSON` Geometry object. Please refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.
        - `type` string, required — Specifies the geometry type for the `GeoJSON` Geometry object. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details.
      - `bbox` number[] — A rectangular area on the earth defined as a bounding box object. The sides of the rectangles are defined by latitude and longitude values. For more information, see [RFC 7946, Section 5](https://www.rfc-editor.org/rfc/rfc7946#section-5). Example: "bbox": [-10.0, -10.0, 10.0, 10.0]
      - `properties` RouteRangeFeatureProperties — Route Ranges properties.
        - `type` 'center' | 'boundary' — The feature types for the feature objects returned in the response.
    - `error` ErrorDetail — unresolved $ref

## Other responses

- `default` — An unexpected error occurred.

## Changes

- **2026-07-13** (1.0) `7677b00a7f5a` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/azure/apis/maps-route/changes/route/range:batch/post.md)

---

[API](https://skmtc.dev/azure/apis/maps-route.md) · [All operations](https://skmtc.dev/azure/apis/maps-route/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/maps-route/revisions/7677b00a7f5a/schema)