osm_capabilities: Capabilities of the API

In osmapiR: 'OpenStreetMap' API

Capabilities of the API

Description

Provide information about the capabilities and limitations of the current API.

Usage

osm_capabilities()

Details

API:

• version minimum and maximum are the API call versions that the server will accept.

• area maximum is the maximum area in square degrees that can be queried by API calls.

• tracepoints per_page is the maximum number of points in a single GPS trace. (Possibly incorrect)

• waynodes maximum is the maximum number of nodes that a way may contain.

• relationmember maximum is the maximum number of members that a relation may contain.

• changesets maximum_elements is the maximum number of combined nodes, ways and relations that can be contained in a changeset.

• changesets default_query_limit and maximum_query_limit are the default and maximum values of the limit parameter of osm_query_changesets().

• notes default_query_limit and maximum_query_limit are the default and maximum values of the limit parameter of notes bounding box queries (osm_read_bbox_notes()) and search (osm_search_notes()).

• The status element returns either online, readonly or offline for each of the database, API and GPX API. The database field is informational, and the API/GPX-API fields indicate whether a client should expect read and write requests to work (online), only read requests to work (readonly) or no requests to work (offline).

Policy:

• Imagery blacklist lists all aerial and map sources, which are not permitted for OSM usage due to copyright. Editors must not show these resources as background layer.

Value

A list with the API capabilities and policies.

See Also

Other API functions: authenticate_osmapi(), osm_api_versions(), osm_permissions(), set_osmapi_connection()

Examples

osm_capabilities()

osmapiR documentation built on April 15, 2025, 9:06 a.m.