API Access Guide

Read-only API access for this domain.

Updated: 2026-04-16

Base URL

• current API origin (dataset by host)

City is inferred from host.

Authentication

All data endpoints require an API key.

• Recommended: X-API-Key: YOUR_API_KEY
• Alternative: Authorization: Bearer YOUR_API_KEY

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.current-domain/categories"

Main Data Endpoints

• GET /categories - active categories
• GET /category?q=...&limit=... - list/category lookup
• GET /comment?q=...&limit=... - keyword search
• GET /address?idaddress=... - full location details
• GET /address?name=... - fuzzy location lookup
• GET /pick-of-day - daily pick

Methods are GET-only.

Restricted AI Endpoints

• GET /search-json?q=... and GET /search-api?q=... are AI-powered (paid usage).
• GET /search?q=... is also treated as protected AI search.
• Access can be blocked per API key with endpoint policy.

Security Policy Notes

• Keys can be restricted by source IP allowlist.
• Allowlist accepts exact IP and CIDR (example: 50.3.70.0/24).
• Wildcard IP format is not supported (example: 50.3.70.*).
• Keys can have per-minute and per-day quotas.

Error Format

{
  "ok": false,
  "error": "error_code",
  "message": "Human readable message"
}

Status and error examples: 401 unauthorized, 403 forbidden_ip, 403 forbidden_endpoint, 429 rate_limited, 429 daily_quota_exceeded.

Support

For onboarding and quota changes, contact hello@gurulist.net.