AboutFAQDownloadBlogAPILocationsFor BusinessesContact Us

API Reference

Get API Key
Version 1.0.0

Introduction

Welcome to the Halal Bites API documentation. The API provides programmatic access to the world's most comprehensive verified halal restaurant and food truck database.

Our API uses predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs. The base URL for all endpoints is https://api.halalbites.co.

Authentication

The Halal Bites API uses API keys to authenticate requests. You can view and manage your API keys in your Developer Dashboard.

Authentication to the API is performed via a custom header. Provide your API key in the x-api-key header.

Keep your API keys secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
cURL Example
curl -X POST https://api.halalbites.co/list \-H "x-api-key: hb_prd_YOUR_API_KEY_HERE" \-H "Content-Type: application/json"
POST

Get Restaurant List View

Fetch a list of restaurants matching search, location, and filter criteria.

JSON Body Parameters
ParameterTypeDescription
lat & lngnumberRequired. Latitude and longitude for searching.
radiusnumberRequired. Search radius.
limit & offsetnumberRequired. Pagination controls.
Example Request
POST https://api.halalbites.co/list
POST

Get Restaurant Details

Fetch detailed information for a single restaurant by ID.

JSON Body Parameters
ParameterTypeDescription
restaurant_idintegerRequired. The unique ID of the restaurant.
Example Request
POST https://api.halalbites.co/details
POST

Report Item

Submit a report against a restaurant, post, or collection.

JSON Body Parameters
ParameterTypeDescription
report_to_idintegerRequired. ID of the target element being reported.
report_typestringRequired. e.g., RESTAURANT, POST, COMMENT.
Example Request
POST https://api.halalbites.co/report