Skip to main content

Search Box API

The Mapbox Search Box API is the easiest way to add interactive location search to connected cars, micro-mobility services, delivery apps, and more. Search Box API supports interactive location search or stand-alone queries to search addresses, places, and points of interest.

Client Libraries and SDKs

Mapbox search client libraries and SDKs combine the power of the Search Box API with a ready-to-use interactive search UI. Learn how to add robust location search to your web or mobile application:

Search Box API Endpoints

The Search Box API includes following endpoints to support various location search use cases:

With the Search Box API, developers can create an autocomplete search experience that makes it easier for users to find not only addresses, but also points of interest (POIs), categories of POIs, street names, neighborhoods, localities, place names, districts, postcodes, regions, and countries.

The /suggest endpoint is used in combination with the /retrieve endpoint to create an interactive search experience for end users. Within your application, send user search queries to the /suggest endpoint to get suggested results for the given search query.

When a user selects a result on the application UI, you should trigger a /retrieve request to get detailed information about the selection.

Get suggested results

get
https://api.mapbox.com/search/searchbox/v1/suggest?q={search_text}

This endpoint provides a list of suggested search results for the user query. This endpoint, along with the /retrieve endpoint, can be used to add autocomplete search functionality to your applications.

Required parametersTypeDescription
qstringThe user's query string. The query is limited to 256 characters.
access_tokenstringA Mapbox access token with default permissions.
session_tokenstringA customer-provided session token value, which groups a series of requests together for billing purposes. UUIDv4 is recommended. For more information on how session_token is used to group Search API calls into one session, see the Session-based pricing section of this documentation.

You can further refine the results of a query to this endpoint with the following optional parameters:

Optional parametersTypeDescription
languagestringThe ISO language code to be returned. If not provided, the default is English.
limitintegerThe number of results to return, up to 10.
proximitystringBias the response to favor results that are closer to a specific location. Provide either ip to get results closest to the user's IP location or provide two comma-separated coordinates in longitude,latitude order. If not provided, the default is IP proximity. When both proximity and origin are provided, origin is interpreted as the target of a route, while proximity indicates the current user location.
originstringThe location from which to calculate distance, provided as two comma-separated coordinates in longitude,latitude order. When both proximity and origin are provided, origin is interpreted as the target of a route, while proximity indicates the current user location. This parameter is required for distance-to-target estimates, but may incur additional latency.
bboxstringLimit results to only those contained within the supplied bounding box. Bounding boxes should be supplied as four numbers separated by commas, in minimum longitude,minimum latitude,maximum longitude,maximum latitude order. The bounding box cannot cross the 180th meridian.
navigation_profilestringThe navigation routing profile to use. Available profiles are: driving, walking, and cycling.
routestringA polyline encoded linestring describing the route to be used for searching. This parameter enables searching along a route. Both polyline5 and polyline6 precision are accepted, but must be specified using the route_geometry parameter.
route_geometrystringPassed in conjunction with a route polyline describing its precision. Options are polyline or polyline6. If this parameter is not provided with a route, the default is polyline. Correct results depend on including the right route_geometry for the route provided.
sar_typestringThis indicates that the user intends to do a higher cost search-along-route request. This should be included when route is included and should have a value of isochrone.
time_deviationnumberMaximum detour in estimated minutes from route.
eta_typestringUsed to estimate the time of arrival from the location specified in origin or proximity. The only allowed value for this parameter is navigation. This parameter, along with navigation_profile and origin/proximity, is required for ETA calculations. ETA calculations will incur additional latency.
countrystringA comma-separated list of ISO 3166 alpha 2 country codes.
typesstringLimit results to one or more types of features, provided as a comma-separated list. Pass one or more of the type names as a comma separated list. If no types are specified, all possible types may be returned. Available types are: country, region, postcode, district, place, city, locality, neighborhood, street, address, poi, and category. See the Administrative unit types section for details about these types.
poi_categorystringLimit results to those that belong to one or more categories, provided as a comma-separated list.
poi_category_exclusionsstringA comma-separated list of canonical category names that limits POI results to those that are not part of the given categories.

Example request: Get suggested results

# Search for Michigan Stadium with limit=1

$ curl "https://api.mapbox.com/search/searchbox/v1/suggest?q=Michigan%20Stadium?language=en&limit=1&session_token=[GENERATED-UUID]&proximity=-83.748708,42.265837&country=US&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response: Get suggested results

The response to a request to the /suggest endpoint is an array of JSON suggestion objects. A suggestion will include a result name, address information, geographical context, and additional metadata when available (such as distance to proximity point). It does not include geographic coordinates. To get coordinates, make a call to the /retrieve endpoint with the mapbox_id provided in the /suggest result.

Using the limit parameter, you can increase the maximum number of results up to 10. Pagination is not available, but this feature may be added in a later release. There is not an option to customize the order of search results.

Each result object contains the following properties:

PropertyTypeDescription
suggestionsarray of objectsThe returned suggestion objects. See the table below for details on the properties contained in each suggestion object.
attributionstringThe attribution data for results.

Each suggestion object contains the following properties:

