/search/releases

GET

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

Parameters

Name Type Description Possible Values
limit query The number of Resources requested, defaulted to 10 and limited to 1000.
offset query The offset into the complete ordered set of Resources which satisfy the query, which specifies the first Resource to return (starting at 0). Use this parameter as a pagination mechanism along with the limit parameter.
sort query The sort order of the returned set of Releases release_date_asc, release_date_desc, title_asc, title_desc, relevance
query query Query keywords
fromDate query Specifies candidate Releases by their ReleaseDate, which must be on or after the fromDate
toDate query Specifies candidate Releases by their ReleaseDate, which must be on or before the toDate
release-type query The type of releases to include in the results. type-upcoming, type-published, type-cancelled
highlight query Determines whether to return HTML highlighted fields.
census query Whether to only include census releases in the results.

Responses

200: OK

Example value
{
  "breakdown": {
    "cancelled": 5,
    "census": 5,
    "confirmed": 5,
    "provisional": 5,
    "published": 5,
    "total": 80
  },
  "releases": [
    {
      "date_changes": [
        {
          "change_notice": "string",
          "previous_date": "string"
        }
      ],
      "description": {
        "cancelled": true,
        "census": true,
        "finalised": true,
        "keywords": [
          "string"
        ],
        "language": "string",
        "postponed": true,
        "provisional_date": "2025-02-05T17:12:13.877Z",
        "published": true,
        "release_date": "2025-02-05T17:12:13.877Z",
        "summary": "string",
        "title": "string"
      },
      "highlight": {
        "keywords": [
          "string"
        ],
        "summary": "string",
        "title": "string"
      },
      "uri": "string"
    }
  ],
  "took": 530
}

500: Internal server error