SDMX-REST Structure Queries

Note

Additional information about how to build SDMX-REST queries can be found in the following tutorial:

SDMX-REST services.

Build SDMX-REST structure queries.

class pysdmx.api.qb.structure.StructureDetail(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None): The desired amount of information to be returned.

class pysdmx.api.qb.structure.StructureFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None): The SDMX Structure formats.

class pysdmx.api.qb.structure.StructureQuery(artefact_type: StructureType = StructureType.ALL, agency_id: str | Sequence[str] = '*', resource_id: str | Sequence[str] = '*', version: str | Sequence[str] = '~', item_id: str | Sequence[str] = '*', detail: StructureDetail = StructureDetail.FULL, references: StructureReference = StructureReference.NONE)

A query for structural metadata.

artefact_type: The type of structural metadata to be returned.

agency_id: The agency (or agencies) maintaining the artefact(s) to be returned.

resource_id: The id(s) of the artefact(s) to be returned.

version: The version(s) of the artefact(s) to be returned.

item_id: The id(s) of the item(s) to be returned.

detail: The desired amount of information to be returned.

references: The additional artefact(s) to include in the response.

get_url(version, omit_defaults=False)

The URL for the query in the selected SDMX-REST API version.

Return type:: str

validate()

Validate the query.

Return type:: None

class pysdmx.api.qb.structure.StructureReference(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Which additional artefacts to include in the response.

is_artefact_type()

Whether the references points to a type of artefacts.

Return type:: bool

class pysdmx.api.qb.structure.StructureType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None): The type of structural metadata to be returned.