PropertyTypeDescription
namestring[required] The name of the feature.
name_preferredstring[optional] The preferred name of the feature, if different than name.
mapbox_idstring[required] The id to use with /retrieve to get full feature details.
feature_typestring[required] The type of the result. For POIs, this will be poi. For categories, this will be category. For address-type results, the global context hierarchy is used (country, region, postcode, district, place, locality, neighborhood, address). See the Administrative unit types section for details about these types.
addressstring[optional] The address of the result containing the address number and street.
full_addressstring[optional] The full address of the result, which concatenates address and place_formatted.
place_formattedstring[required] A formatted string of result context comprised of the place, region, country, and postcode.
contextobject[required] The context of the feature. This context has layers that follow the Administrative unit types.
context.countryobject[optional] The country of the result. This layer includes properties id, name, country_code (the ISO_3166_1 alpha 2 code), and country_code_alpha_3 (the ISO_3166_1 alpha 3 code).
context.regionobject[optional] The region of the result. This layer includes properties id, name, region_code, and region_code_full (the ISO_3166_2 code).
context.postcodeobject[optional] The postcode of the result. This layer includes properties id and name.
context.districtobject[optional] The district of the result. This layer includes properties id and name.
context.placeobject[optional] The place of the result. This layer includes properties id and name.
context.localityobject[optional] The locality of the result. This layer includes properties id and name.
context.neighborhoodobject[optional] The neighborhood of the result. This layer includes properties id and name.
context.addressobject[optional] The address of the result including the address number and street. This layer includes properties id, name, address_number, street_name.
context.streetobject[optional] The street of the result. This layer includes properties id and name.
languagestring[required] An IETF language tag indicating the language of the result.
makistring[optional] A string representing an associated Maki icon to use for this result.
poi_categoryarray[optional] An array including the POI categories the result falls into, if it is a POI.
poi_category_idsarray[optional] An array including the canonical POI category IDs the result falls into, if it is a POI.
brandstring[optional] The brand name of the result, if it is a POI and is applicable.
brand_idstring[optional] The canonical brand ID of the result, if it is a POI and is applicable.
external_idsobject[optional] An object containing the IDs of the feature found in external databases, with the keys being the data source names and the values being the IDs.
metadataobject[optional] An object containing additional metadata for the feature, if applicable.
distancenumber[optional] An approximate distance to the origin location, in meters. If origin is not provided, it will show the approximate distance to the proximity location, in meters.
etanumber[optional] The estimated time of arrival from the origin point to the feature, in minutes. If origin is not provided, then this will be the estimated time of arrival from the proximity point to the feature, in minutes. Only provided when eta_type, navigation_profile and origin/proximity are used in the request. If an address is not on the road network, an ETA will not be provided.
added_distancenumber[optional] The distance added to an input route by including the given suggestion, in meters.
added_timenumber[optional] The estimated time added to an input route by including the given suggestion, in minutes.

Example responses: Get suggested results

{
"suggestions": [
{
"name": "Michigan Stadium",
"mapbox_id": "Example ID",
"feature_type": "poi",
"address": "1201 S Main St",
"full_address": "1201 S Main St, Ann Arbor, Michigan 48104, United States of America",
"place_formatted": "Ann Arbor, Michigan 48104, United States of America",
"context": {
"country": {
"name": "United States of America",
"country_code": "US",
"country_code_alpha_3": "USA"
},
"region": {
"name": "Michigan",
"region_code": "MI",
"region_code_full": "US-MI"
},
"postcode": { "name": "48104" },
"place": { "name": "Ann Arbor" },
"neighborhood": { "name": "South Main" },
"street": { "name": "s main st" }
},
"language": "en",
"maki": "marker",
"poi_category": ["track", "sports"],
"poi_category_ids": ["track", "sports"],
"external_ids": {
"safegraph": "Example ID",
"foursquare": "Example ID"
},
"metadata": {}
}
],
"attribution": "© 2023 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service. (https://www.mapbox.com/about/maps/)"
}

Retrieve a suggested feature

The /retrieve endpoint provides detailed information about a feature including geographic coordinates. In a search session, this endpoint is called when the user selects an item from the suggested results provided by /suggest endpoint. For more details, see the Retrieve a suggested feature section of this documentation.

get
https://api.mapbox.com/search/searchbox/v1/retrieve/{id}

After a successful call to the /suggest endpoint, you will use the ID contained in a suggestion's mapbox_id property to retrieve detailed information about the feature.

Required parametersTypeDescription
access_tokenstringA Mapbox access token with default permissions.
session_tokenstringA customer-provided session token value, which groups a series of requests together for billing purposes. UUIDv4 is recommended. For more information on how session_token is used to group Search API calls into one session, see the Session-based pricing section of this documentation.
Optional parametersTypeDescription
languagestringThe ISO language code to be returned. If not provided, the default is English.
attribute_setsstringA comma-separated list of attribute sets which describe the level of metadata that will be returned. Valid options are basic, photos, venue, visit.

Example request: Retrieve a suggested feature

# Retrieve a suggested feature

$ curl "https://api.mapbox.com/search/searchbox/v1/retrieve/{id}?session_token=[GENERATED-UUID]&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response: Retrieve a suggested feature

The /retrieve endpoint returns a GeoJSON FeatureCollection.

PropertyTypeDescription
typestringThis will always be "FeatureCollection".
featuresarray of objectsThe returned feature objects. See the table below for details on the properties contained by each feature object.
attributionstringThe attribution data for results.

Each feature in the response body contains the following properties:

