Sign in

v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-1451115.9 KB
public

ONS query API for published or upcoming releases

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

get/search/releases

Query parameters

limitinteger

The number of Resources requested, defaulted to 10 and limited to 1000.

offsetinteger

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'release_date_asc' | 'release_date_desc' | 'title_asc' | 'title_desc' | 'relevance'

The sort order of the returned set of Releases

querystring

Query keywords

fromDatestring

Specifies candidate Releases by their ReleaseDate, which must be on or after the fromDate

toDatestring

Specifies candidate Releases by their ReleaseDate, which must be on or before the toDate

release-type'type-upcoming' | 'type-published' | 'type-cancelled'

The type of releases to include in the results.

highlightboolean

Determines whether to return HTML highlighted fields.

censusboolean

Whether to only include census releases in the results.

Response

OK