Browse API
Introduction
This API provides search results for places based on different filters, such as categories or name, ranked by distance from a given search center. The only mandatory elements exposed in the response are id and position. The other elements shown in the response samples section are only dataset attribute suggestions.
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/browse?key={{api_key}}&q=market%20st&limit=2&in=countryCode:USA,MEXSample API Response
1{
2 "items": [
3 {
4 "title": "Market St, Philadelphia, PA 19106, United States",
5 "id": "here:af:street:x7-LwaZKEqfmPp3XN9Gh1D",
6 "resultType": "street",
7 "address": {
8 "label": "Market St, Philadelphia, PA 19106, United States",
9 "countryCode": "USA",
10 "countryName": "United States",
11 "stateCode": "PA",
12 "state": "Pennsylvania",
13 "county": "Philadelphia",
14 "city": "Philadelphia",
15 "street": "Market St",
16 "postalCode": "19106"
17 },
18 "position": {
19 "lat": 39.95086,
20 "lng": -75.15134
21 },
22 "mapView": {
23 "west": -75.16263,
24 "south": 39.94947,
25 "east": -75.14002,
26 "north": 39.95244
27 },
28 "scoring": {
29 "queryScore": 1.0,
30 "fieldScore": {
31 "streets": [1.0]
32 }
33 }
34 },
35 {
36 "title": "Market St, San Francisco, CA 94102, United States",
37 "id": "here:af:street:VhS6IWwjk10vNjLE2atzXA",
38 "resultType": "street",
39 "address": {
40 "label": "Market St, San Francisco, CA 94102, United States",
41 "countryCode": "USA",
42 "countryName": "United States",
43 "stateCode": "CA",
44 "state": "California",
45 "county": "San Francisco",
46 "city": "San Francisco",
47 "street": "Market St",
48 "postalCode": "94102"
49 },
50 "position": {
51 "lat": 37.77379,
52 "lng": -122.42101
53 },
54 "mapView": {
55 "west": -122.44491,
56 "south": 37.75006,
57 "east": -122.39479,
58 "north": 37.7945
59 },
60 "scoring": {
61 "queryScore": 1.0,
62 "fieldScore": {
63 "streets": [1.0]
64 }
65 }
66 }
67 ]
68}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. |
