---
title: "Search entities"
method: GET
path: "/api/v1/search"
tags: ["Search"]
---

# Search entities

`GET /api/v1/search`

## Request

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

Search for entities by name or ticker.

## Query parameters

- `q` string: Search query (empty = list all)
- `page` integer, nullable: Page number (1-based). Public pagination idiom; overrides offset.
- `per_page` integer, nullable: Results per page (1-200). Overrides limit.
- `limit` integer: Legacy — maximum results per page
- `offset` integer: Legacy — number of results to skip

## Response `200`

Successful Response

- ApiResponseSearchResponse
  - `success` boolean, required
  - `data` SearchResponse: Search response with results.
    - `results` SearchResult[], required
      - `id` string, required
      - `name` string, required
      - `ticker` string, nullable, required
      - `mic` string, nullable, required
      - `country` string, nullable, required
      - `market` string, nullable, required
    - `total` integer, required
    - `query` string, required
    - `offset` integer
    - `has_more` boolean
  - `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)