Azure Maps Distance Matrix Async API out of region error

Question

Azure Maps Distance Matrix Async API out of region error

Arnab Animesh Das 10

The below mentioned request works with Azure Maps Distance Matrix Request synchronous API. But doesn't work with asynchronous API. Using synchronous API, I get proper distance matrix. But using asynchronous API, I get OUT_OF_REGION error. I am using 2025-01-01 version of the API.

Request:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
						72.0231125,
            22.4246468
          ],
          [
						74.1944529,
            17.4305762
          ]
        ]
      },
      "properties": {
        "pointType": "origins"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
						74.5697617,
            17.0466875
          ],
          [
						74.90918529999999,
            17.0381558
          ],
          [75.03775019999999, 17.1283837],
          [75.201229, 17.0715196]
        ]
      },
      "properties": {
        "pointType": "destinations"
      }
    }
  ],
    "traffic": "historical",
    "travelMode": "truck",
    "avoid": ["unpavedRoads"]
}

EDIT 1: I have added a few locations in the request. Some of them will appear in distance matrix as "out of region" in the async API, but will appear properly in sync API.

VSawhney 320 Microsoft External Staff

Hello Arnab Animesh Das,

Could you please let us know for which country or region are you using Azure Maps?
The asynchronous API has stricter region constraints. The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests.

The OUT_OF_REGION error may occur in case of API limitations, if in case your origins and destinations are not contained in an axis-aligned 400 km x 400 km bounding box.

API Limitations

Max matrix size	Max number of origins	Max number of destinations	Additional limits

2500	1000	1000	All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.
50,000	10,000	10,000	- `departAt` or `arriveAt` must be any. - `traffic` must be historical. - `optimizeRoute` must be fastest. - `travelMode` must be either driving or truck. - No other parameters can be used explicitly.

Ref doc: Post Route Matrix Async

Hope this helps. Thank you!

Manas Mohanty 3,125 Reputation points Microsoft External Staff

2025-04-21T12:16:17.25+00:00

Hi Arnab Animesh Das

Could you share a sample code for replicating the scenario at our side.

Thank you.
Arnab Animesh Das 10 Reputation points

2025-04-21T18:35:57.44+00:00

@VSawhney When creating the Azure Maps resource, I chose "East US". I am working with Indian coordinates but there is no option to select "India" as a region for Azure Maps.

This is part of the first Azure Maps trial example I prepared. I tried with two origin coordinates (both within India). In synchronous API, both the coordinates gave proper output. But when using asynchronous API it gave "out of region" error for one of the origins. The only difference between those two origins is that the one which failed in async was ~1000 kms. away, and the other one (which succeeded in both the cases) was ~120 kms. away.

In the provided request, I only gave the coordinates of that origin which failed.

I am trying to migrate my codebase from Bing Maps to Azure Maps. I guess I have to stick with synchronous API for now.

Also, the asynchronous API being region constrained doesn't make sense in my opinion. There should be an option whether we want faster processing or not. It should be an option, not a choice already made for the users.

Also, since async API is generating proper output for some Indian coordinates I don't think it is an issue of region constraints.
Arnab Animesh Das 10 Reputation points

2025-04-21T18:46:20.3466667+00:00
@Manas Mohanty

Steps to replicate:

Create an azure maps resource at "East US" location.

Using its subscription key, run the request I have provided using both Azure Maps synchronous and asynchronous API

Check the difference in outputs. (Ideally both should give same output.)

Sync URL: https://atlas.microsoft.com/route/matrix?&api-version=2025-01-01

Async URL: https://atlas.microsoft.com/route/matrix:async?api-version=2025-01-01

Hope this helps.

2 answers

Your answer

VSawhney 320 Reputation points Microsoft External Staff

2025-04-21T02:52:23.1133333+00:00

Hello Arnab Animesh Das,

Could you please let us know for which country or region are you using Azure Maps?
The asynchronous API has stricter region constraints. The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests.

The OUT_OF_REGION error may occur in case of API limitations, if in case your origins and destinations are not contained in an axis-aligned 400 km x 400 km bounding box.

API Limitations

Max matrix size Max number of origins Max number of destinations Additional limits

2500 1000 1000 All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.

50,000 10,000 10,000 - departAt or arriveAt must be any. - traffic must be historical. - optimizeRoute must be fastest. - travelMode must be either driving or truck. - No other parameters can be used explicitly.

Ref doc: Post Route Matrix Async

Hope this helps. Thank you!
Manas Mohanty 3,125 Reputation points Microsoft External Staff

2025-04-21T12:16:17.25+00:00

Hi Arnab Animesh Das

Could you share a sample code for replicating the scenario at our side.

Thank you.
Arnab Animesh Das 10 Reputation points

2025-04-21T18:35:57.44+00:00