PropertyTypeDescription
typestring[required] This will always be "Feature".
geometryobject[required] An object describing the spatial geometry of the returned feature.
geometry.coordinatesarray[required] The coordinates of the feature, formatted as [longitude,latitude].
geometry.typestring[required] This will always be "Point".
propertiesobject[required] The specific properties associated with the returned feature.
properties.namestring[required] The name of the feature.
properties.name_preferredstring[optional] The preferred name of the feature, if different than properties.name.
properties.mapbox_idstring[required] The ID associated with the feature.
properties.feature_typestring[required] The type of the result. For POIs, this will be poi. For address-type results, the global context hierarchy is used (country, region, postcode, district, place, locality, neighborhood, address). See the Administrative unit types section for details about these types.
properties.addressstring[optional] The address of the result containing the address number and street.
properties.full_addressstring[optional] The full address of the result, which concatenates properties.address and properties.place_formatted.
properties.place_formattedstring[optional] A formatted string of result context comprised of the place, region, country, and postcode. It is the part of the result which comes after address.
properties.contextobject[required] The context of the feature.
properties.context.countryobject[optional] The country of the result. This layer includes properties id, name, country_code (the ISO_3166_1 alpha 2 code), and country_code_alpha_3 (the ISO_3166_1 alpha 3 code).
properties.context.regionobject[optional] The region of the result. This layer includes properties id, name, region_code, and region_code_full (the ISO_3166_2 code).
properties.context.postcodeobject[optional] The postcode of the result. This layer includes properties id and name.
properties.context.districtobject[optional] The district of the result. This layer includes properties id and name.
properties.context.placeobject[optional] The place of the result. This layer includes properties id and name.
properties.context.localityobject[optional] The locality of the result. This layer includes properties id and name.
properties.context.neighborhoodobject[optional] The neighborhood of the result. This layer includes properties id and name.
properties.context.addressobject[optional] The address of the result including the address number and street. This layer includes properties id, name, address_number, and street_name.
properties.context.streetobject[optional] The street of the result. This layer includes properties id and name.
properties.coordinatesobject[required] The geographical coordinates of the result.
properties.coordinates.longitudenumber[required] The longitudinal coordinate of the result.
properties.coordinates.latitudenumber[required] The latitudinal coordinate of the result.
properties.coordinates.accuracystring[optional] The accuracy of the geographical coordinate of the result. This is only available for address-type results and the options are rooftop, parcel, point, interpolated, intersection, approximate, and street.
properties.coordinates.routable_pointsarray[optional] An array of objects containing information about the feature's routable points. A routable point object contains properties name, latitude, and longitude, and an optional note.
properties.bboxarray[optional] A bounding box in the format minimum longitude,minimum latitude,maximum longitude,maximum latitude.
properties.languagestring[optional] An IETF language tag indicating the language of the result.
properties.makistring[optional] A string representing an associated Maki icon to use for this result.
properties.poi_categoryarray[optional] An array including the POI categories the result falls into, if it is a POI.
properties.poi_category_idsarray[optional] An array including the canonical POI category IDs the result falls into, if it is a POI.
properties.brandstring[optional] The brand name of the result, if it is a POI and is applicable.
properties.brand_idstring[optional] The canonical brand ID of the result, if it is a POI and is applicable.
properties.external_idsobject[optional] An object containing the IDs of the feature found in external databases, with the keys being the data source names and the values being the IDs.
properties.metadataobject[optional] An object containing additional metadata for the feature, if applicable.

Example responses: Retrieve a suggested feature

{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": { "coordinates": [-83.748708, 42.265837], "type": "Point" },
"properties": {
"name": "Michigan Stadium",
"mapbox_id": "Example ID",
"feature_type": "poi",
"address": "1201 S Main St",
"full_address": "1201 S Main St, Ann Arbor, Michigan 48104, United States of America",
"place_formatted": "Ann Arbor, Michigan 48104, United States of America",
"context": {
"country": {
"name": "United States of America",
"country_code": "US",
"country_code_alpha_3": "USA"
},
"region": {
"name": "Michigan",
"region_code": "MI",
"region_code_full": "US-MI"
},
"postcode": { "name": "48104" },
"place": { "name": "Ann Arbor" },
"neighborhood": { "name": "South Main" },
"street": { "name": "s main st" }
},
"coordinates": {
"latitude": 42.265837,
"longitude": -83.748708,
"routable_points": [
{
"name": "default",
"latitude": 42.265837,
"longitude": -83.748708
}
]
},
"maki": "marker",
"poi_category": ["track", "sports"],
"poi_category_ids": ["track", "sports"],
"external_ids": {
"safegraph": "Example ID",
"foursquare": "Example ID"
},
"metadata": {}
}
}
],
"attribution": "© 2023 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service. (https://www.mapbox.com/about/maps/)"
}

Search Request

Search Box API enables developers to send one-off search requests and get relevant results. Developers can create search requests with the /forward endpoint and get a list of search results with coordinates and metadata. In contrast to Interactive Search, the /forward endpoint will not provide type-ahead suggestions, e.g., brand and category suggestions, but will only provide relevant search results.

Get search results

get
https://api.mapbox.com/search/searchbox/v1/forward?q={search_text}
Required parametersTypeDescription
qstringThe user's query string. The query string is limited to 256 characters.
access_tokenstringA Mapbox access token with default permissions.

You can further refine the results of a query to this endpoint with the following optional parameters:

Optional parametersTypeDescription
languagestringThe ISO language code to be returned. If not provided, the default is English.
limitintegerThe number of results to return, up to 10.
proximitystringBias the response to favor results that are closer to a specific location. Provide either ip to get results closest to the user's IP location or provide two comma-separated coordinates in longitude,latitude order. If not provided, the default is IP proximity. When both proximity and origin are provided, origin is interpreted as the target of a route, while proximity indicates the current user location.
bboxstringLimit results to only those contained within the supplied bounding box. Bounding boxes should be supplied as four numbers separated by commas, in minimum longitude,minimum latitude,maximum longitude,maximum latitude order. The bounding box cannot cross the 180th meridian.
navigation_profilestringThe navigation routing profile to use. Available profiles are: driving, walking, and cycling.
eta_typestringUsed to estimate the time of arrival from the location specified in origin or proximity. The only allowed value for this parameter is navigation. This parameter, along with navigation_profile and origin/proximity, is required for ETA calculations. ETA calculations will incur additional latency.
countrystringA comma-separated list of ISO 3166 alpha 2 country codes.
typesstringLimit results to one or more types of features, provided as a comma-separated list. Pass one or more of the type names as a comma separated list. If no types are specified, all possible types may be returned. Available types are: country, region, postcode, district, place, city, locality, neighborhood, street, address, poi, and category. See the Administrative unit types section for details about these types.
poi_categorystringLimit results to those that belong to one or more categories, provided as a comma-separated list.
poi_category_exclusionsstringA comma-separated list of canonical category names that limits POI results to those that are not part of the given categories.

Example requests: Search request


$ curl "https://api.mapbox.com/search/searchbox/v1/forward?q=34170%20Gannon%20Terrace&language=en&limit=1&proximity=-121.90662,37.42827&country=US&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

$ curl "https://api.mapbox.com/search/searchbox/v1/forward?q=新橋一丁十番一号,東京都港区新橋1丁目10番1号&language=ja&limit=1&proximity=13.38333,52.51667&country=JP&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response: Search request

The response to a request to the /forward endpoint is a GeoJSON FeatureCollection.

Using the limit parameter, you can increase the maximum number of results up to 10. Pagination is not available, but this feature may be added in a later release. There is not an option to customize the order of search results.

