Specific Provider Usage
Each provider has its own options, parameters or results because of its specific features.
- Chain (special provider)
- OpenStreetMap (Nominatim)
- OpenCage
- Google Maps (Geocoding API)
- LocationIQ
- Mapbox
- MapQuest
- Bing Maps
- Yandex
- GeoPlugin
Here is a table listing the parameters according to the providers:
Option, Method or Result | Parameter | Description | Provider |
---|---|---|---|
option | countryCodes | Restrict the results to one or more countries | Google Maps, LocationIQ, Mapbox, Nominatim, OpenCage |
option | method | HTTP method to use when executing the query | MapQuest |
option | clientId | To use a client ID instead of the API key | Google Maps |
option | secret | URL signing secret to use to digitally sign the request | Google Maps |
option | source | Source to use | LocationIQ, Mapbox, MapQuest |
option | userAgent | User-Agent identifying your application | Nominatim |
option | referer | Referer for the request | Nominatim |
option | host | Host to use | Nominatim |
geocode | countryCodes | Restrict the results to one or more countries | Google Maps, LocationIQ, Mapbox, Nominatim, OpenCage |
geocode | bounded | Restrict the results to items within the bounds | LocationIQ, Nominatim, Yandex |
geocode | proximity | Bias or filter the response to favor results that are closer to the specified location | Mapbox, OpenCage, Yandex |
geocode | fuzzyMatch | Should approximate the request terms or do an exact matching | Mapbox |
geocode | span | Bias or filter the response to favor results that are closer to the specified span | Yandex |
geocode | minPrecision | Only results with at least this precision will be returned | OpenCage |
geocode | components | Filter the results by components | Google Maps |
geocode | types | Filter the results to a subset of location types | Mapbox |
geocode | excludePlaceIds | For excluding some locations from the results | LocationIQ, Nominatim |
geocode | skip | Number of items to skip in the response | Yandex |
geocode | dedupe | Remove the duplicates | LocationIQ, Nominatim |
geocode | noRecord | Ask for the query to not be logged | OpenCage |
geocode | shape | Add the shape (geometry) to the results | Nominatim |
geocode | shapeThreshold | Tolerance for simplifying the returned shape | Nominatim |
geocode | channel | Channel to use for the request | Google Maps |
geodecode | countryCodes | Restrict the results to one or more countries | Mapbox, OpenCage |
geodecode | minPrecision | Only results with at least this precision will be returned | OpenCage |
geodecode | precisions | Restrict the results by the given precisions | Google Maps |
geodecode | types | Filter the results by location types | Google Maps, Mapbox, Yandex |
geodecode | zoom | Level of details required for the address | LocationIQ, Nominatim |
geodecode | reverseMode | How results are sorted | Mapbox |
geodecode | skip | Number of items to skip in the response | Yandex |
geodecode | noRecord | Ask for the query to not be logged | OpenCage |
geodecode | shape | Add the shape (geometry) to the results | Nominatim |
geodecode | shapeThreshold | Tolerance for simplifying the returned shape | Nominatim |
geodecode | channel | Channel to use for the request | Google Maps |
geocoded | attribution | Credit information | Bing, GeoPlugin, LocationIQ, MapQuest, Nominatim |
geocoded | precision | Quality of the geocoding result | Bing, Google Maps, LocationIQ, MapQuest, Yandex |
geocoded | precisionCode | Quality code of the geocoding result | LocationIQ, MapQuest |
geocoded | precisionType | Quality code of the geocoding result | LocationIQ |
geocoded | distance | Distance between the input location and the result location | LocationIQ |
geocoded | callingCode | International telephone calling code for the country of the result | OpenCage |
geocoded | placeId | Unique identifier for the location | Google Maps, LocationIQ |
geocoded | osmId | Reference to the OpenStreetMap object | LocationIQ, Nominatim |
geocoded | osmType | Reference to the OpenStreetMap object | LocationIQ, Nominatim |
geocoded | mapUrl | URL to a static map thumbnail image for the location being geocoded | MapQuest |
geocoded | partialMatch | Indicate the geocoder did not return an exact match | Google Maps |
geocoded | streetAddress | Street number with the street name | Google Maps |
geocoded | displayName | Full comma-separated address | LocationIQ, Nominatim |
geocoded | categories | Categories of the location | LocationIQ, Nominatim |
geocoded | types | Types of the location | Google Maps, LocationIQ, Mapbox, Nominatim, Yandex |
geocoded | subLocalityLevels | Levels for the sublocality | Google Maps, LocationIQ, Nominatim |
geocoded | shape | Shape (geometry) of the result | Nominatim |
geocoded | flag | Emoji flag of the country of the result | OpenCage |
geocoded | mgrs | Military Grid Reference System code for the center point of the result | OpenCage |
geocoded | maidenhead | Maidenhead location reference for the center point of the result | OpenCage |
geocoded | geohash | Geohash for the center point of the result | OpenCage |
geocoded | what3words | Key words whose value is a 3 words address (3wa) | OpenCage |