---
title: "ONS query API for published or upcoming releases"
method: GET
path: "/search/releases"
tags: ["public"]
---

# ONS query API for published or upcoming releases

`GET /search/releases`

## Request

- Base URL: `/v1` (relative, and the document’s source URL is not known)
- URL: `/v1/search/releases`
- Auth: none required

ONS query API specifically targeting already Published (or Cancelled) Releases, or upcoming Release Calendar Entries

## Query parameters

- `limit` integer
- `offset` integer
- `sort` 'release_date_asc' | 'release_date_desc' | 'title_asc' | 'title_desc' | 'relevance'
- `query` string
- `fromDate` string
- `toDate` string
- `release-type` 'type-upcoming' | 'type-published' | 'type-cancelled'
- `highlight` boolean
- `census` boolean

## Response `200`

OK

- SearchReleaseResponse
  - `took` number, required: Time taken to execute query in milliseconds
  - `breakdown` Breakdown, required
    - `total` number, required: Total number of Releases which match query
    - `provisional` number: Number of provisional Releases
    - `confirmed` number: Number of confirmed Releases
    - `published` number: Number of published Releases
    - `cancelled` number: Number of cancelled Releases
    - `census` number: Number of Releases that are related to Census
  - `releases` Release[], required: List of matching Releases
    - `uri` string, required
    - `date_changes` object[]
      - `previous_date` string
      - `change_notice` string
    - `description` object, required
      - `title` string, required
      - `summary` string, required
      - `release_date` string, date-time, required
      - `published` boolean, required
      - `cancelled` boolean, required
      - `finalised` boolean, required
      - `postponed` boolean, required
      - `census` boolean, required
      - `keywords` string[]
      - `provisional_date` string, date-time
      - `language` string
    - `highlight` Highlight: Fields that contain at least 1 matching term from query 'q' parameter. The values contain the following embedded tags "...<em class="highlight">{matched term}</em>..."
      - `summary` string
      - `title` string
      - `keywords` string[]

## Other responses

- `400`: The request was invalid.
- `500`: Internal server error

---

[API](https://skmtc.dev/office-of-national-statistics/apis/search-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/search-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/search-api/revisions/33e6751db807?raw)