PropertyTypeDescription
typestringThis will always be "FeatureCollection".
featuresarray of objectsThe returned feature objects. See the table below for details on the properties contained by each feature object.
attributionstringThe attribution data for results.

Each feature in the response body contains the following properties:

PropertyTypeDescription
typestring[required] This will always be "Feature".
geometryobject[required] An object describing the spatial geometry of the returned feature.
geometry.coordinatesarray[required] The coordinates of the feature, formatted as [longitude,latitude].
geometry.typestring[required] This will always be "Point".
propertiesobject[required] The specific properties associated with the returned feature.
properties.namestring[required] The name of the feature.
properties.name_preferredstring[optional] The preferred name of the feature, if different than properties.name.
properties.mapbox_idstring[required] The ID associated with the feature.
properties.feature_typestring[required] The type of the result. For POIs, this will be poi. For address-type results, the global context hierarchy is used (country, region, postcode, district, place, locality, neighborhood, address). See the Administrative unit types section for details about these types.
properties.addressstring[optional] The address of the result containing the address number and street.
properties.full_addressstring[optional] The full address of the result, which concatenates properties.address and properties.place_formatted.
properties.place_formattedstring[optional] A formatted string of result context comprised of the place, region, country, and postcode. It is the part of the result which comes after address.
properties.contextobject[required] The context of the feature.
properties.context.countryobject[optional] The country of the result. This layer includes properties id, name, country_code (the ISO_3166_1 alpha 2 code), and country_code_alpha_3 (the ISO_3166_1 alpha 3 code).
properties.context.regionobject[optional] The region of the result. This layer includes properties id, name, region_code, and region_code_full (the ISO_3166_2 code).
properties.context.postcodeobject[optional] The postcode of the result. This layer includes properties id and name.
properties.context.districtobject[optional] The district of the result. This layer includes properties id and name.
properties.context.placeobject[optional] The place of the result. This layer includes properties id and name.
properties.context.localityobject[optional] The locality of the result. This layer includes properties id and name.
properties.context.neighborhoodobject[optional] The neighborhood of the result. This layer includes properties id and name.
properties.context.addressobject[optional] The address of the result including the address number and street. This layer includes properties id, name, address_number, and street_name.
properties.context.streetobject[optional] The street of the result. This layer includes properties id and name.
properties.coordinatesobject[required] The geographical coordinates of the result.
properties.coordinates.longitudenumber[required] The longitudinal coordinate of the result.
properties.coordinates.latitudenumber[required] The latitudinal coordinate of the result.
properties.coordinates.accuracystring[optional] The accuracy of the geographical coordinate of the result. This is only available for address-type results and the options are rooftop, parcel, point, interpolated, intersection, approximate, and street.
properties.coordinates.routable_pointsarray[optional] An array of objects containing information about the feature's routable points. A routable point object contains properties name, latitude, and longitude, and an optional note.
properties.bboxarray[optional] A bounding box in the format minimum longitude,minimum latitude,maximum longitude,maximum latitude.
properties.languagestring[optional] An IETF language tag indicating the language of the result.
properties.makistring[optional] A string representing an associated Maki icon to use for this result.
properties.poi_categoryarray[optional] An array including the POI categories the result falls into, if it is a POI.
properties.poi_category_idsarray[optional] An array including the canonical POI category IDs the result falls into, if it is a POI.
properties.brandstring[optional] The brand name of the result, if it is a POI and is applicable.
properties.brand_idstring[optional] The canonical brand ID of the result, if it is a POI and is applicable.
properties.external_idsobject[optional] An object containing the IDs of the feature found in external databases, with the keys being the data source names and the values being the IDs.
properties.metadataobject[optional] An object containing additional metadata for the feature, if applicable.

Example responses: Search request

{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [-122.059632, 37.561526],
"type": "Point"
},
"properties": {
"name": "34170 Gannon Terrace",
"mapbox_id": "dXJuOm1ieGFkcjpiNjg2YTY2MS0xZTU4LTRiYmEtYTJhNC1mODdkNTRhNjczZWI",
"feature_type": "address",
"address": "34170 Gannon Terrace",
"full_address": "34170 Gannon Terrace, Fremont, California 94555, United States",
"place_formatted": "Fremont, California 94555, United States",
"context": {
"country": {
"id": "dXJuOm1ieHBsYzpJdXc",
"name": "United States",
"country_code": "US",
"country_code_alpha_3": "USA"
},
"region": {
"id": "dXJuOm1ieHBsYzpCbVRz",
"name": "California",
"region_code": "CA",
"region_code_full": "US-CA"
},
"postcode": {
"id": "dXJuOm1ieHBsYzpFclN1N0E",
"name": "94555"
},
"district": {
"id": "dXJuOm1ieHBsYzpBMGJz",
"name": "Alameda County"
},
"place": {
"id": "dXJuOm1ieHBsYzpCdzdvN0E",
"name": "Fremont"
},
"neighborhood": {
"id": "dXJuOm1ieHBsYzo2dXpz",
"name": "Ardenwood"
},
"address": {
"id": "dXJuOm1ieGFkcjpiNjg2YTY2MS0xZTU4LTRiYmEtYTJhNC1mODdkNTRhNjczZWI",
"name": "34170 Gannon Terrace",
"address_number": "34170",
"street_name": "gannon terrace"
},
"street": {
"id": "dXJuOm1ieGFkcjpiNjg2YTY2MS0xZTU4LTRiYmEtYTJhNC1mODdkNTRhNjczZWI",
"name": "gannon terrace"
}
},
"coordinates": {
"latitude": 37.561526,
"longitude": -122.059632,
"accuracy": "rooftop",
"routable_points": [
{
"name": "default",
"latitude": 37.561366,
"longitude": -122.05968
}
]
},
"language": "en",
"maki": "marker",
"external_ids": {},
"metadata": {}
}
}
],
"attribution": "© 2023 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service. (https://www.mapbox.com/about/maps/)"
}
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [139.7596694, 35.6674972],
"type": "Point"
},
"properties": {
"name": "〒105-0004 東京都港区新橋1丁目10番1号",
"feature_type": "address",
"address": "〒105-0004 東京都港区新橋1丁目10番1号",
"full_address": "〒105-0004 東京都港区新橋1丁目10番1号, 〒105-0004 東京都港区新橋1丁目10番1号",
"place_formatted": "〒105-0004 東京都港区新橋1丁目10番1号",
"context": {
"postcode": {
"name": "105-0004"
},
"block": {
"name": "10"
},
"address": {
"id": "address",
"name": "〒105-0004 東京都港区新橋1丁目10番1号",
"address_number": "10番1号",
"street_name": "新橋1丁目"
},
"street": {
"name": "新橋1丁目"
}
},
"coordinates": {
"latitude": 35.6674972,
"longitude": 139.7596694,
"accuracy": "rooftop"
},
"language": "ja",
"maki": "marker",
"external_ids": {},
"metadata": {
"reading": {
"ja_kana": "トウキョウトミナトクシンバシ",
"ja_latin": "toukyouto minatoku shinbashi"
}
}
}
}
],
"attribution": "© 2023 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service. (https://www.mapbox.com/about/maps/)"
}

