Get an Evidence Packet
curl --request GET \
--url https://api.halal.sh/v1/instruments/{symbol}/evidence \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.halal.sh/v1/instruments/{symbol}/evidence"
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}/evidence', 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}/evidence",
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}/evidence"
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}/evidence")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halal.sh/v1/instruments/{symbol}/evidence")
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": {
"instrument": {
"symbol": "<string>",
"name": "<string>",
"exchange": "<string>"
},
"as_of": "2023-12-25",
"period": "FY2026",
"currency": "USD",
"methodology": {
"id": "aaoifi-ss21",
"version": "2026.1",
"name": "AAOIFI Shariah Standard No. 21"
},
"determination": {
"confidence": 123,
"reason_codes": [
"all_screens_pass",
"high_data_quality"
],
"purification": {
"required": true,
"percentage": 1.012,
"amount_per_1000": 10.12
}
},
"screens": [
{
"name": "debt_to_market_cap",
"detail": {
"primary_activities": [
"<string>"
],
"prohibited_activities": [
"<string>"
],
"concerns": [
"<string>"
]
},
"metric": {
"value": 123,
"note": "<string>",
"threshold": 123,
"operator": "<=",
"formula": "total_interest_bearing_debt / market_cap",
"numerator": {
"value": 123,
"label": "<string>",
"components": {}
},
"denominator": {
"value": 123,
"label": "Spot Market Cap",
"method": "spot",
"months_used": 123
}
},
"sources": [
{
"filing_type": "10-Q",
"accession_number": "0001045810-26-000052",
"period_end": "2023-12-25",
"filing_date": "2023-12-25",
"xbrl_tags": [
"us-gaap:LongTermDebt"
],
"extraction_strategy": "PrimaryFields",
"raw_values": {}
}
]
}
],
"confidence_detail": {
"score": 123,
"base_confidence": 123,
"extraction_strategies_used": [
"<string>"
],
"fallbacks_used": [
"<string>"
],
"penalties": [
{
"type": "<string>",
"impact": 123,
"reason": "<string>"
}
],
"boosts": [
{
"type": "<string>",
"impact": 123,
"reason": "<string>"
}
]
},
"stability": {
"quarters_compliant": 123,
"quarters_total": 123,
"flip_rate": 123,
"closest_threshold": {
"screen": "prohibited_revenue",
"current_distance": 0.041
},
"stability_drivers": [
{
"code": "<string>",
"message": "<string>"
}
]
},
"disclosures": [
"<string>"
]
},
"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 Evidence Packet
Returns a complete compliance audit bundle: the determination, every screen with its calculation and source filings (accession number, XBRL tags, extraction strategy, raw values), a confidence breakdown, and stability metrics. Built for audit, reporting, and reproducibility.
Returns 404 while the stock’s analysis is still pending.
GET
/
instruments
/
{symbol}
/
evidence
Get an Evidence Packet
curl --request GET \
--url https://api.halal.sh/v1/instruments/{symbol}/evidence \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.halal.sh/v1/instruments/{symbol}/evidence"
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}/evidence', 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}/evidence",
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}/evidence"
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}/evidence")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halal.sh/v1/instruments/{symbol}/evidence")
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": {
"instrument": {
"symbol": "<string>",
"name": "<string>",
"exchange": "<string>"
},
"as_of": "2023-12-25",
"period": "FY2026",
"currency": "USD",
"methodology": {
"id": "aaoifi-ss21",
"version": "2026.1",
"name": "AAOIFI Shariah Standard No. 21"
},
"determination": {
"confidence": 123,
"reason_codes": [
"all_screens_pass",
"high_data_quality"
],
"purification": {
"required": true,
"percentage": 1.012,
"amount_per_1000": 10.12
}
},
"screens": [
{
"name": "debt_to_market_cap",
"detail": {
"primary_activities": [
"<string>"
],
"prohibited_activities": [
"<string>"
],
"concerns": [
"<string>"
]
},
"metric": {
"value": 123,
"note": "<string>",
"threshold": 123,
"operator": "<=",
"formula": "total_interest_bearing_debt / market_cap",
"numerator": {
"value": 123,
"label": "<string>",
"components": {}
},
"denominator": {
"value": 123,
"label": "Spot Market Cap",
"method": "spot",
"months_used": 123
}
},
"sources": [
{
"filing_type": "10-Q",
"accession_number": "0001045810-26-000052",
"period_end": "2023-12-25",
"filing_date": "2023-12-25",
"xbrl_tags": [
"us-gaap:LongTermDebt"
],
"extraction_strategy": "PrimaryFields",
"raw_values": {}
}
]
}
],
"confidence_detail": {
"score": 123,
"base_confidence": 123,
"extraction_strategies_used": [
"<string>"
],
"fallbacks_used": [
"<string>"
],
"penalties": [
{
"type": "<string>",
"impact": 123,
"reason": "<string>"
}
],
"boosts": [
{
"type": "<string>",
"impact": 123,
"reason": "<string>"
}
]
},
"stability": {
"quarters_compliant": 123,
"quarters_total": 123,
"flip_rate": 123,
"closest_threshold": {
"screen": "prohibited_revenue",
"current_distance": 0.041
},
"stability_drivers": [
{
"code": "<string>",
"message": "<string>"
}
]
},
"disclosures": [
"<string>"
]
},
"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

