get_api_query: Construct a geocoder API query

Description Usage Arguments Value See Also Examples

View source: R/query_factory.R

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

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

Arguments

method

method name (ie. 'census')

generic_parameters

universal 'generic' parameters

custom_parameters

custom api-specific parameters

Value

API parameters as a named list

See Also

query_api api_parameter_reference geo reverse_geo

Examples

1
2
3
4
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"))

tidygeocoder documentation built on Nov. 3, 2021, 1:08 a.m.