Execute search of archives/repositories
Request
- Base URLhttps://discovery.nationalarchives.gov.uk/API
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Repository location Country filter. <para>Country codes</para>
Repository location Region filter. <para>Region codes</para>
Repository location County filter. <para>County codes</para>
Repository type filter.
Archon Code
String which should be contained in the repository title
Search query. <para>May contain boolean expressions, i.e. AND, OR, NOT, quotations marks, brackets and/or wild card (*).</para>
Highlight search terms in search results. <para>If highlight is enabled only a snippet containing highlighted text is returned</para>
Search results sort option
Page number. <para><b>Range [0, 100]</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>
Search results page size. <para><b>Range [0, 1000], default 15</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>
Filter by the first letter of the record title. <para>Enabled when sorting by Title in {SortByOption} and number of results is less then 10,000</para>
Cursor Mark value. <para>Search result batch start mark used for deep paging.</para><para>To invoke deep paging use wild card (*). For subsequent requests use the value of "NextBatchMark" field.</para>
Query string parameter for user preferences. <para>Used to pass user-specific preferences as part of the search request.</para>
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.