GET /search/v1/records

gov.uk:uk-national-archives-discovery-api

Summary: Search records
Operation ID: searchRecords
Auth: unknown
Description

Execute a search of archival records across The National Archives and partner archives. Supports complex boolean queries and various filters.

Parameters (15)

sps.catalogueLevels (array, query, optional)

Catalogue level filter

sps.closureStatuses (array, query, optional)

Closure status filter (O=Open, C=Closed, R=Retained, P=Pending)

sps.corporateNames (string, query, optional)

Corporate name/body query (Custom search)

sps.dateFrom (string, query, optional)

Record covering date - start date (ISO 8601 format)

sps.dateTo (string, query, optional)

Records covering date - end date (ISO 8601 format)

sps.firstName (string, query, optional)

Person First name query (Custom search)

sps.heldByCode (string, query, optional)

Held by code filter

Constraints: {'enum': ['ALL', 'TNA', 'OTH']}

sps.lastName (string, query, optional)

Person Last name query (Custom search)

sps.page (integer, query, optional)

Page number. Range [0, 100]. page * resultsPerPage must not exceed 10,000

Constraints: {'minimum': 0, 'maximum': 100}

sps.recordPlace (string, query, optional)

Place query, i.e. place of birth (Custom search)

sps.recordRepositories (array, query, optional)

Archives/repositories filter (Repository Archon references)

sps.recordSeries (array, query, optional)

Catalogue Series (collection) filter

sps.resultsPageSize (integer, query, optional, default: 15)

Search results page size. Range [0, 1000], default 15

Constraints: {'minimum': 0, 'maximum': 1000}

sps.searchQuery (string, query, required)

Search query. May contain boolean expressions (AND, OR, NOT), quotation marks, brackets and wild card (*)

sps.sortByOption (string, query, optional)

Search results sort option

Constraints: {'enum': ['RELEVANCE', 'REFERENCE_ASCENDING', 'DATE_ASCENDING', 'DATE_DESCENDING', 'TITLE_ASCENDING', 'TITLE_DESCENDING']}

No probe data for this endpoint yet.