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 is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

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 HTTP Bearer Auth. Provide your API key as the bearer token value in the Authorization 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 https://api.halalbites.co/v1/restaurants \-H "Authorization: Bearer hb_prd_YOUR_API_KEY_HERE"

GET

Search Restaurants

Search for halal restaurants based on a variety of parameters including location, search term, dietary preferences, and radius.

Query Parameters

Parameter	Type	Description
`q`	string	Optional. Search term for name or cuisine.
`lat`	float	Required. Latitude of the center point.
`lng`	float	Required. Longitude of the center point.
`radius`	integer	Optional. Radius in miles (default 10, max 50).

Example Request

GET https://api.halalbites.co/v1/restaurants/search?lat=40.7128&lng=-74.0060&radius=10

Response200 OK

{
  "data": [
    {
      "id": "rest_01G8Z...",
      "name": "The Halal Guys",
      "type": "food_cart",
      "rating": 4.8,
      "review_count": 1250,
      "distance_miles": 0.3,
      "location": {
        "address": "6th Ave & W 53rd St",
        "city": "New York",
        "state": "NY",
        "zip": "10019",
        "lat": 40.7618,
        "lng": -73.9776
      },
      "verification": {
        "status": "verified",
        "type": "community",
        "last_verified_at": "2023-10-14T00:00:00Z"
      }
    }
  ],
  "meta": {
    "total": 45,
    "has_more": true
  }
}

GET

Get Restaurant

Retrieves the details of a specific restaurant, including operating hours, full address, and halal certification evidence if provided.

Path Parameters

Parameter	Type	Description
`id`	string	Required. The unique identifier of the restaurant.

Example Request

GET https://api.halalbites.co/v1/restaurants/rest_01G8Z...

Response200 OK

{
  "id": "rest_01G8Z...",
  "name": "The Halal Guys",
  "type": "food_cart",
  "phone": "+12125550198",
  "website": "https://thehalalguys.com",
  "rating": 4.8,
  "review_count": 1250,
  "location": {
    "address": "6th Ave & W 53rd St",
    "city": "New York",
    "state": "NY",
    "zip": "10019",
    "lat": 40.7618,
    "lng": -73.9776
  },
  "hours": {
    "monday": ["10:00", "04:00"],
    "tuesday": ["10:00", "04:00"],
    "wednesday": ["10:00", "04:00"],
    "thursday": ["10:00", "04:00"],
    "friday": ["10:00", "05:00"],
    "saturday": ["10:00", "05:00"],
    "sunday": ["10:00", "04:00"]
  },
  "verification": {
    "status": "verified",
    "type": "community",
    "details": "Known fully halal menu."
  }
}