Get locations — get_locations • frostr2

Get metadata for location names.

Usage

get_locations(
  names = NULL,
  geometry = NULL,
  fields = NULL,
  version = "v0",
  format = "jsonld",
  client = get_frost_client(),
  auth_type = c("basic", "oauth"),
  flatten = TRUE,
  return_response = FALSE
)

Arguments

names: character: Location name(s)
geometry: character: Sources defined by a specified geometry. Geometries are specified as either nearest(POINT(...)) or POLYGON(...) using well-known text representation for geometry (WKT).
fields: character: Fields to return in the response.
version: character: API version.
format: character: Response format.
client: list: List with client id and secret. Defaults to the `MET_FROST_ID` and `MET_FROST_SECRET` environment variables.
auth_type: character: Authentication method, either 'basic' or 'oauth'.
flatten: logical: If TRUE the response is transformed to a table.
return_response: logical: If TRUE a list of class `frost_api` is returned, including the raw `httr2_response`.

Details

Use the default query parameters to retrieve all location names.

Examples

if (FALSE) {
df <- get_locations()
}