Category Search makes it possible to browse entire categories of results, like coffee shops, hotels, and bookstores around a specific location or along a route.

The /category endpoint provides a list of POIs for a given location. In a search use case, this endpoint is used to create hot-buttons to execute search for a specific category, for example a coffee button that surfaces all nearby coffee shops. For more details, see the Get category suggestions section of this documentation.

Retrieve POIs by category

get
https://api.mapbox.com/search/searchbox/v1/category/{canonical_category_id}

Use the Category Search endpoint if you want to query points of interest (POIs) results filtered by a category at a specific location or along a route. The endpoint will only return POIs with the specified category.

Examples how you can use the /category endpoint:

  • Find food around you (food_and_drink)
  • Find an Indian restaurant (indian_restaurant)
  • Find a gas station along a route (gas_station)
Required parametersTypeDescription
access_tokenstringA Mapbox access token with default permissions.

You can further refine the results of a query to this endpoint with the following optional parameters:

Optional parametersTypeDescription
languagestringThe ISO language code to be returned. If not provided, the default is English.
limitintegerThe number of results to return, up to 25.
proximitystringBias the response to favor results that are closer to a specific location. Provide either ip to get results closest to the user's IP location or provide two comma-separated coordinates in longitude,latitude order. If not provided, the default is IP proximity. When both proximity and origin are provided, origin is interpreted as the target of a route, while proximity indicates the current user location.
originstringThe location from which to calculate distance, provided as two comma-separated coordinates in longitude,latitude order. When both proximity and origin are provided, origin is interpreted as the target of a route, while proximity indicates the current user location. This parameter is required for distance-to-target estimates, but may incur additional latency.
bboxstringLimit results to only those contained within the supplied bounding box. Bounding boxes should be supplied as four numbers separated by commas, in minimum longitude,minimum latitude,maximum longitude,maximum latitude order. The bounding box cannot cross the 180th meridian.
navigation_profilestringThe navigation routing profile to use. Available profiles are: driving, walking, and cycling.
routestringA polyline encoded linestring describing the route to be used for searching. This parameter enables searching along a route. Both polyline5 and polyline6 precision are accepted, but must be specified using the route_geometry parameter.
route_geometrystringPassed in conjunction with a route polyline describing its precision. Options are polyline or polyline6. If this parameter is not provided with a route, the default is polyline. Correct results depend on including the right route_geometry for the route provided.
sar_typestringThis indicates that the user intends to do a higher cost search-along-route request. This should be included when route is included and should have a value of isochrone.
time_deviationnumberMaximum detour in estimated minutes from route.
eta_typestringUsed to estimate the time of arrival from the location specified in origin or proximity. The only allowed value for this parameter is navigation. This parameter, along with navigation_profile and origin/proximity, is required for ETA calculations. ETA calculations will incur additional latency.
countrystringA comma-separated list of ISO 3166 alpha 2 country codes.
typesstringLimit results to one or more types of features, provided as a comma-separated list. Pass one or more of the type names as a comma separated list. If no types are specified, all possible types may be returned. Available types are: country, region, postcode, district, place, city, locality, neighborhood, street, address, poi, and category. See the Administrative unit types section for details about these types.
poi_category_exclusionsstringA comma-separated list of canonical category names that limits POI results to those that are not part of the given categories.

Example request: Search for POIs by Category

# Search for POIs in the `coffee` category

$ curl -X GET "https://api.mapbox.com/search/searchbox/v1/category/coffee?access_token=YOUR_MAPBOX_ACCESS_TOKEN&language=en&limit=5&proximity=-122.41%2C39&bbox=-124.35526789303981%2C38.41262975705166%2C-120.52250410696067%2C39.54169087094499

Response: Search for POIs by category

The /category endpoints returns a GeoJSON FeatureCollection

PropertyTypeDescription
typestringThis will always be "FeatureCollection".
featuresarray of objectsThe returned feature objects. See the table below for details on the properties contained by each feature object.
attributionstringThe attribution data for results.

Each feature in the response body contains the following properties:

