get_table: Get 'nomis' Table

In sgapi: Aid Querying 'nomis' and 'Office for National Statistics Open Geography' APIs

Get 'nomis' Table

Description

Retrieve a 'nomis' table, containing the columns of interest, using a given table ID. Option to apply filters to the query, and to circumnavigate the limit on number of rows returned using your 'nomis' uid.

Usage

get_table(
  id,
  options,
  selection = NULL,
  uid = NULL,
  base_url = "https://www.nomisweb.co.uk/api/v01"
)

Arguments

id	a table ID recognised by 'nomis' (e.g. "NM_1_1")
options	a list of paramaters to pass to the API query.
selection	a vector of column names to return. NULL returns all. Defaults to NULL.
uid	Unique 'nomis' identifier to enable larger 'nomis' queries - https://www.nomisweb.co.uk/. Defaults to NULL.
base_url	Nomis base url to query

Value

A tidy dataframe of selected 'nomis' table with the selected parameters and user filters applied.

Examples

get_table(id="NM_1_1", options = list("geography" = "TYPE480", "time" = "latest"))
get_table(id="NM_1002_1", options = list("geography" = "TYPE265", "time" = "latest"),
selection = "GEOGRAPHY_NAME,C_AGE_NAME,OBS_VALUE",uid=NULL)

sgapi documentation built on June 8, 2025, 11:09 a.m.