ohsome_get_metadata: GET metadata from ohsome API

In ohsome: An 'ohsome API' Client

GET metadata from ohsome API

Description

Returns parsed metadata from ohsome API

Usage

ohsome_get_metadata(quiet = FALSE)

Arguments

quiet

logical; suppresses message on data attribution, API version and temporal extent.

Details

ohsome_get_metadata() sends a GET request to the metadata endpoint of ohsome API and parses the response. The parsed metadata is silently returned.

Value

An ohsome_metadata object. This is a named list with the attributes date, status_code (of the GET request) and the following list elements:

• attribution: character; url and text of OSM data copyrights and attribution

• apiVersion: character; Version of the ohsome API

• timeout: numeric; limit of the processing time in seconds

• extractRegion:

  • spatialExtent: sfc_POLYGON; spatial boundary of the OSM data in the underlying OSHDB

  • temporalExtent: vector of ISO 8601 character; start and end of the temporal extent of OSM data in the underlying OSHDB

  • replicationSequenceNumber: numeric; precise state of the OSM data contained in the underlying OSHDB, expressed as the id of the last applied (hourly) diff file from Planet OSM

See Also

ohsome API Endpoints – Metadata

Examples

## Not run: 
ohsome_get_metadata()

## End(Not run)

ohsome documentation built on Aug. 30, 2023, 5:18 p.m.