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.

API Endpoint

Our API endpoint is a GET request and returns json. No authentication is required.

/api/v1/displacement

Our displacement maps endpoint returns an array of objects. Each object represents an individual forced displacement map.

The endpoint returns every published map in our database. There is no pagination.

Every attribute of an object, except the id (int) is a string. An empty string is used instead of null when there is no value.

Fields returned

  • id: (int) Unique ID, assigned internally by our database. Meaningless except as an identifier.
  • date: (string) The earliest date we can find that the IDF posted this map. Date is in SQL format (yyyy-mm-dd).
  • link: (string) Link to the html Gaza Maps page for this displacement order map.
  • map_idf: (string) URL of the map the IDF posted, stored on Gaza Maps server.
  • source: (string) URL of the earliest IDF post we located for this map.
  • map_full: (string) URL of a high resolution readable map, showing all of Gaza.
  • map_zoom: (string) URL of a high resolution readable map, zoomed in on the relevant area.
  • displacement_blocks: (string) Comma separated list of displacement blocks in this order. If the block has ever been split, there will be a decimal (27.1, 27.2, 27.3, [...]).
  • labeled_safe_blocks: (string) Comma separated list of blocks designated "safe" in this order. If the block has ever been split, there will be a decimal (27.1, 27.2, 27.3, [...]).
  • area_sq_km_displacement: (string) In sq km, rounded to two decimal points. Does not include buffer zone outside the specific order. If there is none, the result is "0.00".
  • area_sq_km_labeled_safe: (string) In sq km, rounded to two decimal points. If there is none, the result is "0.00".

Our Definition of Breaking Changes

The v1 API will be improved over time via additional endpoints and new attributes. We will not delete or rename any attributes.

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.