Open Archives API » Transcriptions/Browse

Returns a hierarchical browse of available page transcriptions. Mirrors the browse UI at /transcripties/lijst/.

There are three modes, determined by the supplied filters:

• No filter — top-level list of source archives, ordered by total transcription count (descending).
• archive_code only — list of all archive numbers (archieftoegangen) within that archive, ordered by archive number.
• archive_code + archive_number — list of all inventories within that archive number, ordered by inventory number.

Order is fixed and cannot be overridden. Results are always returned in full (no paging).

URL

https://api.openarchieven.nl/1.1/transcriptions/browse.json

Method

GET

Input

Name	Required	Description	Default
archive_code	No	Source archive code. When omitted, the top-level list of source archives is returned. Obtain valid codes via Stats/Archives.
archive_number	No	Archive number (archieftoegang) within archive_code. Only meaningful when archive_code is also set.
lang	No	Language code (nl, en, de, fr).	nl
callback	No	Function name to be called on JSON data (JSONP).

Output

JSON object with two top-level fields: filters (echo of the filters supplied) and response (with level 1, 2 or 3, plus docs).

Example level 1 (no filter): https://api.openarchieven.nl/1.1/transcriptions/browse.json?format=json outputs (pretty-printed):

{
    "filters": { "archive_code": null, "archive_number": null },
    "response": {
        "level": 1,
        "docs": [
            { "isil": "NL-HaNA",   "archive_code": "rzh", "name": "Nationaal Archief",      "count": 15841597 },
            { "isil": "NL-AsdSAA", "archive_code": "saa", "name": "Stadsarchief Amsterdam", "count":  2966344 },
            { "isil": "NL-HlmNHA", "archive_code": "nha", "name": "Noord-Hollands Archief", "count":  2218718 },
            { "isil": "NL-UtHUA",  "archive_code": "hua", "name": "Het Utrechts Archief",   "count":   420392 }
        ]
    }
}

Example level 2 (filter on archive): https://api.openarchieven.nl/1.1/transcriptions/browse.json?archive_code=hua&format=json outputs (pretty-printed):

{
    "filters": { "archive_code": "hua", "archive_number": null },
    "response": {
        "level": 2,
        "docs": [
            {
                "nr": "67",
                "title": "Inventaris van het archief van de familie Huydecoper 1459-1956 (1997)",
                "count": 1420,
                "url": "https://hetutrechtsarchief.nl/collectie/609C5BA8E8B34642E0534701000A17FD"
            }
        ]
    }
}

Example level 3 (filter on archive and archive number): https://api.openarchieven.nl/1.1/transcriptions/browse.json?archive_code=hua&archive_number=67&format=json outputs (pretty-printed):

{
    "filters": { "archive_code": "hua", "archive_number": "67" },
    "response": {
        "level": 3,
        "docs": [
            {
                "nr": "67",
                "title": "Familie Huydecoper - Joan Huydecoper (1625-1704) - Dagboek Reis van Bordeaux naar Saumur, 1648",
                "count": 76,
                "url": "https://hetutrechtsarchief.nl/collectie/609C5BB0F8344642E0534701000A17FD"
            }
        ]
    }
}

Errors

One of the following errors may be thrown:

Error code	Error message
1	Invalid archive
4	Invalid lang
15	Missing required format specification

An example error looks (pretty-printed) like:

{
    "error_code": 1,
    "error_description": "Invalid archive"
}

Back to API documentation