Screen instruments
curl --request POST \
--url https://api.halal.sh/v1/screen \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"symbols": [
"AAPL",
"MSFT",
"NVDA",
"JPM"
],
"sector": "<string>",
"limit": 50,
"offset": 0
}
'import requests
url = "https://api.halal.sh/v1/screen"
payload = {
"symbols": ["AAPL", "MSFT", "NVDA", "JPM"],
"sector": "<string>",
"limit": 50,
"offset": 0
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
symbols: ['AAPL', 'MSFT', 'NVDA', 'JPM'],
sector: '<string>',
limit: 50,
offset: 0
})
};
fetch('https://api.halal.sh/v1/screen', 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/screen",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'symbols' => [
'AAPL',
'MSFT',
'NVDA',
'JPM'
],
'sector' => '<string>',
'limit' => 50,
'offset' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.halal.sh/v1/screen"
payload := strings.NewReader("{\n \"symbols\": [\n \"AAPL\",\n \"MSFT\",\n \"NVDA\",\n \"JPM\"\n ],\n \"sector\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.halal.sh/v1/screen")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"symbols\": [\n \"AAPL\",\n \"MSFT\",\n \"NVDA\",\n \"JPM\"\n ],\n \"sector\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halal.sh/v1/screen")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"symbols\": [\n \"AAPL\",\n \"MSFT\",\n \"NVDA\",\n \"JPM\"\n ],\n \"sector\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"symbol": "AAPL",
"name": "Apple Inc.",
"market_data": {
"price": 123,
"change_24h": 123,
"change_percent_24h": 123
}
}
],
"meta": {
"request_id": "req_abc123",
"as_of": "2023-11-07T05:31:56Z",
"methodology": "aaoifi-ss21@2026.1",
"total": 123,
"requested": 123,
"not_found": [
"<string>"
],
"sandbox_restricted": [
"<string>"
],
"limit": 123,
"offset": 123
}
}{
"error": {
"code": "bad_request",
"message": "Maximum 50 symbols per request."
},
"meta": {
"request_id": "req_abc123"
}
}{
"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": "rate_limit_exceeded",
"message": "Daily request limit (100) exceeded. Resets at midnight UTC.",
"retry_after": 3600
},
"meta": {
"request_id": "req_abc123"
}
}Screening
Screen Instruments
Screen stocks in one request. Provide either:
symbols— up to 50 specific stock tickers (available on every plan), or- filters (
status,sector,market_cap,health) to discover matching stocks across the universe (requires the Plus plan).
This endpoint screens equities. ETF tickers don’t resolve here — they
are returned in meta.not_found; use GET /etfs/{symbol} for funds.
Returns 200 with an empty array when nothing matches.
POST
/
screen
Screen instruments
curl --request POST \
--url https://api.halal.sh/v1/screen \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"symbols": [
"AAPL",
"MSFT",
"NVDA",
"JPM"
],
"sector": "<string>",
"limit": 50,
"offset": 0
}
'import requests
url = "https://api.halal.sh/v1/screen"
payload = {
"symbols": ["AAPL", "MSFT", "NVDA", "JPM"],
"sector": "<string>",
"limit": 50,
"offset": 0
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
symbols: ['AAPL', 'MSFT', 'NVDA', 'JPM'],
sector: '<string>',
limit: 50,
offset: 0
})
};
fetch('https://api.halal.sh/v1/screen', 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/screen",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'symbols' => [
'AAPL',
'MSFT',
'NVDA',
'JPM'
],
'sector' => '<string>',
'limit' => 50,
'offset' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.halal.sh/v1/screen"
payload := strings.NewReader("{\n \"symbols\": [\n \"AAPL\",\n \"MSFT\",\n \"NVDA\",\n \"JPM\"\n ],\n \"sector\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.halal.sh/v1/screen")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"symbols\": [\n \"AAPL\",\n \"MSFT\",\n \"NVDA\",\n \"JPM\"\n ],\n \"sector\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halal.sh/v1/screen")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"symbols\": [\n \"AAPL\",\n \"MSFT\",\n \"NVDA\",\n \"JPM\"\n ],\n \"sector\": \"<string>\",\n \"limit\": 50,\n \"offset\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"symbol": "AAPL",
"name": "Apple Inc.",
"market_data": {
"price": 123,
"change_24h": 123,
"change_percent_24h": 123
}
}
],
"meta": {
"request_id": "req_abc123",
"as_of": "2023-11-07T05:31:56Z",
"methodology": "aaoifi-ss21@2026.1",
"total": 123,
"requested": 123,
"not_found": [
"<string>"
],
"sandbox_restricted": [
"<string>"
],
"limit": 123,
"offset": 123
}
}{
"error": {
"code": "bad_request",
"message": "Maximum 50 symbols per request."
},
"meta": {
"request_id": "req_abc123"
}
}{
"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": "rate_limit_exceeded",
"message": "Daily request limit (100) exceeded. Resets at midnight UTC.",
"retry_after": 3600
},
"meta": {
"request_id": "req_abc123"
}
}Authorizations
Body
application/json
Specific tickers to screen (max 50). Available on every plan.
Maximum array length:
50Example:
["AAPL", "MSFT", "NVDA", "JPM"]
Filter by compliance status (Plus plan). String or array.
Available options:
compliant, non-compliant, pending Filter by sector, e.g. "Technology" (Plus plan).
Filter by market-cap band (Plus plan). String or array.
Available options:
small, mid, large, mega Filter by financial health (Plus plan). String or array.
Available options:
fragile, robust, antifragile Required range:
x <= 100⌘I

