SDMX-REST Availability Queries

Note

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

SDMX-REST services.

Build SDMX-REST data queries.

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

class pysdmx.api.qb.availability.AvailabilityMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None): The mode of a data availability query.

class pysdmx.api.qb.availability.AvailabilityQuery(context: DataContext = DataContext.ALL, agency_id: str | Sequence[str] = '*', resource_id: str | Sequence[str] = '*', version: str | Sequence[str] = '*', key: str | Sequence[str] = '*', component_id: str | Sequence[str] = '*', components: MultiFilter | None | NumberFilter | TextFilter = None, updated_after: datetime | None = None, references: StructureReference | Sequence[StructureReference] = StructureReference.NONE, mode: AvailabilityMode = AvailabilityMode.EXACT)

A data availability query.

Availability queries allow to see what data are available for a specific context (data structure, dataflow or provision agreement).

context: The context for which data must be retrieved.

agency_id: The agency maintaining the context to be considered.

resource_id: The id of the context to be considered.

version: The version of the context to be considered.

key: The combination of dimension values identifying the slice of the cube for which data should be returned. Wildcarding is supported via the * operator.

component_id: The id of the dimension for which to obtain availability information about. In the case where this information is not provided, data availability will be provided for all dimensions.

components: The component values to be used for data filtering.

updated_after: The last time the query was performed by the client.

references: This attribute instructs the web service to return (or not) the artefacts referenced by the DataConstraint to be returned.

mode: Return a Cube Region containing values which will be returned by executing the query (mode=”exact”) vs a Cube Region showing what values remain valid selections that could be added to the data query (mode=”available”).