statcan_cube_metadata

Pack: statcan · Endpoint: https://gateway.pipeworx.io/statcan/mcp

Full metadata for a StatCan cube: dimensions, member trees, frequency, geography, last release. Use it to construct a coordinate string for statcan_cube_data.

Parameters

NameTypeRequiredDescription
product_idnumberyesCube product ID (8-digit, e.g. 36100434 = quarterly GDP).

Example call

Arguments

{
  "product_id": 36100434
}

curl

curl -X POST https://gateway.pipeworx.io/statcan/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"statcan_cube_metadata","arguments":{"product_id":36100434}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('statcan_cube_metadata', {
  "product_id": 36100434
});

Response shape

Always returns: product_id, cansim_id, title_en, title_fr, start_date, end_date, series_count, datapoint_count, frequency_code, archive_status, dimensions

FieldTypeDescription
product_idnumberCube product ID
cansim_idstring | nullCANSIM identifier
title_enstring | nullEnglish cube title
title_frstring | nullFrench cube title
start_datestring | nullCube start date
end_datestring | nullCube end date
series_countnumber | nullTotal series in cube
datapoint_countnumber | nullTotal datapoints in cube
frequency_codenumber | nullRelease frequency code
archive_statusstring | nullArchive status in English
dimensionsarrayCube dimensions
Full JSON Schema
{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "number",
      "description": "Cube product ID"
    },
    "cansim_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "CANSIM identifier"
    },
    "title_en": {
      "type": [
        "string",
        "null"
      ],
      "description": "English cube title"
    },
    "title_fr": {
      "type": [
        "string",
        "null"
      ],
      "description": "French cube title"
    },
    "start_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cube start date"
    },
    "end_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cube end date"
    },
    "series_count": {
      "type": [
        "number",
        "null"
      ],
      "description": "Total series in cube"
    },
    "datapoint_count": {
      "type": [
        "number",
        "null"
      ],
      "description": "Total datapoints in cube"
    },
    "frequency_code": {
      "type": [
        "number",
        "null"
      ],
      "description": "Release frequency code"
    },
    "archive_status": {
      "type": [
        "string",
        "null"
      ],
      "description": "Archive status in English"
    },
    "dimensions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "position": {
            "type": [
              "number",
              "null"
            ],
            "description": "Dimension position index"
          },
          "name_en": {
            "type": [
              "string",
              "null"
            ],
            "description": "English dimension name"
          },
          "has_unit_of_measure": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Has unit of measure"
          },
          "member_count": {
            "type": [
              "number",
              "null"
            ],
            "description": "Total members in dimension"
          },
          "member_sample": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "description": "Member ID"
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "English member name"
                }
              },
              "required": [
                "id",
                "name"
              ]
            },
            "description": "Sample of first 10 members"
          }
        },
        "required": [
          "position",
          "name_en",
          "has_unit_of_measure",
          "member_count",
          "member_sample"
        ]
      },
      "description": "Cube dimensions"
    }
  },
  "required": [
    "product_id",
    "cansim_id",
    "title_en",
    "title_fr",
    "start_date",
    "end_date",
    "series_count",
    "datapoint_count",
    "frequency_code",
    "archive_status",
    "dimensions"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "statcan": {
      "url": "https://gateway.pipeworx.io/statcan/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build June 21, 2026