🔌 API Documentation

REST API for Coolock Village civic data. Schema.org compliant. CORS enabled.

Quick Start

bash

# List all businesses
curl https://coolockvillage.ie/api/v1/businesses

# Search for restaurants
curl "https://coolockvillage.ie/api/v1/businesses?schemaType=Restaurant"

# Get a specific business
curl https://coolockvillage.ie/api/v1/businesses/spar-malahide-road

# Check for changes since a date
curl "https://coolockvillage.ie/api/v1/diff?since=2026-02-01"

Features

Schema.org

Full JSON-LD with @context, @type, and @id for every entity.

ETag / 304

Conditional requests via If-None-Match. Save bandwidth.

CORS Enabled

Access-Control-Allow-Origin: * with OPTIONS preflight.

Endpoints

GET/api/v1/businesses

List all businesses with optional filtering

Parameters

Name	Type	Description
category	string	Filter by display category (e.g. "Food & Drink")
schemaType	string	Filter by schema.org type (e.g. "Restaurant")
q	string	Free-text search (max 200 chars)

Response: application/json (schema.org ItemList)Cache: max-age=3600, s-maxage=86400

Try it

/api/v1/businesses?category=Food%20%26%20Drink

GET/api/v1/businesses/{id}

Get a single business by canonical ID

Parameters

Name	Type	Description
id	string	URL-safe canonical business ID (e.g. "spar-malahide-road")

Response: application/json (schema.org LocalBusiness)Cache: max-age=3600, s-maxage=86400

Try it

/api/v1/businesses/spar-malahide-road

GET/api/v1/diff

Dataset changes since a given date. For sync/ingestion.

Parameters

Name	Type	Description
since	string	ISO 8601 date (e.g. "2026-02-01")

Response: application/jsonCache: max-age=300

Try it

/api/v1/diff?since=2026-02-01

Static Exports

/data/businesses-canonical.json

Full canonical business dataset as static JSON. No API key required.

JSON

/llms.txt

Public site summary for discovery tools.

Text

Response Headers

Header	Description
ETag	Dataset version hash. Use with `If-None-Match` for 304 responses.
Cache-Control	CDN and browser caching directives.
Vary	`Accept-Encoding` — for proper CDN cache keys.
X-Dataset-Version	SemVer of the dataset schema (list endpoint only).
Access-Control-Allow-Origin	`*` — open CORS for all origins.