Developers
Public API · version 1.0.0
Dharma Rocks offers a free, read-only API so others can build on our open community data - maps, visualisations, or apps that follow rocks on their journeys. Everything it returns is already public, moderated content. It exposes no personal data: only pseudonymous display names and approximate, rounded locations, never emails or precise coordinates.
Getting started
- No authentication or API key is required. Please be considerate with request volume; responses are cached and safe to cache on your side.
- Base URL:
/api/v1(relative to this site). - The full machine-readable description is available as OpenAPI 3.1 - load it into Swagger UI, Postman, or a client generator.
- Content is licensed CC BY 4.0 - please attribute Dharma Rocks.
Example
curl /api/v1/rocks/DR-RIVEREndpoints
Chapters
GET
/api/v1/chaptersEvery approved local Dharma Rocks group.
GET
/api/v1/chapters/{slug}A single approved chapter by its slug.
slug- The chapter's URL slug.
Stories
GET
/api/v1/storiesEvery published story.
GET
/api/v1/stories/{id}A single published story by its id.
id- The story id.
Gallery
GET
/api/v1/galleryEvery published photo of a painted rock.
Rocks
GET
/api/v1/rocksEvery approved rock that can be tracked.
GET
/api/v1/rocks/{code}A single rock by its public code, including its journey (sightings) and any linked stories.
code- The rock's public code, e.g. DR-RIVER.