list_os_opendata: Retrieve information on OS OpenData Downloads

In osdatahub: Easier Interaction with the Ordnance Survey Data Hub

Retrieve information on OS OpenData Downloads

Description

Query the osdatahub Downloads API to gather information on available data collections. An API key is not required to list OS OpenData.

Usage

list_os_opendata(product_id, file_name, file_format, file_subformat, area, ...)

Arguments

product_id	(character) Retrieve information on a specific data product. Optional.
file_name	(character) Filter downloads to only include those with this file name. Optional.
file_format	(character) Filter downloads to only include those with this format. Optional.
file_subformat	(character) Filter downloads to only include those with this subformat. Optional.
area	(character) Filter downloads for only this area. Use 'GB' for all Great Britain. Optional.
...	Additional paramters. Not currently used.

Details

The OS Downloads API assists with the discovery and download of OS OpenData and OS premium data packages. This function is used for initial listing and discovery of open data products. Use the product ID from this list to filter further or to initiate a download.

When a product_id is not specified then all available open data is listed. Additional filters (i.e. file_name, file_format, file_subformat, area) can be used to find the specific download, but these filters are only valid when a specific product has been specified first.

The optional area filter is based on two-letter British National Grid tiles. Use 'GB' for all of Great Britain. Valid values area: GB, HP, HT, HU, HW, HX, HY, HZ, NA, NB, NC, ND, NF, NG, NH, NJ, NK, NL, NM, NN, NO, NR, NS, NT, NU, NW, NX, NY, NZ, OV, SD, SE, TA, SH, SJ, SK, TF, TG, SM, SN, SO, SP, TL, TM, SR, SS, ST, SU, TQ, TR, SV, SW, SX, SY, SZ, TV.

For more information on the Downloads API, see https://osdatahub.os.uk/docs/downloads/technicalSpecification.

Value

A data.frame or a product_list, which extends a data.frame, containing the information on downloadable files from the Downloads API.

See Also

download_os_opendata()

Examples

# Retrieve a data.frame listing all OS OpenData products.
opendata <- list_os_opendata()
opendata[, c("name", "url")]

osdatahub documentation built on April 11, 2025, 5:52 p.m.