API

Version 1 · free, no key needed · JSON

Base URL: https://halalornot.pages.dev/api/v1. Every response carries a verdict, a plain-English headline, a verdict for each school and the reasoning. An OpenAPI description is at /api/v1/openapi.json (also served at /openapi.json).

Verdicts

halal, doubtful, haram, depends_on_school (the four schools disagree), and for products incomplete_data or no_ingredients. Stocks and funds return depends_on_standard when screening standards disagree. Questions to /ask can also return makruh (disliked), disputed (scholars differ; the answer lists who holds which view), depends (it depends on how or what, explained in the answer) or not_in_rulebook. Every answer also has a say line, one or two sentences to read aloud. Medicines lead with the ruling on necessity.

Check an ingredients list

GET /api/v1/check?ingredients=gelatine,sugar,colour (carmine)&context=food
POST /api/v1/check  {"ingredients": "...", "context": "cosmetic"}

context=cosmetic treats the product as used on the skin, which changes the reading of alcohol and carmine. context=medicine adds medicine rules (heparin, pancreatin, alcohol in medicine) and the rule on necessity.

Check a product by barcode

GET /api/v1/product/5000159461122

Looks the barcode up in Open Food Facts, then Open Beauty Facts. A halal or vegetarian mark recorded on the product is taken into account.

Search by name

GET /api/v1/search?q=haribo starmix&country=united-kingdom

Up to five matches, each with a verdict. country=world removes the country filter.

Explain one ingredient

GET /api/v1/ingredient/E471
GET /api/v1/ingredient/prawns
GET /api/v1/ingredient/alcohol%20denat?context=cosmetic

Screen a stock

GET /api/v1/stock/NVDA

Two tests: what the company does (S&P 500 companies, by industry code) and its debt under AAOIFI, Dow Jones Islamic, S&P Shariah and MSCI Islamic, from Mizan.

Ask anything

GET /api/v1/ask?q=Is a credit card halal if I pay it off?

Covers money (savings, credit cards, buy now pay later, mortgages, student loans, insurance, pensions, trading, gold, gambling), crypto, medicine, food and drink, and everyday life (music, dogs, tattoos, nail polish, smoking, games, photos, jobs and more). Each answer gives the verdict, the main scholarly views with who holds them, and halal alternatives. GET /api/v1/topics lists everything covered.

Prayer times and Ramadan

GET /api/v1/prayer-times?city=Dearborn, Michigan

Today's prayer times for any place, or pass lat and lon. Gives both Asr times (Shafi'i, Maliki and Hanbali, and Hanafi), the Hijri date, and in Ramadan the suhoor and iftar times; outside Ramadan, how many days until it is expected. The calculation method follows the country (ISNA in North America) and can be changed with method. Optional date=YYYY-MM-DD. Times from AlAdhan, places from OpenStreetMap.

Screen a fund, ETF or pension fund

GET /api/v1/fund/VOO
GET /api/v1/fund/SPUS

Shariah funds are recognised by name or ticker. For any other US-registered fund, the latest SEC holdings report (Form N-PORT) is read and every holding is screened by industry and by the four debt screens.

Check a cryptocurrency

GET /api/v1/crypto/bitcoin

Classifies the coin by what it does (lending, gambling, meme, stablecoin, staking, general-purpose) from CoinGecko, with the scholarly views on crypto and on staking, lending and leverage.

Check a medicine

GET /api/v1/medicine?name=creon
GET /api/v1/check?context=medicine&ingredients=...

Reads the active and inactive ingredients from the US label (openFDA) and flags gelatine, alcohol, pig-derived enzymes and heparin, with the rule on necessity.

Reference

GET /api/v1/schools   how the four schools differ
GET /api/v1/rules     the full rulebook
GET /api/v1/health

Example response

{
  "verdict": "depends_on_school",
  "headline": "Depends on your school (Hanafi doubtful, Shafi'i halal, Maliki halal, Hanbali halal), because of prawns and shrimp.",
  "by_school": { "hanafi": { "school": "Hanafi", "verdict": "doubtful", "because": [ ... ] }, ... },
  "findings": [ { "ingredient": "Prawns and shrimp", "verdict": "depends_on_school",
                  "verdict_by_school": { "Hanafi": "doubtful", "Shafi'i": "halal", ... },
                  "why": "...", "school_views": { "Hanafi": "..." } } ],
  "disclaimer": "..."
}

Fair use

Free for personal and commercial use. Please cache results and keep to a few requests a second. Product data comes from Open Food Facts and Open Beauty Facts under the Open Database Licence; credit them when you show it.