PropertyTypeDescription
typestring[required] This will always be "Feature".
geometryobject[required] An object describing the spatial geometry of the returned feature.
geometry.coordinatesarray[required] The coordinates of the feature, formatted as [longitude,latitude].
geometry.typestring[required] This will always be "Point".
propertiesobject[required] The specific properties associated with the returned feature.
properties.namestring[required] The name of the feature.
properties.name_preferredstring[optional] The preferred name of the feature, if different than properties.name.
properties.mapbox_idstring[required] The ID associated with the feature.
properties.feature_typestring[required] The type of the result. For POIs, this will be poi. For address-type results, the global context hierarchy is used (country, region, postcode, district, place, locality, neighborhood, address). See the Administrative unit types section for details about these types.
properties.addressstring[optional] The address of the result containing the address number and street.
properties.full_addressstring[optional] The full address of the result, which concatenates properties.address and properties.place_formatted.
properties.place_formattedstring[optional] A formatted string of result context comprised of the place, region, country, and postcode. It is the part of the result which comes after address.
properties.contextobject[required] The context of the feature.
properties.context.countryobject[optional] The country of the result. This layer includes properties id, name, country_code (the ISO_3166_1 alpha 2 code), and country_code_alpha_3 (the ISO_3166_1 alpha 3 code).
properties.context.regionobject[optional] The region of the result. This layer includes properties id, name, region_code, and region_code_full (the ISO_3166_2 code).
properties.context.postcodeobject[optional] The postcode of the result. This layer includes properties id and name.
properties.context.districtobject[optional] The district of the result. This layer includes properties id and name.
properties.context.placeobject[optional] The place of the result. This layer includes properties id and name.
properties.context.localityobject[optional] The locality of the result. This layer includes properties id and name.
properties.context.neighborhoodobject[optional] The neighborhood of the result. This layer includes properties id and name.
properties.context.addressobject[optional] The address of the result including the address number and street. This layer includes properties id, name, address_number, and street_name.
properties.context.streetobject[optional] The street of the result. This layer includes properties id and name.
properties.coordinatesobject[required] The geographical coordinates of the result.
properties.coordinates.longitudenumber[required] The longitudinal coordinate of the result.
properties.coordinates.latitudenumber[required] The latitudinal coordinate of the result.
properties.coordinates.accuracystring[optional] The accuracy of the geographical coordinate of the result. This is only available for address-type results and the options are rooftop, parcel, point, interpolated, intersection, approximate, and street.
properties.coordinates.routable_pointsarray[optional] An array of objects containing information about the feature's routable points. A routable point object contains properties name, latitude, and longitude, and an optional note.
properties.bboxarray[optional] A bounding box in the format minimum longitude,minimum latitude,maximum longitude,maximum latitude.
properties.languagestring[optional] An IETF language tag indicating the language of the result.
properties.makistring[optional] A string representing an associated Maki icon to use for this result.
properties.poi_categoryarray[optional] An array including the POI categories the result falls into, if it is a POI.
properties.poi_category_idsarray[optional] An array including the canonical POI category IDs the result falls into, if it is a POI.
properties.brandstring[optional] The brand name of the result, if it is a POI and is applicable.
properties.brand_idstring[optional] The canonical brand ID of the result, if it is a POI and is applicable.
properties.external_idsobject[optional] An object containing the IDs of the feature found in external databases, with the keys being the data source names and the values being the IDs.
properties.metadataobject[optional] An object containing additional metadata for the feature, if applicable.

Example response: Search for POIs by category

{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": { "coordinates": [-122.582748, 39.029528], "type": "Point" },
"properties": {
"name": "Stonehouse Cellars",
"mapbox_id": "CkIKQDRlNTdiODcxY2QyZjI0OGMwODNjZjE2Yzc1NTIyZDEyMjAyYzkzMmYzYTIwN2YwOTQ4ZDYxYjk1MTU5MmQ4ZjY=",
"feature_type": "poi",
"address": "500 Old Long Valley Rd",
"full_address": "500 Old Long Valley Rd, Clearlake Oaks, California 95423, United States of America",
"place_formatted": "Clearlake Oaks, California 95423, United States of America",
"context": {
"country": {
"name": "United States of America",
"country_code": "US",
"country_code_alpha_3": "USA"
},
"region": {
"name": "California",
"region_code": "CA",
"region_code_full": "US-CA"
},
"postcode": { "name": "95423" },
"place": { "name": "Clearlake Oaks" },
"street": { "name": "old long valley rd" }
},
"coordinates": {
"latitude": 39.029528,
"longitude": -122.582748,
"routable_points": [
{
"name": "default",
"latitude": 39.029528,
"longitude": -122.582748
}
]
},
"maki": "restaurant",
"poi_category": [
"restaurant",
"food",
"food and drink",
"winery",
"bar",
"nightlife"
],
"poi_category_ids": [
"restaurant",
"food",
"food_and_drink",
"winery",
"bar",
"nightlife"
],
"external_ids": { "foursquare": "55208bfe498e78a725b4030d" },
"metadata": { "primary_photo": [] }
}
}
],
"attribution": "© 2023 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service. (https://www.mapbox.com/about/maps/)"
}

List categories

The request to the /list/category endpoint will return a list of all the available categories with their canonical ID and name in the language you specified. This endpoint does not describe parent/child relationships and cannot be used to infer relationships between categories.

Get category list

get
https://api.mapbox.com/search/searchbox/v1/list/category
Required parametersTypeDescription
access_tokenstringA Mapbox access token with default permissions.
Optional parametersTypeDescription
languagestringThe ISO language code to be returned. If not provided, English (en) will be used as the default.

Example Request: Get category list


# Get category list

$ curl -X GET "https://api.mapbox.com/search/searchbox/v1/list/category?access_token=YOUR_MAPBOX_ACCESS_TOKEN&language=en"

Response: Get category list

The response will be a collection of category list items.

PropertyTypeDescription
list_itemsarray of objectsAn array of category objects
attributionstringThe attribution data for results.
versionstringThe service version information. Include this information if you report an issue to Mapbox.

Each item in list_items has the following properties:

PropertyTypeDescription
canonical_idstring[required] The canonical category ID to use in a category “Hot Button” search
iconstring[required] The Maki icon to use with the category
namestring[required] The category name in the requested language

Example response: Get category list

