Open Archives API » Records/Search

This method searches the genealogical dataset and returns the found persons (and records).

URL

https://api.openarch.nl/1.0/records/search.json

Method

GET

Input

The parameters of this method correspond to the HTML version of search.

NameRequiredDescriptionDefault
nameYesSearch query (see search examples on front page for advances queries)
archiveNoFilter returned search results on archive (obtain a list of valid archive codes via Stats/Archives)
number_showNoNumber of results to show (max=100)10
sourcetypeNoFilter results on source type (obtain a list of valid source types via Stats/Source types)
eventplaceNoFilter results on event place
sortNoColumn to sort the results on (negative value to sort descending, positive ascending):
  • 1 = Name
  • 2 = Role
  • 3 = Event
  • 4 = Date
  • 5 = Place
  • 6 = Source
1
langNoLanguage code (nl for Dutch, en for English) - this has only effect on the relationtype and eventtype values in the search results.nl
callbackNoFunction name to be called on JSON data
startNoInitial results to return (for paging)0
cursormarkNoFor efficiently getting next set of results, to be used in stead of start parameter (*)

(*) the initial cursormark should be *, then the response message contains a "nextcursormark" value which should be used as cursormark in the next request. Using a cursor performs better then a normal search, but sorting is not possible when using a cursor.

Output

The returned JSON(P) contains basically two items: the query as interpretered by the API and the response which contains an array of search results.

Example: https://api.openarch.nl/1.0/records/search.json?name=Coret&lang=en&number_show=5 outputs (in pretty-print):

{
   "query":{
      "archive_code":null,
      "name":"Coret",
      "only_results_with_scans":false,
      "start":0,
      "number_show":5,
      "sort":1,
      "language":"en"
   },
   "response":{
      "number_found":443,
      "docs":[
         {
            "identifier":"6b396b55-ffe0-5ccf-a1e0-8330f78157b5",
            "archive_code":"bhi",
            "archive":"Brabants Historisch Informatie Centrum",
            "personname":"2 Coret",
            "relationtype":"Bruid",
            "eventtype":"Huwelijk",
            "eventdate":{
               "day":3,
               "month":11,
               "year":1855
            },
            "eventplace":"'s-Hertogenbosch",
            "sourcetype":"BS Huwelijk",
            "url":"https://www.openarch.nl/show.php?archive=bhi&identifier=6b396b55-ffe0-5ccf-a1e0-8330f78157b5"
         },
         {
            "identifier":"3567361c-5570-102d-9037-005056a23d00",
            "archive_code":"ghn",
            "archive":"Nationaal Archief",
            "personname":"A. Coret",
            "relationtype":"Militair",
            "eventtype":"Registratie",
            "eventplace":null,
            "sourcetype":"Stamboek",
            "url":"https://www.openarch.nl/show.php?archive=ghn&identifier=3567361c-5570-102d-9037-005056a23d00"
         },
         {
            "identifier":"9f2781d8-a009-e740-859b-4d20f7a65040",
            "archive_code":"elo",
            "archive":"Erfgoed Leiden en omstreken",
            "personname":"Abigael Coret",
            "relationtype":"Moeder",
            "eventtype":"Doop",
            "eventdate":{
               "day":12,
               "month":3,
               "year":1721
            },
            "eventplace":"Leiden",
            "sourcetype":"DTB Dopen",
            "url":"https://www.openarch.nl/show.php?archive=elo&identifier=9f2781d8-a009-e740-859b-4d20f7a65040"
         },
         {
            "identifier":"2ccd9d21-ca3b-8633-185b-120b30240e0a",
            "archive_code":"elo",
            "archive":"Erfgoed Leiden en omstreken",
            "personname":"Abigael Coret",
            "relationtype":"Laatste partner van de bruidegom",
            "eventtype":"Trouwen",
            "eventdate":{
               "day":31,
               "month":8,
               "year":1743
            },
            "eventplace":"Leiden",
            "sourcetype":"DTB Trouwen",
            "url":"https://www.openarch.nl/show.php?archive=elo&identifier=2ccd9d21-ca3b-8633-185b-120b30240e0a"
         },
         {
            "identifier":"d3019973-29ed-9b49-437e-be941b878123",
            "archive_code":"elo",
            "archive":"Erfgoed Leiden en omstreken",
            "personname":"Abigail Coret",
            "relationtype":"Moeder",
            "eventtype":"Doop",
            "eventdate":{
               "day":22,
               "month":3,
               "year":1733
            },
            "eventplace":"Leiden",
            "sourcetype":"DTB Dopen",
            "url":"https://www.openarch.nl/show.php?archive=elo&identifier=d3019973-29ed-9b49-437e-be941b878123"
         }
      ]
   }
}


Errors

One of the following errors may be thrown:

Error codeError message
1Invalid archive
4Invalid lang
21Missing required name

An example error looks (pretty-printed) like:

{
	"error_code": 4,
	"error_description": "Invalid lang"
}

Back to API documentation

Publiceer uw stamboom en zoek uw voorouders op Genealogie Online!
https://www.genealogieonline.nl/