This dataset contains the mapping that allows this package to use a universal syntax to specify parameters for different geocoder services. Note that latitude and longitude input parameters for reverse geocoding are not in this dataset and are instead handled directly by the reverse_geo function.
The generic_name column is a universal parameter name that is shared between services.
The api_name column is the parameter name for the given geocoder service specified by the
method column. When generic_name is missing
this means the parameter is specific to that geocoder service.
While the "census" and "google" services do not have a limit
argument in their APIs, tidygeocoder provides a passthrough so you can still
use the limit argument in geo and reverse_geo to limit the
number of results per input.
Note that some geocoder services only use the limit argument for forward geocoding.
Refer to API documentation of each service for more information.
Reference the documentation for geo and reverse_geo for more information.
Also reference vignette("tidygeocoder") for more details on constructing API queries.
api_parameter_referenceA tibble dataframe
Geocoder service name
Universal parameter name
Name of the parameter for the specified geocoder service
Default value of the parameter
Is the parameter required by the specified geocoder service?
The API documentation for each service is linked to below:
geo reverse_geo get_api_query query_api min_time_reference batch_limit_reference