tidygeocoder (version 1.0.6)

get_api_query: Construct a geocoder API query

Description

The geocoder API query is created using universal "generic" parameters and optional api-specific "custom" parameters. Generic parameters are converted into api parameters using the api_parameter_reference dataset.

The query_api function executes the queries created by this function.

Usage

get_api_query(method, generic_parameters = list(), custom_parameters = list())

Value

API parameters as a named list

Arguments

method

the geocoding service name (ie. 'census')

generic_parameters

universal "generic" parameters

custom_parameters

custom api-specific parameters

See Also

query_api api_parameter_reference geo reverse_geo

Examples

get_api_query("osm", list(address = "Hanoi, Vietnam"))

get_api_query(
  "census", list(street = "11 Wall St", city = "NY", state = "NY"),
  list(benchmark = "Public_AR_Census2010")
)