{"name":"Cuba Research Project API","description":"Public read API over an archive of Cuban genealogical and demographic records.","version":"1.0.0","documentation":"https://cubaresearchproject.com/developers/","openapi":"https://cubaresearchproject.com/api/openapi.json","interactive_docs":"https://cubaresearchproject.com/api/docs","llms_txt":"https://cubaresearchproject.com/llms.txt","sitemap":"https://cubaresearchproject.com/sitemap.xml","authentication":"none for the endpoints listed below","endpoints":{"health":{"method":"GET","path":"/api/health","description":"Liveness."},"meta":{"method":"GET","path":"/api/meta","description":"Datasets with record counts, record types, total indexed people."},"collections":{"method":"GET","path":"/api/collections","description":"Every collection, with the URL of its page on this site."},"collection_values":{"method":"GET","path":"/api/collections/{dataset_id}/values","description":"Every place (field=place), ship name (field=ship) or birthplace (field=native) in one collection, most common first.","parameters":["field"]},"search":{"method":"GET","path":"/api/search","description":"Search every indexed person.","parameters":["q","given","surname","surname2","place","ship","native","dataset","type","yfrom","yto","bfrom","bto","dfrom","dto","sort","page","source"],"example":"https://cubaresearchproject.com/api/search?surname=Valdes&bfrom=1880&bto=1900"},"suggest":{"method":"GET","path":"/api/suggest","description":"Typeahead over the name index."},"record":{"method":"GET","path":"/api/record/{record_id}","description":"One record in full for a signed-in member or a share link (?share=) that opens it. Anyone else gets a summary marked gated: collection, record type, headline date and place, the search-row fields and the principal's name."},"record_companions":{"method":"GET","path":"/api/record/{record_id}/companions","description":"The other people named on the same document; empty unless signed in or opened by a share link."},"person_main_record":{"method":"GET","path":"/api/person/{person_id}/main-record","description":"The record a person belongs to."},"import_stats":{"method":"GET","path":"/api/stats/imports","description":"Daily series of records added to the archive."},"comments":{"method":"GET","path":"/api/comments","description":"The conversation under a collection or article, threaded. Reading is open; posting needs an account.","parameters":["page_key"],"example":"https://cubaresearchproject.com/api/comments?page_key=all-databases__lista-onomastica-cemeteries"},"random":{"method":"GET","path":"/api/random","description":"A random person, for discovery."}}}