oecdQuery: Construct an Encoded OECD Data Request

View source: R/query.R

oecdQueryR Documentation

Construct an Encoded OECD Data Request

Description

Construct an Encoded OECD Data Request.

Usage

oecdQuery(OECDDatasetCode, filters = NULL)

Arguments

OECDDatasetCode

A catalogue-resolved short code such as "CLI", a terminal ID such as "DF_CLI", a complete dataflow ID such as "DSD_STES@DF_CLI", or a qualified reference "OECD.SDD.STES,DSD_STES@DF_CLI" with an optional numeric version. Short codes are accepted only when resolution is unambiguous. An omitted version, "latest" or "+" selects the latest stable structure. See oecdDataset for resolution rules.

filters

Same named filter list as importData, including its optional reserved .dataset selector block.

Details

This can fetch structural metadata but never downloads observations. V2 uses named component constraints with encoded comma-OR and plus-AND operators. V1 uses positionally ordered keys and start/end period parameters. Reserved literal filter characters are rejected. The URL alone does not include the HTTP Accept header; send the attached Accept value when inspecting it with another client.

Value

A character URL with attributes Accept, RequestedDatasetCode and OECDDatasetCode. The URL contains an exact resolved structure version.

See Also

importData, oecdOptions

Examples

if (interactive()) {
q <- oecdQuery("CLI",
               list(REF_AREA = "USA", TIME_PERIOD = c("2023-01", "2023-12")))
cat(q)
attr(q, "Accept")
}

OECDdata documentation built on Oct. 31, 2026, 1:07 a.m.