{
"listItems": [
{
"canonical_id": "services",
"icon": "marker",
"name": "Services",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "71fed985-aa4b-4e50-83f1-97e5a0a0751e"
},
{
"canonical_id": "shopping",
"icon": "marker",
"name": "Shopping",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "9d383df0-2f35-4932-9368-8cf0f488e701"
},
{
"canonical_id": "food_and_drink",
"icon": "marker",
"name": "Food and Drink",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "20dbf11b-a90d-4571-8996-a1ccbfbd8680"
},
{
"canonical_id": "food",
"icon": "restaurant",
"name": "Food",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "af0d6328-1e96-43d7-8925-decb4ed04a06"
},
{
"canonical_id": "restaurant",
"icon": "restaurant",
"name": "Restaurant",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "1a9e12e7-2e8d-47ee-9c3d-1aaa7ced55b6"
},
{
"canonical_id": "health_services",
"icon": "marker",
"name": "Health Services",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "f111ad81-9b4f-4346-b1dd-d7190a202276"
},
{
"canonical_id": "office",
"icon": "marker",
"name": "Office",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "8388a638-fdae-42f0-b3e7-ee1c1f786601"
},
{
"canonical_id": "education",
"icon": "marker",
"name": "Education",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "c530d2d8-ee87-4481-9289-088b97b796fa"
},
{
"canonical_id": "nightlife",
"icon": "marker",
"name": "Nightlife",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "ecd6c887-9952-45a1-848d-ee50177cb61d"
},
{
"canonical_id": "lodging",
"icon": "lodging",
"name": "Lodging",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629",
"uuid": "8de7b125-ac68-488f-b122-5c8b2706ff15"
}
],
"attribution": "© 2021 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service. (https://www.mapbox.com/about/maps/)",
"version": "25:6bd9b589a98b57a214d92076ecf35061eed6a629"
}

Reverse lookup

With Reverse lookup, you can get a list of addresses and POIs around a given coordinate (e,g, what is around 33.9416° N, 118.4085° W).

The /reverse endpoint allows you to look up a single pair of coordinates and returns the geographic feature or features that exist at that location.

Do a reverse lookup

get
https://api.mapbox.com/search/searchbox/v1/reverse?longitude={longitude}&latitude={latitude}
Required parametersTypeDescription
access_tokenstringA Mapbox access token with default permissions.
longitudenumberThe longitudinal coordinate of coordinate for the reverse query.
latitudenumberThe latitudinal coordinate of coordinate for the reverse query.

You can further refine the results of a query to this endpoint with the following optional parameters:

Optional parametersTypeDescription
languagestringThe ISO language code to be returned. If not provided, the default is English.
limitintegerThe number of results to return, up to 10.
countrystringA comma-separated list of ISO 3166 alpha 2 country codes.
typesstringLimit results to one or more types of features, provided as a comma-separated list. Pass one or more of the type names as a comma separated list. If no types are specified, all possible types may be returned. Available types are: country, region, prefecture, postcode, district, place, city, locality, oaza, block, street, and address. See the Administrative unit types section for details about these types.

Example request: do a reverse lookup

$ curl "https://api.mapbox.com/search/searchbox/v1/reverse?longitude=-118.471383&latitude=34.023653&language=de&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response: do a reverse lookup

The response to a request to the /reverse endpoint is a GeoJSON FeatureCollection.

PropertyTypeDescription
typestringThis will always be "FeatureCollection".
featuresarray of objectsThe returned feature objects. See the table below for details on the properties contained by each feature object.
attributionstringThe attribution data for results.

Each feature in the response body contains the following properties:

PropertyTypeDescription
typestring[required] This will always be "Feature".
geometryobject[required] An object describing the spatial geometry of the returned feature.
geometry.coordinatesarray[required] The coordinates of the feature, formatted as [longitude,latitude].
geometry.typestring[required] This will always be "Point".
propertiesobject[required] The specific properties associated with the returned feature.
properties.namestring[required] The name of the feature.
properties.name_preferredstring[optional] The preferred name of the feature, if different than properties.name.
properties.mapbox_idstring[required] The ID associated with the feature.
properties.feature_typestring[required] The type of the result. For POIs, this will be poi. For address-type results, the global context hierarchy is used (country, region, postcode, district, place, locality, neighborhood, address). See the Administrative unit types section for details about these types.
properties.addressstring[optional] The address of the result containing the address number and street.
properties.full_addressstring[optional] The full address of the result, which concatenates properties.address and properties.place_formatted.
properties.place_formattedstring[optional] A formatted string of result context comprised of the place, region, country, and postcode. It is the part of the result which comes after address.
properties.contextobject[required] The context of the feature.
properties.context.countryobject[optional] The country of the result. This layer includes properties id, name, country_code (the ISO_3166_1 alpha 2 code), and country_code_alpha_3 (the ISO_3166_1 alpha 3 code).
properties.context.regionobject[optional] The region of the result. This layer includes properties id, name, region_code, and region_code_full (the ISO_3166_2 code).
properties.context.postcodeobject[optional] The postcode of the result. This layer includes properties id and name.
properties.context.districtobject[optional] The district of the result. This layer includes properties id and name.
properties.context.placeobject[optional] The place of the result. This layer includes properties id and name.
properties.context.localityobject[optional] The locality of the result. This layer includes properties id and name.
properties.context.neighborhoodobject[optional] The neighborhood of the result. This layer includes properties id and name.
properties.context.addressobject[optional] The address of the result including the address number and street. This layer includes properties id, name, address_number, and street_name.
properties.context.streetobject[optional] The street of the result. This layer includes properties id and name.
properties.coordinatesobject[required] The geographical coordinates of the result.
properties.coordinates.longitudenumber[required] The longitudinal coordinate of the result.
properties.coordinates.latitudenumber[required] The latitudinal coordinate of the result.
properties.coordinates.accuracystring[optional] The accuracy of the geographical coordinate of the result. This is only available for address-type results and the options are rooftop, parcel, point, interpolated, intersection, approximate, and street.
properties.coordinates.routable_pointsarray[optional] An array of objects containing information about the feature's routable points. A routable point object contains properties name, latitude, and longitude, and an optional note.
properties.bboxarray[optional] A bounding box in the format minimum longitude,minimum latitude,maximum longitude,maximum latitude.
properties.languagestring[optional] An IETF language tag indicating the language of the result.
properties.makistring[optional] A string representing an associated Maki icon to use for this result.
properties.poi_categoryarray[optional] An array including the POI categories the result falls into, if it is a POI.
properties.poi_category_idsarray[optional] An array including the canonical POI category IDs the result falls into, if it is a POI.
properties.brandstring[optional] The brand name of the result, if it is a POI and is applicable.
properties.brand_idstring[optional] The canonical brand ID of the result, if it is a POI and is applicable.
properties.external_idsobject[optional] An object containing the IDs of the feature found in external databases, with the keys being the data source names and the values being the IDs.
properties.metadataobject[optional] An object containing additional metadata for the feature, if applicable.

