Skip to main content

Why versioning matters

Serious compliance buyers need to reproduce screening decisions. If a fund was screened on March 1st using a specific set of rules, the same inputs must produce the same outputs months or years later. Every compliance determination includes a methodology version identifier:
aaoifi_standard_21@2026.1
This means: AAOIFI Standard No. 21, halal.sh implementation version 2026.1.

Version format

{standard_id}@{year}.{revision}
  • standard_id — The screening standard (currently aaoifi_standard_21)
  • year — Calendar year of the implementation
  • revision — Incremental revision within the year

What triggers a new version

Change typeVersion bumpExample
Threshold changeMajor (year)AAOIFI revises debt threshold from 30% to 33%
Calculation method changeMinor (revision)Switch from spot to 12-month avg market cap
Extraction improvementNo version changeBetter XBRL tag coverage for a specific field
Bug fix in screening logicMinor (revision)Fixing incorrect threshold comparison
Extraction improvements (better data quality) do not change the methodology version because the screening logic itself hasn’t changed.

Querying a specific version

By default, the API uses the latest methodology version. To pin to a specific version:
curl "https://api.halal.sh/v1/instruments/NVDA/compliance?methodology=aaoifi_standard_21@2026.1" \
  -H "X-API-Key: your_api_key"

Listing available versions

curl https://api.halal.sh/v1/methodologies \
  -H "X-API-Key: your_api_key"
Returns all supported methodologies with their thresholds, calculation basis, and changelog.

Reproducibility guarantees

Given the same:
  1. Methodology version (aaoifi_standard_21@2026.1)
  2. Filing set (identified by filing_set_hash)
  3. Market data snapshot (as of a specific date)
The API will produce the same determination, ratios, and pass/fail results. AI-generated explanation text may vary, but the quantitative outputs are deterministic.