Public API · OpenAPI 3.1

HalalCrypto Public Data API

Read-only access to the top-200 halal-coin classification dataset and the 1,869-trade backtest results dataset; CORS-open. No authentication. CC-BY-4.0.

Download spec (openapi.yaml)View datasets Research notesCORS · Access-Control-Allow-Origin: *Cache · public, max-age=3600No auth · no API key

Quick start

# Halal-coin classification, halal only
curl "https://gethalalcrypto.com/api/datasets/halal-coins?status=halal"

# Backtest dataset, Multi-X tier in 2024 only
curl "https://gethalalcrypto.com/api/datasets/backtests-2025-2026?tier=Multi-X&from=2024-01-01&to=2024-12-31&limit=50"

# Programmatic (Python — Parquet for analysis)
import pandas as pd
df = pd.read_parquet("https://gethalalcrypto.com/datasets/backtests-2025-2026.parquet")
df.groupby(["tier", "pair"])["pnl_pct"].agg(["count", "mean", "sum"])

Endpoints

Read-only dataset routes

Open raw OpenAPI

GET/api/datasets/halal-coins

Top-200 halal-coin classification

Returns halal, haram, and uncertain classifications with per-coin reasoning, AAOIFI notes, source authorities, and last review date.

Try route

Query parameters

status: Filter by halal, haram, uncertain; comma-separated.
symbol: Exact ticker match, case-insensitive.
q: Search name, ticker, or CoinGecko id.
limit: 1-200 rows. Default 200.

Example

curl "https://gethalalcrypto.com/api/datasets/halal-coins?status=halal&limit=25"

GET/api/datasets/backtests-2025-2026

4-year spot backtest results

Returns anonymized spot trade rows across Conservative, Moderate, and Multi-X tiers, calibrated to the published whitepaper figures.

Try route

Query parameters

tier: Conservative, Moderate, Multi-X; comma-separated.
pair: Exact spot pair, for example BTC/USDT.
from: Inclusive lower timestamp bound.
to: Inclusive upper timestamp bound.
limit: 1-5000 rows. Default 200.
offset: Pagination offset. Default 0.

Example

curl "https://gethalalcrypto.com/api/datasets/backtests-2025-2026?tier=Multi-X&from=2024-01-01&to=2024-12-31&limit=50"

Contract

Response shape

Dataset metadata: @context, @type, name, version, license
Applied filters: filters_applied object reflects every query filter used
Totals: rows plus status/tier-specific counts where relevant
Rows: Typed dataset rows, safe for direct research imports

Operational notes

No auth, cache-friendly, citable

No API key. Send no cookies or credentials.
CORS-open for browser notebooks and static sites.
CDN cache is safe for public research data.
License is CC-BY-4.0 with attribution.

Public API · OpenAPI 3.1

HalalCrypto Public Data API

Read-only access to the top-200 halal-coin classification dataset and the 1,869-trade backtest results dataset; CORS-open. No authentication. CC-BY-4.0.

Download spec (openapi.yaml)View datasets Research notesCORS · Access-Control-Allow-Origin: *Cache · public, max-age=3600No auth · no API key

Quick start

# Halal-coin classification, halal only
curl "https://gethalalcrypto.com/api/datasets/halal-coins?status=halal"

# Backtest dataset, Multi-X tier in 2024 only
curl "https://gethalalcrypto.com/api/datasets/backtests-2025-2026?tier=Multi-X&from=2024-01-01&to=2024-12-31&limit=50"

# Programmatic (Python — Parquet for analysis)
import pandas as pd
df = pd.read_parquet("https://gethalalcrypto.com/datasets/backtests-2025-2026.parquet")
df.groupby(["tier", "pair"])["pnl_pct"].agg(["count", "mean", "sum"])

Endpoints

Read-only dataset routes

Open raw OpenAPI

GET/api/datasets/halal-coins

Top-200 halal-coin classification

Returns halal, haram, and uncertain classifications with per-coin reasoning, AAOIFI notes, source authorities, and last review date.

Try route

Query parameters

status: Filter by halal, haram, uncertain; comma-separated.
symbol: Exact ticker match, case-insensitive.
q: Search name, ticker, or CoinGecko id.
limit: 1-200 rows. Default 200.

Example

curl "https://gethalalcrypto.com/api/datasets/halal-coins?status=halal&limit=25"

GET/api/datasets/backtests-2025-2026

4-year spot backtest results

Returns anonymized spot trade rows across Conservative, Moderate, and Multi-X tiers, calibrated to the published whitepaper figures.

Try route

Query parameters

tier: Conservative, Moderate, Multi-X; comma-separated.
pair: Exact spot pair, for example BTC/USDT.
from: Inclusive lower timestamp bound.
to: Inclusive upper timestamp bound.
limit: 1-5000 rows. Default 200.
offset: Pagination offset. Default 0.

Example

curl "https://gethalalcrypto.com/api/datasets/backtests-2025-2026?tier=Multi-X&from=2024-01-01&to=2024-12-31&limit=50"

Contract

Response shape

Dataset metadata: @context, @type, name, version, license
Applied filters: filters_applied object reflects every query filter used
Totals: rows plus status/tier-specific counts where relevant
Rows: Typed dataset rows, safe for direct research imports

Operational notes

No auth, cache-friendly, citable

No API key. Send no cookies or credentials.
CORS-open for browser notebooks and static sites.
CDN cache is safe for public research data.
License is CC-BY-4.0 with attribution.