Road Editor API

API Overview

Nextbillion.ai offers an innovative API for the proprietary Road Restrictions Tool (RRT). With RRT, users can effortlessly set up a variety of restrictions on their maps, including turn restrictions, speed limits, road closures, parking restrictions, and more. This powerful and proprietary platform enables users to enhance their maps with customized and detailed restrictions, providing a safer and more efficient navigation experience for drivers and pedestrians alike.

Enterprise Edition Only

The Nextbillion.ai Road Editor API is available only in a Enterprise plan. Please contact support if you wish to use this API and other premium services at [email protected].

The following endpoints are provided for users via the RRT API.

GET

List

Use this endpoint to get a paginated list of restrictions

/open/restrictions/list

Parameters

Request Parameters

Response Schema

Sample Request

1https://api.nextbillion.io/restriction_groups/list?limit=10&offset=0

GET

Get Restrictions By Bbox

This endpoint is used to fetch the list of restrictions using a bounding box.

/open/restrictions

Parameters

Request Parameters

Response Schema

Sample Request

1https://api.nextbillion.io/open/restrictions?minLat=0&minLon=0&maxLat=0&maxLon=0&restrictionType=closure&restrictionType=maxspeed&restrictionType=fixedspeed&restrictionType=parking&restrictionType=turn

GET

Get Restrictions By ID

This endpoint is used to fetch the list of restrictions using a Unique ID.

PATCH

Update a Restrictions Group

Update a specific restriction group based on provided ID.

/open/restrictions/{id}

Parameters

Request Parameters

Request Body

Sample Request

1curl -X 'PATCH'   'https://api.nextbillion.io/open/restrictions/32'   -H 'accept: */*'   -H 'Content-Type: application/json'   -d '{
2  "id": 0,
3  "name": "string",
4  "area": "string",
5  "status": "active",
6  "repeatOn": "Mo-Fr 07:00-09:00,17:00-19:00",
7  "comment": "string",
8  "startTime": 0,
9  "endTime": 0,
10  "mode": [
11    "0w"
12  ],
13  "restrictionType": [
14    "closure",
15    "maxspeed",
16    "fixedspeed",
17    "parking",
18    "turn"
19  ],
20  "segments": [
21    {
22      "from": 0,
23      "to": 0,
24      "coordinate": {
25        "lat": 1,
26        "lon": 1
27      }
28    }
29  ],
30  "turns": [
31    {
32      "from": 0,
33      "via": 0,
34      "to": 0,
35      "type": [
36        "no_u_turn",
37        "no_right_turn",
38        "no_left_turn"
39      ],
40      "coordinate": {
41        "lat": 1,
42        "lon": 1
43      }
44    }
45  ],
46  "highway": "string",
47  "speed": 0,
48  "speedLimit": 0,
49  "rate": 0,
50  "direction": [
51    "forward",
52    "backward",
53    "both"
54  ],
55  "state": "enabled",
56  "geofence": [
57    [
58      0,
59      1
60    ],
61    [
62      1,
63      2
64    ],
65    [
66      3,
67      4
68    ],
69    [
70      5,
71      6
72    ]
73  ]
74}'

DELETE

Delete a Restrictions By ID

Delete a specific restriction group.

POST

Create a new Restriction

Create a new restriction group.

/open/restrictions/{restrictionType}

Parameters

Request Body

Sample Request

1curl -X 'POST'       'https://api.nextbillion.io/open/restrictions/turn'       -H 'accept: */*'       -H 'Content-Type: application/json'       -d '{
2      "id": 0,
3      "name": "string",
4      "area": "string",
5      "status": "active",
6      "repeatOn": "Mo-Fr 07:00-09:00,17:00-19:00",
7      "comment": "string",
8      "startTime": 0,
9      "endTime": 0,
10      "mode": [
11        "0w"
12      ],
13      "restrictionType": [
14        "closure",
15        "maxspeed",
16        "fixedspeed",
17        "parking",
18        "turn"
19      ],
20      "segments": [
21        {
22          "from": 0,
23          "to": 0,
24          "coordinate": {
25            "lat": 1,
26            "lon": 1
27          }
28        }
29      ],
30      "turns": [
31        {
32          "from": 0,
33          "via": 0,
34          "to": 0,
35          "type": [
36            "no_u_turn",
37            "no_right_turn",
38            "no_left_turn"
39          ],
40          "coordinate": {
41            "lat": 1,
42            "lon": 1
43          }
44        }
45      ],
46      "highway": "string",
47      "speed": 0,
48      "speedLimit": 0,
49      "rate": 0,
50      "direction": [
51        "forward",
52        "backward",
53        "both"
54      ],
55      "state": "enabled",
56      "geofence": [
57        [
58          0,
59          1
60        ],
61        [
62          1,
63          2
64        ],
65        [
66          3,
67          4
68        ],
69        [
70          5,
71          6
72        ]
73      ]
74    }'

PUT

Set state of a Restriction

Set the state of a restriction by ID.

/open/restrictions/{id}/state

Parameters

Request Parameters

Request Body

Response Schema

Sample Request

1curl -X 'PUT'         'https://api.nextbillion.io/open/restrictions/3/state'         -H 'accept: */*'         -H 'Content-Type: application/json'         -d '{
2        "state": "enabled"
3      }'

RichGroupDTO

Query Limits

Generic Limits

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

Response Code	Description	Additional Notes
200	Normal success case.	Normal success case.
400	Input validation failed.	Such as missing parameter or parameter with invalid value type (for example value cannot be parsed into number).
401	APIKEY not supplied or invalid.	This error occurs when the wrong API key is passed in the request or the key is missing altogether
403	APIKEY is valid but does not have access to requested resources.	You might be querying for a geographical region which is not valid for your account, or requesting a service which is not enabled for you.
404	Requested host/path not found.	This error occurs when there is a malformed host name used.
422	Could not process the request.	There is an underlying map issue which prevents the processing of the request.
429	Too many requests.	QPM reached or API request count quota reached.
500	Internal Service error.	There was an internal issue with NextBillion.ai services. You can reach out to [email protected] for an explanation.

Road Editor API

API Overview

Parameters

Request Parameters

Response Schema

Sample Request

Parameters

Request Parameters

Response Schema

Sample Request

Parameters

Request Parameters

Response Schema

Sample Request

Parameters

Request Parameters

Request Body

Sample Request

Parameters

Request Parameters

Sample Request

Parameters

Request Body

Sample Request

Parameters

Request Parameters

Request Body

Response Schema

Sample Request

RichGroupDTO

Query Limits

Generic Limits

API Error Codes

PLATFORM

SOLUTIONS

RESOURCES

COMPANY

UNITED STATES

SINGAPORE