The EpHEMERA data are available through an open, read-only API, so that other institutes, researchers and the general public can reuse the records of the monuments and their 3D viewers. No registration or key is needed. Responses are in JSON (UTF-8) and can be called from any website (CORS is enabled). The usage rights stated in each record apply to the content it describes.
Endpoints
| Request | Returns |
|---|
GET /api/v1/monuments/ |
All published monuments, page by page. |
GET /api/v1/monuments/<id>/ |
One monument by its numeric id, which never changes. |
Query parameters for the list
| Parameter | Description | Example |
|---|
unesco | Only UNESCO-listed monuments (true) or only the others (false). | ?unesco=true |
identifier | The monument with this persistent identifier. | ?identifier=EPH2021-26 |
viewer | Monuments that have this type of viewer: potree (PoTree (point cloud)), 3dhop (3DHOP (mesh)), hbim (HBIM (Building Information Model)), aton (ATON (3D reconstruction)), 360 (360° viewer (panorama)). | ?viewer=3dhop |
classification | Exact classification, e.g. Church. | ?classification=Church |
q | Text contained in the title. | ?q=tomb |
page, page_size | Paging. page_size is 20 by default and at most 100. | ?page=2&page_size=50 |
Example
https://ephemera-test.apac-ser1.org/api/v1/monuments/?page_size=2
{
"count": 14,
"page": 1,
"page_size": 2,
"next": "https://ephemera-test.apac-ser1.org/api/v1/monuments/?page_size=2&page=2",
"previous": null,
"results": [
{
"id": 9,
"identifier": "EPH2021-26",
"persistent_uri": "https://ephemera-test.apac-ser1.org/id/EPH2021-26/",
"url": "https://ephemera-test.apac-ser1.org/othello-tower/",
"title": "Othello Tower",
"classification": "CivicStructure",
"latitude": 35.1266,
"longitude": 33.94445,
"unesco_listed": false,
"usage_rights": "...",
"digital_representation": { "creator": "...", "digitization_technique": "...", ... },
"partners": [ { "name": "The Cyprus Institute", "website": "http://www.cyi.ac.cy" } ],
"viewers": [
{ "type": "potree", "label": "PoTree (point cloud)", "url": "https://..." }
],
...
}
]
}
Fields of a monument
id, identifier, persistent_uri, url, title, place, type, classification, date, period, culture, dimensions, description (HTML), bibliography (HTML), image_url, same_as, latitude, longitude, unesco_listed, credit_line, usage_rights, digital_representation, maker, partners, viewers. Empty values are null.
Errors are returned as {"error": "..."} with status 400 (wrong parameter) or 404 (not found).