API Reference

Integrate the Status API

A premium REST API to query Shariah-compliant cryptocurrency status. Built for developers, trusted by platforms. One request gives you a clear Halal, Haram, or Suspicious verdict.

Get an API key Full API Documentation

Authentication

Authenticate requests by providing your API key in the header.

Header:

X-API-Key: chal_live_...

Alternative:

Authorization: Bearer chal_live_...

Core Endpoints

The API provides a set of stable endpoints for single or bulk lookups.

GET

/v1/status/check?q=BTC&exact=true

Preferred lookup for one ticker or observed name.

POST

/v1/status/check/bulk

Bulk status checks for plans with bulk entitlement.

GET

/v1/status/current

Paginated latest status records with stable ruling IDs.

Example Request

A standard lookup returns a verdict of Halal, Haram, or Doubtful.

request.sh

$ curl -H "X-API-Key: chal_live_..." "https://api.cryptohalalstatus.com/v1/status/check?q=BTC&exact=true"

{
  "name": "Bitcoin",
  "ticker": "BTC",
  "judgment": "halal",
  "reason": "Standard cryptocurrency",
  "source": "Crypto Islam",
  "updated_at": "2024-03-10T00:00Z"
}

Rate Limits & Plans

Rate limits are governed by your subscription plan. Standard rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining) are returned with every request.

View available plans