GET search/v1/archives

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

Summary: Search archives/repositories
Operation ID: searchArchives
Auth: unknown
Description

Execute a search of archives and repositories.

Parameters (7)

sps.archiveCode (integer, query, optional)

Archon Code

sps.page (integer, query, optional)

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

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

sps.repositoryTypes (array, query, optional)

Repository type 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']}

sps.titleContains (string, query, optional)

String which should be contained in the repository title

No probe data for this endpoint yet.