Example response: do a reverse lookup

{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": { "coordinates": [13.3295589, 52.5125463], "type": "Point" },
"properties": {
"name": "Straße Des 17. Juni 115",
"mapbox_id": "dXJuOm1ieGFkcjo2YjU1MDMxMy1iNzM0LTQxNjYtYjk0MC0zZTU1MTE4MmQwOGY",
"feature_type": "address",
"address": "Straße Des 17. Juni 115",
"full_address": "Straße Des 17. Juni 115, 10623 Berlin, Germany",
"place_formatted": "10623 Berlin, Germany",
"context": {
"country": {
"id": "dXJuOm1ieHBsYzpJam8",
"name": "Germany",
"country_code": "DE",
"country_code_alpha_3": "DEU"
},
"postcode": { "id": "dXJuOm1ieHBsYzpVYTQ2", "name": "10623" },
"place": { "id": "dXJuOm1ieHBsYzpBY1E2", "name": "Berlin" },
"locality": {
"id": "dXJuOm1ieHBsYzpBd1pxT2c",
"name": "Charlottenburg"
},
"address": {
"id": "dXJuOm1ieGFkcjo2YjU1MDMxMy1iNzM0LTQxNjYtYjk0MC0zZTU1MTE4MmQwOGY",
"name": "Straße Des 17. Juni 115",
"address_number": "Straße",
"street_name": "Des 17. Juni 115"
},
"street": { "name": "Des 17. Juni 115" }
},
"coordinates": {
"latitude": 52.5125463,
"longitude": 13.3295589,
"accuracy": "rooftop",
"routable_points": [
{
"name": "default",
"latitude": 52.51264818693428,
"longitude": 13.32955240836938
}
]
},
"language": "en",
"maki": "marker",
"external_ids": {},
"metadata": {}
}
}
],
"attribution": "© 2023 Mapbox and its suppliers. All rights reserved. Use of this data is subject to the Mapbox Terms of Service. (https://www.mapbox.com/about/maps/)"
}

Administrative unit types

Various types of administrative units are available via the Search Box API. Any type might appear as a top-level response, as context in a top-level response, or as a filtering option using the optional types parameter. See the following table for available administrative unit types.

Administrative unit typeDescription
countryGenerally recognized countries or, in some cases like Hong Kong, an area of quasi-national administrative status that has a designated country code under ISO 3166-1.
regionTop-level sub-national administrative features, such as states in the United States or provinces in Canada or China.
postcodePostal codes used in country-specific national addressing systems.
districtFeatures that are smaller than top-level administrative features but typically larger than cities, in countries that use such an additional layer in postal addressing (for example, prefectures in China).
placeTypically these are cities, villages, municipalities, etc. They’re usually features used in postal addressing, and are suitable for display in ambient end-user applications where current-location context is needed (for example, in weather displays).
localityOfficial sub-city features present in countries where such an additional administrative layer is used in postal addressing, or where such features are commonly referred to in local parlance. Examples include city districts in Brazil and Chile and arrondissements in France.
neighborhoodColloquial sub-city features often referred to in local parlance. Unlike locality features, these typically lack official status and may lack universally agreed-upon boundaries. Not available for reverse lookup requests.
streetThe street, with no house number.
addressIndividual residential or business addresses as a street with house number.

Language and Geography Support

Supported languages

The Search Box API supports text queries in following languages; Czech, Croatian, Danish, Dutch, English, Estonian, Finnish, French, German, Greek, Hungarian, Italian, Japanese, Lithuanian, Latvian, Polish, Portuguese, Romanian, Russian, Slovak, Slovenian, Spanish, Swedish, Turkish, Ukrainian.

You can set a language by providing supported IETF language tags to the language API parameter. You can also provide a comma separated list of language codes. In this case, the first supported language encountered in the list will be used to process the request.

Supported geographies

The Search Box API supports United States, Canada and Europe.

Search Box API errors

Response body messageHTTP error codeDescription
Not authorized401Check the access token used in the query.
Bad request400Check the request for syntax errors in the endpoint, path parameters, and query parameters.
Forbidden403There may be an issue with your account. Check your Account page for more details.

In some cases, using an access tokens with URL restrictions can also result in a 403 error. For more information, see our Token management guide.

Search Box API restrictions and limits

  • The Mapbox Terms of Service state that all data returned by the Search Box API endpoints is only available for temporary use. If your use case requires storing position data, contact Mapbox sales.
  • The default rate limit for the Mapbox Search Box API is 10 requests per second. If you require a higher rate limit, contact Mapbox Sales.
  • Calls to the Search Box API's /suggest and /retrieve endpoints must include a session_token parameter. Each API call in a search session counts individually against the rate limit. For example, 10 sequential calls to /suggest with the same session_token and one call to /retrieve are 11 requests per the rate limit, but are billed as belonging to a single session. See more about how the Search Box API is billed in the Session Billing section of this documentation.

Search Box API pricing

Pricing for the Mapbox Search Box API is based on which API endpoints are used. If you are using the /suggest or /retrieve endpoints, usage will be billed per search session. If you are using the /category or /reverse endpoints, usage will be billed per request.

For more details, review Mapbox Search Pricing.

Session Billing

A Search Session is a series of Search API calls bundled together for billing purposes. The Search Box API's /suggest and /retrieve endpoints must include a session_token parameter. The session_token parameter is used to group a series of requests together into one session for billing purposes.

A session ends after the following actions:

  • Make a call to /suggest followed by a call to /retrieve with a common session_token.
  • Make 50 successive calls to /suggest with a common session_token but are not followed by a call to /retrieve.
  • Make a call to /suggest and 60 minutes pass without being followed by a call to /retrieve.

Documentation for Mapbox Search API (earlier release) is available at https://docs.mapbox.com/search/search/.

Was this page helpful?