Autosuggest API

Introduction

This endpoint suggests address or place candidates based on an incomplete or misspelled query, from which the user selects the best query to submit. NOTE: The response may contain experimental elements not documented here. Any undocumented element is subject to removal at any time.

Parameters

Loading...

Response Schema

Loading...

Query 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.

Examples

Sample API Request

1https://api.nextbillion.io/h/autosuggest?q=berl&key={{api_key}}

Sample API Response

1{
2  "items": [
3    {
4      "title": "string",
5      "id": "string",
6      "language": "string",
7      "politicalView": "string",
8      "resultType": "administrativeArea",
9      "houseNumberType": "PA",
10      "localityType": "postalCode",
11      "administrativeAreaType": "county",
12      "address": {
13        "label": "string",
14        "countryCode": "string",
15        "countryName": "string",
16        "stateCode": "string",
17        "state": "string",
18        "countyCode": "string",
19        "county": "string",
20        "city": "string",
21        "district": "string",
22        "subdistrict": "string",
23        "street": "string",
24        "block": "string",
25        "subblock": "string",
26        "postalCode": "string",
27        "houseNumber": "string",
28        "building": "string"
29      },
30      "distance": 172039,
31      "highlights": {
32        "title": [
33          {
34            "start": 0,
35            "end": 0
36          }
37        ]
38      },
39      "streetInfo": [
40        {
41          "baseName": "string",
42          "streetType": "string",
43          "streetTypePrecedes": true,
44          "streetTypeAttached": true,
45          "prefix": "string",
46          "suffix": "string",
47          "direction": "string",
48          "language": "string"
49        }
50      ]
51    }
52  ]
53}

API Error Codes

Response CodeDescriptionAdditional Notes
200Normal success case.Normal success case.
400Input validation failed.Such as missing parameter or parameter with invalid value type (for example value cannot be parsed into number).
401APIKEY not supplied or invalid.-
403APIKEY 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.
404Requested host/path not found.This error occurs when there is a malformed host name used.
422Could not process the request.There is an underlying map issue which prevents the processing of the request.
429Too many requests.QPM reached or something like distance matrix size quota reached.
500Internal Service error.There was an internal issue with Nextbillion.ai services. You can reach out to [email protected] for an explanation.
Autocomplete
DIDN'T FIND WHAT YOU LOOKING FOR?