Overview
Use Halal Eats restaurant data through the JavaScript SDK or HTTP API.
Halal Eats helps apps find halal restaurants, inspect restaurant details, and submit community contributions for review.
If you are building with Halal Eats, start with the JavaScript SDK. Use the HTTP API directly when you need lower-level control.
Start here
JavaScript SDK
Install @halal-eats/sdk and fetch halal restaurant data in a few lines.
HTTP API quickstart
Call the Halal Eats API directly with fetch or curl.
Restaurant endpoints
Search, nearby lookup, restaurant details, categories, and public stats.
Contributions
Submit restaurant suggestions, reviews, photos, menu items, and reports.
Errors and limits
Pagination limits, nearby radius limits, and error response shapes.
What you can build
- restaurant discovery experiences
- halal restaurant search pages
- maps and nearby search
- cuisine/category filters
- restaurant detail views
- community contribution flows
Recommended path
- Install
@halal-eats/sdk. - Fetch restaurant data with
client.stores.list. - Use
client.stores.nearbyfor location-based search. - Use the HTTP API docs when you need exact request/response details.
API base URL
https://eatinghalal.vercel.app/api/v1SDK install
npm install @halal-eats/sdk