Developer API

Read-only JSON endpoints for clinics, apps, and research tools. Attribution to RxHalal required. No write access to user data.

Endpoints

GET /api/public/catalog-index
Paginated medicine id index (`page`, `pageSize` up to 100). Cache 24h.
/api/public/catalog-index
GET /api/public/health
Catalog counts, detection engine version, timestamp.
/api/public/health
GET /api/public/medicine/{id}
Halal status summary for a medicine id (e.g. paracetamol-500).
Example: /api/public/medicine/paracetamol-500
GET /api/public/ingredient/{id}
Ingredient status and plain-language summary (e.g. gelatin).
Example: /api/public/ingredient/paracetamol-500
GET /api/public/barcode/{gtin}
Resolve a GTIN/UPC to a medicine summary (offline catalog map).
/api/public/barcode/{gtin}
GET /api/public/search?q=
Search medicines and ingredients (max 25 results, `limit` param).
/api/public/search?q=
POST /api/public/feedback
Optional feedback queue (rate-limited).
/api/public/feedback

CORS: Access-Control-Allow-Origin: * on GET endpoints.
Rate limits (per IP): ~120 read requests / 10 min; health ~60 / 10 min; feedback 8 / 10 min. HTTP 429 includes Retry-After.
Cache responses client-side; use /api/public/catalog-index for bulk id lists.
Link back to the canonical medicine page on RxHalal.
Not medical or religious advice — informational status only.