---
title: "Get the data dictionary"
method: GET
path: "/api/v1/dictionary"
tags: ["Data Dictionary"]
---

# Get the data dictionary

`GET /api/v1/dictionary`

## Request

- Base URL: `https://api.hub-equity.com`
- URL: `https://api.hub-equity.com/api/v1/dictionary`
- Auth: HTTP bearer

Return the Hub-Equity data dictionary: the canonical hub catalog (code, label, definition, statement, period type, sign, comparability tier, participating accounting identities), the extraction / mapping / calculation / restatement methodology, a live coverage snapshot and the enforced accounting identities.

Without `version`, returns the current published version. With `version=X.Y.Z`, returns that version if published, else `404`.

A Free key is enough.

## Query parameters

- `version` string, nullable: Published semver to fetch (e.g. `1.0.0`). Omit for the current version.

## Response `200`

The data dictionary.

- ApiResponseDict
  - `success` boolean, required
  - `data` object, nullable
  - `error` ApiError: API error details.
    - `code` string, required
    - `message` string, required
    - `details` object, nullable
  - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints.
    - `timestamp` string, date-time
    - `request_id` string, nullable
    - `page` integer, nullable
    - `per_page` integer, nullable
    - `total` integer, nullable
  - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer).
    - `self` string, nullable
    - `first` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
    - `last` string, nullable

## Other responses

- `404`: Unknown or unpublished version.
- `422`: Validation Error

---

[API](https://skmtc.dev/hub-equity/apis/hub-equity-api.md) · [All operations](https://skmtc.dev/hub-equity/apis/hub-equity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hub-equity/apis/hub-equity-api/revisions/e8eeda5dc13e?raw)