omnistate/national-archives-uk API reference

Omnistate\NationalArchivesUk

NationalArchivesUk class

final class NationalArchivesUk implements CivilRegistryInterface NationalArchivesUk.php:33

Discovery, the catalogue of the UK's National Archives and of some 2,500 archives across the country: wills, service records, prisoner-of-war cards, settlement examinations, parish papers... described piece by piece, many of them by the name of the person they are about.

It is a catalogue of archives, NOT civil registration: births, marriages and deaths of England and Wales are held by the General Register Office, which has no public API. Every record is therefore of the kind OTHER: a document that names the person, with its reference and who holds it - not an act, no structured person, no picture. A question for births only is not one for it.

Free, no key. The API asks for moderation: one call a second, at most 3,000 a day per address.

const URL = 'https://discovery.nationalarchives.gov.uk/API'

const PAGE = 'https://discovery.nationalarchives.gov.uk/details/r/'

NationalArchivesUk::__construct()

public function __construct(readonly HttpClientInterface $http, readonly float $timeout = 10, readonly string $url = self::URL)

NationalArchivesUk::name()

public function name(): string

NationalArchivesUk::countries()

public function countries(): array

NationalArchivesUk::kinds()

public function kinds(): array

NationalArchivesUk::period()

public function period(): ?Period

NationalArchivesUk::hasImages()

public function hasImages(): bool

NationalArchivesUk::supports()

public function supports(CivilQuery $query): bool

NationalArchivesUk::search()

public function search(CivilQuery $query): array

NationalArchivesUk::find()

public function find(string $identifier): ?CivilRecord