API Documentation
Documentation to enable Accessibel data to be integrated into other services
Authentication
There is no authentication required. This API provides a simple way to retrieve all publicly available data related to the Accessibel project.
Please note however the API is currently rate-limited to 10 requests per minute.
Stories
Get a listing of all public stories
/stories
Request Type: GET
Retrieves a basic listing of all available stories.
Example: GET https://admin.accessibel.co.nz/api/v2/stories
{
"stories": [
{
"id": 1,
"slug": "outlet-track-wanaka-doc",
"name": "Outlet Track Wanaka (DOC)",
"description": "Spectacular scenery and popular with walkers and bikers, the track follows the Clutha River/Mata-Au from its start/finishes at the Lake Wanaka Outlet Road and Hikuwai Reserve in Albert Town. This stretch of the river is world-renowned for its trout fishing. Bikers must ride with care, give way to walkers and if possible use the Hikuwai Track above at busy times.",
"published_at": "2021-05-20T05:45:41.000000Z",
"latitude": "-44.67506740",
"longitude": "169.18618760",
"project_name": "Dunedin Walkways",
"project_slug": "dunedin-walkways",
"cover_image": "https://admin.accessibel.co.nz/storage/images/33/hjVyJDJoLD.jpg?v=1619331940"
},
{
"id": 24,
"slug": "halswell-quarry-rim-track",
"name": "Halswell Quarry - Rim Track",
"description": "The Halswell Quarry Rim Track navigates around the top of the quarry crater. It features a number of viewing platforms with stunning views across Canterbury.",
"published_at": "2021-05-20T05:38:20.000000Z",
"latitude": "-43.59873660",
"longitude": "172.57976240",
"project_name": "Christchurch City Council",
"project_slug": "christchurch-city-council",
"cover_image": "https://admin.accessibel.co.nz/storage/images/21/4nih6kvIcx.jpg?v=1619331939"
},
...
]
}
Get a single story’s full data-set
/stories/slug
Request Type: GET
Example: GET https://admin.accessibel.co.nz/api/v2/stories/halswell-quarry-rim-track
This retrieves a full data-set for a single story. Not the returned data-set will contain a story array and also separately points data for that story.
Story slugs can be retrieved in the global /stories GET endpoint as above.
{
"story": {
"id": 24,
"name": "Halswell Quarry - Rim Track",
"slug": "halswell-quarry-rim-track",
"description": "The Halswell Quarry Rim Track navigates around the top of the quarry crater. It features a number of viewing platforms with stunning views across Canterbury.",
"story_line": [
[
172.57985651493078,
-43.598772839822786
],
[
172.5799906253815,
-43.598780609501929
],
[
172.58005499839786,
-43.598776724662478
],
...
],
"published_at": "2021-05-20T05:38:20.000000Z",
"project_name": null,
"project_slug": null,
"cover_image": "https://admin.accessibel.co.nz/storage/images/21/4nih6kvIcx.jpg?v=1619331939"
},
"points": [
{
"id": 232,
"name": "Walk",
"rating": 1,
"description": "Two ways up into the quarry rim track. Left is sealed, however, the right track leads onto the main track.",
"category": {
"id": 2,
"category": "point_category",
"value": "entry",
"display_order": 2,
"meta1": "pos-entry",
"meta2": "",
"meta3": null,
"meta4": null
},
"latitude": "-43.59873660",
"longitude": "172.57976240",
"cover_image": "https://admin.accessibel.co.nz/storage/images/820/6h5eGgWcfN.jpg?v=1619331973"
},
{
"id": 233,
"name": "Walk",
"rating": -1,
"description": "Left track doesn't link up. Separated by a gutter.",
"category": {
"id": 5,
"category": "point_category",
"value": "pathway",
"display_order": 5,
"meta1": "pos-pathway",
"meta2": "",
"meta3": null,
"meta4": null
},
"latitude": "-43.59882540",
"longitude": "172.58011000",
"cover_image": "https://admin.accessibel.co.nz/storage/images/823/dr1bPGAiVp.jpg?v=1619331973"
},
...
]
}