---
title: "Cross-ONS search"
method: GET
path: "/api/v1/ons/search"
tags: ["Statistical Agencies"]
---

# Cross-ONS search

`GET /api/v1/ons/search`

Cross-ONS search via the beta /search endpoint. Indexes bulletins, articles, datasets, and time-series. Returns items ordered by the upstream relevance score. The legacy ONS search API was retired 2024-11-25; this endpoint uses the modern beta index.

## Query parameters

- `query` string, required — Free-text search query.
- `limit` integer — Page size.
- `offset` integer — Page offset.
- `content_type` string, nullable — Optional content type filter (timeseries, bulletin, article, dataset).

## Response `200`

Search hits with URI, title, summary, type, and release date.

- EnvelopeOnsSearchPayload
  - `data` OnsSearchPayload, required
    - `items` OnsSearchItem[], required — Search hits matching the query.
      - `uri` string, nullable — ONS URI for the item.
      - `title` string, nullable — Item title.
      - `summary` string, nullable — Item summary or excerpt.
      - `type` string, nullable — Content type (timeseries, bulletin, article, dataset, etc).
      - `release_date` string, nullable — Release or publication date (ISO 8601 UTC).
    - `count` integer, required — Number of hits returned in this page.
    - `distinct_items_count` integer, nullable — Distinct total hits reported by upstream.
    - `content_types` object[], nullable — Facet counts by content type.
    - `topics` object[], nullable — Facet counts by ONS topic.
    - `took` number, nullable — Server-side search duration (seconds) reported by upstream.
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/4e2740743eb4/schema)