---
title: "List the standardized Hub catalog"
method: GET
path: "/api/v1/concepts/hubs"
tags: ["Concepts"]
---

# List the standardized Hub catalog

`GET /api/v1/concepts/hubs`

## Request

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

Enumerate the Hub-Equity standardized hub catalog (the data dictionary).

Each item carries `code`, `label`, `category`, `subcategory`, `is_derived`. Filters:
- `category` — one of income_statement, balance_sheet, cash_flow, ratio, equity_info, metadata (an unknown category → empty result).
- `include_non_primary` — include derived/secondary hubs (default false : primary hubs only).
- `limit` — 1+, default 80 ; clamped server-side to 200.

A Free key is enough.

## Query parameters

- `category` string, nullable: Restrict to one Hub category (income_statement, balance_sheet, cash_flow, ratio, equity_info, metadata). Unknown → empty result.
- `include_non_primary` boolean: Include derived/secondary hubs (default: primary only).
- `limit` integer: Max rows (clamped server-side to 200).

## Response `200`

Hub catalog list.

- ApiResponseListHubsResult
  - `success` boolean, required
  - `data` ListHubsResult
    - `matches` HubListItem[], required: Hubs matching the filters, sorted by category then catalog order
      - `code` string, required
      - `label` string, nullable
      - `category` string, nullable
      - `subcategory` string, nullable
      - `is_derived` boolean
    - `total` integer, required: Number of items returned (at most `limit`, itself capped at 200)
  - `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

- `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)