Transcriptions

Full-text search across page transcriptions

Performs a full-text search across the page transcriptions of historical documents indexed by Open Archives. Mirrors the search UI at /transcripties/zoek.php. Results are ordered by Elasticsearch relevance (the order is fixed and cannot be overridden) and are returned paginated. Each match includes a source citation, page identifier and up to five highlighted text fragments. The set of facets returned depends on the supplied filters.

get/transcriptions/search.json

Request

  • Base URL: https://api.openarchieven.nl/1.1
  • URL: https://api.openarchieven.nl/1.1/transcriptions/search.json
  • Auth: none declared

Query parameters

qstring required

Search query. Wrap in double quotes for an exact phrase match; include * or ? for wildcard matching; otherwise the words are combined with an AND operator. Special characters [ ] ( ) { } ^ + = ! ~ : - / are stripped before searching.

archive_codestring

Filter results to one source archive. Use the openarch archive code (e.g. utr, sch); the API maps this to the corresponding ISIL internally. Obtain valid codes via Stats/Archives.

archive_numberstring

Filter results to one archive number (archieftoegang) within the chosen archive_code. Only meaningful when archive_code is also supplied.

inventory_numberstring

Filter results to one inventory number within the chosen archive_number. Only meaningful when both archive_code and archive_number are also supplied.

year_startinteger

Filter on the start year (inventaris.jaar_van) of the inventory the page belongs to. Pages themselves carry no date.

year_endinteger

Filter on the end year of the inventory the page belongs to.

number_showinteger

Number of results to return per page. Maximum is 100.

startinteger

Result offset for paging.

lang'nl' | 'en' | 'de' | 'fr'

Language code used to localise archive names in the response.

callbackstring

JavaScript function name for JSONP callback.

Response

Successful search response

Example response

{
  "response": {
    "docs": [
      {
        "id": "NL-SdmGA_1504889_11",
        "source_archive": {
          "isil": "NL-SdmGA",
          "archive_code": "sch",
          "name": "Gemeentearchief Schiedam"
        },
        "archive_number": {
          "nr": "243",
          "title": "Archief van notaris Maarten Kouwenhoven, 1646-1698"
        },
        "inventory_number": {
          "nr": "761",
          "title": "1662 januari 3-1664 december 30"
        },
        "page": "11"
      }
    ],
    "facets": {
      "source_archive": [
        {
          "isil": "NL-HaNA",
          "archive_code": "rzh",
          "name": "Nationaal Archief",
          "count": 986
        }
      ],
      "archive_number": [
        {
          "nr": "67",
          "title": "Inventaris van het archief van de familie Huydecoper",
          "count": 1420
        }
      ],
      "inventory_number": [
        {
          "nr": "67",
          "title": "Inventaris van het archief van de familie Huydecoper",
          "count": 1420
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.