@VSawhney When creating the Azure Maps resource, I chose "East US". I am working with Indian coordinates but there is no option to select "India" as a region for Azure Maps.

This is part of the first Azure Maps trial example I prepared. I tried with two origin coordinates (both within India). In synchronous API, both the coordinates gave proper output. But when using asynchronous API it gave "out of region" error for one of the origins. The only difference between those two origins is that the one which failed in async was ~1000 kms. away, and the other one (which succeeded in both the cases) was ~120 kms. away.

In the provided request, I only gave the coordinates of that origin which failed.

I am trying to migrate my codebase from Bing Maps to Azure Maps. I guess I have to stick with synchronous API for now.

Also, the asynchronous API being region constrained doesn't make sense in my opinion. There should be an option whether we want faster processing or not. It should be an option, not a choice already made for the users.

Also, since async API is generating proper output for some Indian coordinates I don't think it is an issue of region constraints.
Arnab Animesh Das 10 Reputation points

2025-04-21T18:46:20.3466667+00:00

@Manas Mohanty

Steps to replicate:

Create an azure maps resource at "East US" location.

Using its subscription key, run the request I have provided using both Azure Maps synchronous and asynchronous API

Check the difference in outputs. (Ideally both should give same output.)

Sync URL: https://atlas.microsoft.com/route/matrix?&api-version=2025-01-01

Async URL: https://atlas.microsoft.com/route/matrix:async?api-version=2025-01-01

Hope this helps.

Answer 1

Arnab Animesh Das 10

API Limitations

Expand table

Max matrix size	Max number of origins	Max number of destinations	Additional limits


2500	1000	1000	All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.
50,000	10,000	10,000	- `departAt` or `arriveAt` must be any. - `traffic` must be historical. - `optimizeRoute` must be fastest. - `travelMode` must be either driving or truck. - No other parameters can be used explicitly.

Answer:

It seems when using avoid parameter, it falls within the 1st category. So, all the places need to be within 400km x 400 km bounding box. That was causing the issue.

Once I removed that parameter from the request, the issue was fixed (as it came in the 2nd category where bounding box restriction is not there).

Faraz Siddiqui 260 Reputation points Microsoft Employee

2025-04-24T18:14:07.0933333+00:00

Hi Arnab,

I am from the Azure Maps Product team. It looks like you figured out the issue, and you are right it was due to the avoid param as it falls under the first category of the API limitation. The reason for having these restrictions is to support larger cell size in the matrix. If you provide more restrictions in your route, it limits the ability to compute large requests.

In most scenarios, we have seen our users calculate the cost matrix for optimization or planning and specifying restrictions like avoiding unpaved road when calculating route between the selected waypoints using the Route Directions API. Alternatively, you could breakdown your request into multiple calls if you want to use sync and specifying certain restrictions is important for your scenario.

Answer 2

IoTGirl 3,616 Microsoft Employee

The Matrix API call is designed for a matrix of co-ordinates. If you only have two, please just call the Route API and not the Matrix. See https://learn.microsoft.com/en-us/rest/api/maps/route/post-route-directions?view=rest-maps-2025-01-01&tabs=HTTP

Arnab Animesh Das 10 Reputation points

2025-04-22T05:04:49.9366667+00:00

It is just a sample to showcase the issue.

I have updated the question with more locations. Compare the output of sync API and async API.
IoTGirl 3,616 Reputation points Microsoft Employee

2025-04-22T16:22:56.85+00:00

I think you misread my guidance. Does the same issue occur with the Route API? In the back end, Distance Matrix calls the Route API BUT offers fewer "legs" so it could be that the route is too long in the one case over the other. Checking the route call should high light this difference. The ASYNC API offers higher volume options so often can be more constrained to meet that higher service item limit.

For example, in Bing Maps at one point this limit was 3 legs and was raised to 5 legs but then the number of points allowed in the matrix needs to be lessened.
Arnab Animesh Das 10 Reputation points

2025-04-23T04:10:29.18+00:00

Route API gives proper output with multiple maneuver points. But all of it has legindex as 0.

I think async matrix API can't generate proper output since the route length is 900 kms. But that should not happen.
Sampath 2,260 Reputation points Microsoft External Staff

2025-04-23T15:31:43.73+00:00

Hello @Arnab Animesh Das , requesting you check your private messages and reply there. Thank you.
IoTGirl 3,616 Reputation points Microsoft Employee

2025-04-24T01:26:12.77+00:00

Hi @Anonymous

You state "I think async matrix API can't generate proper output since the route length is 900 kms. But that should not happen". If the full 900km route is within the 400kmx400km bounding box then you might be correct but that is doubtful.

Essentially, your point is that this should not work in either case, is that correct?

Sincerely,

IoTGirl

Share via

Azure Maps Distance Matrix Async API out of region error

2 answers

Your answer