get_series_info
Resolve Statistics Canada product and coordinate pairs to series metadata (vector IDs, titles, frequency, UOM) in one batch. Find vector IDs before fetching data.
Instructions
Resolve one or more {productId, coordinate} pairs to series metadata (vectorId, titles, frequency, UOM, etc.) in a single API call.
Use this to find vectorIds before fetching data with get_sdmx_data or get_sdmx_vector_data. Pass one item or many — same tool either way. Coordinates are automatically padded to 10 dimensions. Corresponds to: POST /getSeriesInfoFromCubePidCoord (accepts array)
NOTE: Response fields like scalarFactorCode, frequencyCode, and memberUomCode use StatCan numeric codes. Call get_code_sets() to decode them (e.g. frequencyCode 6 = "Monthly", scalarFactorCode 0 = "Units").
Returns: List of series metadata dicts, paginated with _guidance if >50 results. Raises: httpx.HTTPStatusError: If the API returns an error status code. ValueError: If no items return SUCCESS. Exception: For other network or unexpected errors.
IMPORTANT: In your final response cite the ProductId and Coordinate for each series.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | List of {productId, coordinate} pairs to fetch series info for in a single batch call. | |
| limit | No | Max results to return. Default 50. | |
| offset | No | Number of results to skip (for pagination). Default 0. |