---
title: "Resolve a free-text query to ranked Hub concepts"
method: GET
path: "/api/v1/concepts/match"
tags: ["Concepts"]
---

# Resolve a free-text query to ranked Hub concepts

`GET /api/v1/concepts/match`

## Request

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

Maps a free-text `query` (a code fragment or an English label fragment) to up to 5–10 ranked Hub concept matches (exact code > code prefix > code substring > label substring), primary hubs first. Matches hub codes and labels only, not XBRL qnames.

Returns `SearchConceptResult{matches}`, a different shape from `/concepts/search` (`ConceptSearchResponse`).

A Free key is enough.

## Query parameters

- `query` string, required: Free-text code or label fragment to resolve to Hub concepts.

## Response `200`

Ranked Hub concept matches.

- ApiResponseSearchConceptResult
  - `success` boolean, required
  - `data` SearchConceptResult
    - `matches` HubConceptMatch[], required
      - `code` string, required
      - `label` string, nullable
      - `statement` string, nullable
      - `category` string, nullable
      - `description` string, 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

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