Limit geocoder results to a named region | Mapbox GL JS

This example uses the mapbox-gl-geocoder control to enable users to search for places using Mapbox Geocoding API, limiting search results to a region.

When it uses map.addControl to add the control to the map, it creates a MapboxGeocoder object and defines restrictions for search results by using the optional parameters countries, bbox, and filter.

Search for a place like Starbucks to see search results restricted to the specified region, New South Wales in Australia.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Limit geocoder results to a named region</title>
<meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
<link href="https://api.mapbox.com/mapbox-gl-js/v3.2.0/mapbox-gl.css" rel="stylesheet">
<script src="https://api.mapbox.com/mapbox-gl-js/v3.2.0/mapbox-gl.js"></script>
<style>
body { margin: 0; padding: 0; }
#map { position: absolute; top: 0; bottom: 0; width: 100%; }
</style>
</head>
<body>
<script src="https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-geocoder/v5.0.0/mapbox-gl-geocoder.min.js"></script>
<link rel="stylesheet" href="https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-geocoder/v5.0.0/mapbox-gl-geocoder.css" type="text/css">

<div id="map"></div>

<script>
	// TO MAKE THE MAP APPEAR YOU MUST
	// ADD YOUR ACCESS TOKEN FROM
	// https://account.mapbox.com
	mapboxgl.accessToken = 'YOUR_MAPBOX_ACCESS_TOKEN';
    const map = new mapboxgl.Map({
        container: 'map',
        // Choose from Mapbox's core styles, or make your own style with Mapbox Studio
        style: 'mapbox://styles/mapbox/satellite-streets-v12',
        center: [146.359, -32.648],
        zoom: 4
    });

    map.addControl(
        new MapboxGeocoder({
            accessToken: mapboxgl.accessToken,

            // Limit seach results to Australia.
            countries: 'au',

            // Use a bounding box to further limit results
            // to the geographic bounds representing the
            // region of New South Wales.
            bbox: [139.965, -38.03, 155.258, -27.839],

            // Apply a client-side filter to further limit results
            // to those strictly within the New South Wales region.
            filter: function (item) {
                // returns true if item contains New South Wales region
                return item.context.some((i) => {
                    // ID is in the form {index}.{id} per https://github.com/mapbox/carmen/blob/master/carmen-geojson.md
                    // This example searches for the `region`
                    // named `New South Wales`.
                    return (
                        i.id.split('.').shift() === 'region' &&
                        i.text === 'New South Wales'
                    );
                });
            },
            mapboxgl: mapboxgl
        })
    );
</script>

</body>
</html>

Was this example helpful?