API Documentation
Thank you for considering building with our API. Our mission is to facilitate memory and accountability, and we hope our API helps you, as you work towards the same goals.
We will not implement any breaking changes to v1 of the API, as long as you don't hardcode taxonomy terms or assume that the number of attributes for each martyr will be constant. We will add (not edit or delete) attributes and vocabulary terms. Please build around that expectation, using the guidelines below, and your app's integration with our API should be reliable for years to come.
API Endpoints
All endpoints are GET requests and return json. No authentication is required.
-
All Martyrs: not grouped
/api/v1/martyrs -
Single Martyr: most recently killed
/api/v1/martyrs/latest -
All Martyrs: grouped by Location
/api/v1/martyrs/location -
All Martyrs: grouped by Weapon
/api/v1/martyrs/weapon
Our Definition of Breaking Changes
The v1 API will be improved over time via additional endpoints, new attributes, and more categorization (vocabulary terms, ie: locations or weapons). We do not consider additional endpoints, attributes, or vocabulary terms to be breaking changes.
New Attributes
We will not rename or delete any attributes from the current version of our API. We will likely add additional attributes to the current API version. For example, we have plans to add the gender for each journalist.
New Categories / Vocabulary Terms
Please use the categorization provided by the API and do not hard-code the vocabulary terms. For example, we might add a new location if Israel murders a journalist in Yemen or Iraq.
New Endpoints
We are open to potentially building custom endpoints to support an interesting project. If our endpoints are not sufficient for your idea, please reach out to us and we can discuss custom API endpoints.
API Responses
Every API endpoint (except /api/v1/martyrs/latest
) will return an indexed array of martyred journalist records. Some endpoints group or filter
the martyr arrays according to an attribute.