Introduction

The MaSS API gives access to the data of all the sites covered by MaSS.
There are three methods: Search, List and Get. All methods return json.

To prevent abuse, we limit the access to the API per IP address. If your application stays under 720 queries per hour, you'll be fine. If we detect abuse, we will have to block your IP address.

We will release a new version when we make backwards-incompatible changes.
Latest version: v1.

List

Retrieve all sites.

URL template

https://mass.maritime-heritage.com/api/v1/list/{language}/{wrapper}

Method

GET

Request examples

https://mass.maritime-heritage.com/api/v1/list/
https://mass.maritime-heritage.com/api/v1/list/nl/myCallback()

Parameters

Name Data type Conditions Description Default value
{language} string (optional), one of en, nl Specifies the desired language of the response. en
{wrapper} string (optional) Wrap the response in JavaScript.
If the value contains “()” then the response will be wrapped in: {wrapper}([]);.
Otherwise the response will be wrapped in: var {wrapper} = [];.
null

Response

Returns an array of objects. Each object has the following properties:

Name Data type Description Example
id integer Unique database id 233
code string Unique code utrecht-the
label string Name Utrecht, The
type string Heritage type, one of wreck, site, structure, plane, other wreck
lat float Latitude of location coordinates -12.9938530
lon float Longitude of location coordinates -38.6718750
location string Location name Bahia, Brazil
firstyear signed integer Year of commissioning 1737
lastyear signed integer Year of demise 1740
discovery signed integer Year of discovery 2004
subtype string Specification of the type (in specified language) Frigate

Get

Get the properties of a specific site.

URL template

https://mass.maritime-heritage.com/api/v1/get/{language}/{id}

Method

GET

Request examples

https://mass.maritime-heritage.com/api/v1/get/233
https://mass.maritime-heritage.com/api/v1/get/nl/utrecht-the

Parameters

Name Data type Conditions Description Default value
{language} string (optional), one of en, nl Specifies the desired language of the response. en
{id} string
integer
(required) The unique code (string) or database id (integer). null

Response

Returns an object with the following properties:

Name Data type Description Example
id integer Unique database id 233
code string Unique code utrecht-the
name string Name Utrecht, The
type string Heritage type, one of wreck, site, structure, plane, other wreck
lat float Latitude of location coordinates -12.9938530
lon float Longitude of location coordinates -38.6718750
location string Location name Bahia, Brazil
firstdate date Date of commissioning (yyyy-mm-dd) 1600-01-31
firstyear signed integer Year of commissioning 1737
lastdate date Date of demise (yyyy-mm-dd) 1600-01-31
lastyear signed integer Year of demise 1740
country string Country of origin (in specified language) Nederland
countrycode string ISO 3166-1 alpha-2 code for the country of origin NL
author string Name of the author initialy added the site to the dataset
created_on timestamp Timestamp when the site was added to the dataset 2010-12-06 00:00:00
modified_on timestamp Timestamp when the site data was last modfied 2018-12-17 14:28:17
deleted_on timestamp Timestamp when the site was deleted from the dataset null
body string Description of the site in html format.
license object License for content use
license.title string Name of the license
license.href string Link to the license