Developers and AI agents
HappyWay Public Data API
HappyWay makes selected public places, activities, events, shared playlists, and image metadata available through a documented, read-only API. Start with the API entry point or the OpenAPI description—no prior knowledge of the application is required.
Start here
- API entry point — links to the public collections and current catalog metadata.
- OpenAPI 3.1 description — the machine-readable contract for this public API.
- All public images — the canonical live image catalog, with pagination and metadata.
- API catalog — the RFC 9727 discovery document for automated clients.
All public images
https://happyway.ca/api/public/v1/images is the live, paginated catalog for agents that need image URLs and context. Each record identifies its public source, description or derived alt text, canonical content page, content URL, thumbnail URL when available, and whether HappyWay hosts the bytes. Use the documented cursor instead of attempting to enumerate storage paths.
For a complete point-in-time export, first request https://happyway.ca/api/public/v1/images/snapshot. Its manifest links to the latest compressed NDJSON download and provides integrity and freshness metadata.
# Read the first page of the live image catalog curl -H "Accept: application/json" https://happyway.ca/api/public/v1/images?limit=50 # Read the latest bulk snapshot manifest curl -H "Accept: application/json" https://happyway.ca/api/public/v1/images/snapshot
Read-only resources
| Resource | Use |
|---|---|
| /listings | Search and page through public listings; retrieve one listing by ID. |
| /playlists | Browse shared public playlists only. |
| /tags | Read the public, non-hidden taxonomy. |
| /images | Locate public content images and their public metadata. |
# Search listings, then follow the next cursor from the response curl -G https://happyway.ca/api/public/v1/listings --data-urlencode "q=music" --data-urlencode "city=Nelson" --data-urlencode "limit=50"
Public-data and image-use boundaries
- The API exposes only deliberately public data; it is not a database export.
- Authenticated, administrative, vendor, user-profile, and private content are not part of this interface.
- Respect response cache headers, pagination links, rate-limit responses, and
Retry-Afterwhen present. - Public availability does not grant a copyright license or reuse permission. Confirm rights with the original source before reuse.