Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

mapbox/search-playground

Repository files navigation

Mapbox Geocoder Playground Tool

We’ve updated our search playground: https://mapbox.com/search-playground/ Internal debugging? Use this link instead. The Mapbox Geocoder Playground Tool is used to test geocoder results for forward and reverse geocoding and experiment with query parameters

Using the playground

  • Use the text input area for querying.
  • Use image to see the geocoder results in a json format.
  • Use image to share the response.
  • Use image to open/close the Settings panel, where you can try out geocoding parameters.
  • Use image to report any issue related to this tool.
  • The image will open our geocoder documentation site.

Internal only:

  • Use image to open hecate
  • Use the osm link to open JOSM

The search bar is the equivalent of an API query. For a forward geocode, enter text or an address. For a reverse geocode, enter coordinates.

Forward Geocoding Enter a query in the search bar to get the coordinates and data about the feature.

Reverse Geocoding Click on the map to see the coordinates in the search bar and the features that match those coordinates will be returned in the suggestions list below the search bar.

Set query parameters Click the cog icon to open a GUI of the query parameters available in the geocoding API.

For more information, see the parameters section of the documentation.

Parameters available in the playground:

- Autocomplete
- Country filtering
- Type filtering
- Proximity biasing
- Results limit
- Language selection
- Strict mode for language

⚠️ Internal use only

  • Toggle between staging and production server.
  • Test geocoding layers.

What you cannot do...

❌ Use it as a permanent endpoint

Run it locally with parcel

yarn install
yarn build
yarn start

Deploying

Deploys are managed by updating the hey-pages & publisher-production branches. To deploy run the following:

git checkout publisher-production

git merge master

git push

[Internal only] Follow the #publisher channel in slack to watch for a successful build/publish.