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.
Request Parameters
Loading..Response Schema
Loading..Examples
Let’s browse for “market” in San Francisco area.
Sample API Request
curl --location 'https://api.nextbillion.io/browse?categories=market&limit=2&in=countryCode:USA,MEX&at=37.78182,-122.45291&key=<your_api_key>'
Sample API Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
{{ "items": [ { "title": "Whole Foods Mkt", "id": "FrPIlYtjFL_GkJym9qtx0A", "address": { "label": "Whole Foods Mkt, 69 Stanyan Street, San Francisco, CA 94118, United States", "countryCode": "USA", "countryName": "United States", "stateCode": "CA", "state": "California", "county": "San Francisco", "city": "San Francisco", "street": "Stanyan Street", "postalCode": "94118", "houseNumber": "69" }, "scoring": { "queryScore": 1 }, "position": { "lat": 37.780383, "lng": -122.456272 }, "access": [ { "lat": 37.7801, "lng": -122.45596 } ], "distance": 335, "mapView": { "west": -122.45741, "south": 37.77948, "east": -122.45513, "north": 37.78128 }, "categories": [ { "id": "7332005", "name": "market, supermarkets hypermarkets", "primary": true } ], "contacts": [ { "phone": [ { "value": "+1 415-876-6740" } ] } ] }, { "title": "Trader Joe's", "id": "s4WyLPIdyuC8j5BBl4znKA", "address": { "label": "Trader Joe's, 3 Masonic Avenue, San Francisco, CA 94118, United States", "countryCode": "USA", "countryName": "United States", "stateCode": "CA", "state": "California", "county": "San Francisco", "city": "San Francisco", "street": "Masonic Avenue", "postalCode": "94118", "houseNumber": "3" }, "scoring": { "queryScore": 1 }, "position": { "lat": 37.783337, "lng": -122.44775 }, "access": [ { "lat": 37.7834, "lng": -122.44724 } ], "distance": 483, "mapView": { "west": -122.44889, "south": 37.78244, "east": -122.44661, "north": 37.78424 }, "categories": [ { "id": "7332005", "name": "market, supermarkets hypermarkets", "primary": true } ], "contacts": [ { "phone": [ { "value": "+1 415-346-9964" } ], "www": [ { "value": "www.traderjoes.com/" } ] } ] } ] }
API Query Limits
Nextbillion.ai allows a maximum rate limit of 2400 queries per minute or 40 queries/second for continuous requests.
API Error Codes
Response Code | Description | Additional Notes |
---|---|---|
200 | Normal success case. | Normal success case |
400 | Input validation failed. | There is a missing or an invalid parameter or a parameter with an invalid value type is added to the request. |
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 a malformed hostname is used. |
422 | Could not process the request. | Valid results could not be generated for the given parameters. Please modify the constraints/search query. |
429 | Too many requests. | QPM 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. |