Get compliance screening
curl --request GET \
--url https://api.halal.sh/v1/instruments/{symbol}/compliance \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.halal.sh/v1/instruments/{symbol}/compliance"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.halal.sh/v1/instruments/{symbol}/compliance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.halal.sh/v1/instruments/{symbol}/compliance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.halal.sh/v1/instruments/{symbol}/compliance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.halal.sh/v1/instruments/{symbol}/compliance")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halal.sh/v1/instruments/{symbol}/compliance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"symbol": "AAPL",
"name": "Apple Inc.",
"methodology": "aaoifi-ss21@2026.1",
"as_of": "2023-11-07T05:31:56Z",
"determination": {
"confidence": 0.95,
"explanation": "<string>"
},
"screens": {
"business_activity": {
"activities": [
"<string>"
],
"prohibited_activities": [
"<string>"
],
"concerns": [
"<string>"
],
"segments": [
{
"name": "iPhone",
"revenue_percentage": 50,
"prohibited_revenue_impact": "negligible",
"significance": "major"
}
]
},
"debt_to_market_cap": {
"value": 0.020616,
"threshold": 0.3,
"operator": "<=",
"buffer": 27.9384
},
"cash_to_market_cap": {
"value": 0.020616,
"threshold": 0.3,
"operator": "<=",
"buffer": 27.9384
},
"prohibited_revenue": {
"value": 0.020616,
"threshold": 0.3,
"operator": "<=",
"buffer": 27.9384
}
},
"revenue": {
"total": 451442000000,
"permissible": {
"amount": 446873510000,
"percentage": 98.988
},
"prohibited": {
"amount": 4568490000,
"percentage": 1.012,
"breakdown": {
"interest_income": 4568490000,
"gambling": 0,
"alcohol": 0,
"weapons": 0,
"tobacco": 0,
"adult_entertainment": 0
}
}
},
"purification": {
"required": true,
"percentage": 1.012,
"amount_per_1000": 10.12
},
"stability": {
"drivers": [
{
"code": "COMFORTABLE_BUFFERS",
"message": "All financial ratios are well within limits"
}
]
},
"filing": {
"summary": "10-K(2025-10-31) + 10-Q(2026-05-01)",
"as_of": "2023-11-07T05:31:56Z",
"hash": "<string>",
"filings": [
{
"type": "10-K",
"period_end": "2023-12-25",
"filing_date": "2023-12-25",
"accession_number": "0000320193-25-000079"
}
]
}
},
"meta": {
"request_id": "req_abc123",
"as_of": "2023-11-07T05:31:56Z",
"methodology": "aaoifi-ss21@2026.1"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
},
"meta": {
"request_id": "req_abc123"
}
}{
"error": {
"code": "sandbox_restricted",
"message": "Symbol 'TSLA' is not available in the sandbox. Upgrade to Plus for full access."
},
"meta": {
"request_id": "req_abc123"
}
}{
"error": {
"code": "not_found",
"message": "No instrument found for symbol 'XYZ'."
},
"meta": {
"request_id": "req_abc123"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Daily request limit (100) exceeded. Resets at midnight UTC.",
"retry_after": 3600
},
"meta": {
"request_id": "req_abc123"
}
}Instruments
Get Compliance
Returns the full AAOIFI Standard 21 determination for a stock: the business-activity screen, all three financial-ratio screens with their thresholds, the revenue breakdown, purification, and a stability signal.
If the stock has not been analysed yet, determination.status is
pending and screens, revenue, purification, stability, and
filing are null.
GET
/
instruments
/
{symbol}
/
compliance
Get compliance screening
curl --request GET \
--url https://api.halal.sh/v1/instruments/{symbol}/compliance \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.halal.sh/v1/instruments/{symbol}/compliance"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.halal.sh/v1/instruments/{symbol}/compliance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.halal.sh/v1/instruments/{symbol}/compliance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.halal.sh/v1/instruments/{symbol}/compliance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.halal.sh/v1/instruments/{symbol}/compliance")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halal.sh/v1/instruments/{symbol}/compliance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"symbol": "AAPL",
"name": "Apple Inc.",
"methodology": "aaoifi-ss21@2026.1",
"as_of": "2023-11-07T05:31:56Z",
"determination": {
"confidence": 0.95,
"explanation": "<string>"
},
"screens": {
"business_activity": {
"activities": [
"<string>"
],
"prohibited_activities": [
"<string>"
],
"concerns": [
"<string>"
],
"segments": [
{
"name": "iPhone",
"revenue_percentage": 50,
"prohibited_revenue_impact": "negligible",
"significance": "major"
}
]
},
"debt_to_market_cap": {
"value": 0.020616,
"threshold": 0.3,
"operator": "<=",
"buffer": 27.9384
},
"cash_to_market_cap": {
"value": 0.020616,
"threshold": 0.3,
"operator": "<=",
"buffer": 27.9384
},
"prohibited_revenue": {
"value": 0.020616,
"threshold": 0.3,
"operator": "<=",
"buffer": 27.9384
}
},
"revenue": {
"total": 451442000000,
"permissible": {
"amount": 446873510000,
"percentage": 98.988
},
"prohibited": {
"amount": 4568490000,
"percentage": 1.012,
"breakdown": {
"interest_income": 4568490000,
"gambling": 0,
"alcohol": 0,
"weapons": 0,
"tobacco": 0,
"adult_entertainment": 0
}
}
},
"purification": {
"required": true,
"percentage": 1.012,
"amount_per_1000": 10.12
},
"stability": {
"drivers": [
{
"code": "COMFORTABLE_BUFFERS",
"message": "All financial ratios are well within limits"
}
]
},
"filing": {
"summary": "10-K(2025-10-31) + 10-Q(2026-05-01)",
"as_of": "2023-11-07T05:31:56Z",
"hash": "<string>",
"filings": [
{
"type": "10-K",
"period_end": "2023-12-25",
"filing_date": "2023-12-25",
"accession_number": "0000320193-25-000079"
}
]
}
},
"meta": {
"request_id": "req_abc123",
"as_of": "2023-11-07T05:31:56Z",
"methodology": "aaoifi-ss21@2026.1"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
},
"meta": {
"request_id": "req_abc123"
}
}{
"error": {
"code": "sandbox_restricted",
"message": "Symbol 'TSLA' is not available in the sandbox. Upgrade to Plus for full access."
},
"meta": {
"request_id": "req_abc123"
}
}{
"error": {
"code": "not_found",
"message": "No instrument found for symbol 'XYZ'."
},
"meta": {
"request_id": "req_abc123"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Daily request limit (100) exceeded. Resets at midnight UTC.",
"retry_after": 3600
},
"meta": {
"request_id": "req_abc123"
}
}Authorizations
Path Parameters
Stock ticker symbol (e.g. AAPL, NVDA, MSFT).
Required string length:
1 - 10Example:
"AAPL"
⌘I

