omnistate/openarchieven API reference

Omnistate\OpenArchieven

OpenArchieven class

final class OpenArchieven implements CivilRegistryInterface OpenArchieven.php:34

Open Archives (openarchieven.nl): the indexes of some two hundred Dutch and Belgian archives in one search - civil registration (births, marriages, deaths), church books (baptisms, burials), population registers, notarial deeds - plus what they index of Suriname and of France (INSEE's deaths). A record names everyone in the act, says which archive keeps the original and under which reference, and often links the scan of the act.

Free, no key, open data; four calls a second per address, kept here. The API answers its errors in the body, with HTTP 200. Its country filter is the country of the archive that holds the record, and knows four values: nl, be, fr, sr.

const URL = 'https://api.openarchieven.nl/1.1'

OpenArchieven::__construct()

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

OpenArchieven::name()

public function name(): string

OpenArchieven::countries()

public function countries(): array

The values its country filter knows; any other is ignored by the API, hence not declared.

OpenArchieven::kinds()

public function kinds(): array

OpenArchieven::period()

public function period(): ?Period

OpenArchieven::hasImages()

public function hasImages(): bool

OpenArchieven::supports()

public function supports(CivilQuery $query): bool

OpenArchieven::search()

public function search(CivilQuery $query): array

OpenArchieven::find()

public function find(string $identifier): ?CivilRecord

$identifier is "archive:uuid", as a search gives it.