بنیادی اعداد، تناسب، مالی گوشوارے اور ڈیویڈنڈ — ساتھ AAOIFI تعمیل فیصلہ — ایک REST کال یا ایک MCP ٹول سے۔ ہر عدد متعدد آزاد ذرائع (SEC EDGAR، Yahoo، Finnhub) سے کراس-تصدیق شدہ؛ دو سے کم ذرائع والی کوئی بھی چیز غیر تصدیق شدہ نشان زد۔ خلیجی اور امریکی مارکیٹس، 7 زبانیں، ایجنٹ-نیٹیو۔
مفت اکاؤنٹ کے ساتھ 3 ماہ کے لیے مفت — ہر چیک، زکوٰۃ ٹولز اور API + MCP سرور تک مکمل رسائی۔ کارڈ کی ضرورت نہیں؛ ادا شدہ پلانز لانچ مدت کے بعد آئیں گے۔ نیچے جدول میں پلان لیبلز مستقبل کی قیمت دکھاتے ہیں؛ لانچ مدت کے دوران کوئی چارج نہیں۔
فوری آغاز — 3 مراحل
صفر سے تعمیل فیصلے تک چند منٹ میں۔
1. اپنی API کلید حاصل کریں
اکاؤنٹ بنائیں
2. اینڈ پوائنٹ کال کریں
3. فیصلہ پڑھیں
مثال درخواست اور جواب
curl https://halalstock.net/v1/stock/2222.SR/halal?profile=standard \
-H "Authorization: Bearer thl_your_key"
{
"symbol": "2222.SR",
"name": "Saudi Arabian Oil Company",
"status": "halal",
"compliance_score": 82,
"confidence": "likely",
"corroborated_by": [], // Sharia-screened funds that also hold it (independent scholar check) — not data sources
"ratios": [
{"name": "debt_ratio", "value": 0.09, "threshold": 0.30, "passed": true},
{"name": "cash_ratio", "value": 0.04, "threshold": 0.30, "passed": true},
{"name": "impure_income_ratio", "value": null, "threshold": 0.05, "passed": null}
],
"risk_level": "safe",
"purification_pct": null,
"reasons": ["Business is permissible and all computable financial ratios pass."],
"explanation": {"en": "...", "ar": "..."},
"disclaimer": "Screening analysis for information only — not a fatwa..."
}
ٹِپ: کوڈ بلاک پر کلک کر کے منتخب کریں، پھر کاپی کریں۔
ابھی آزمائیں
ٹِکر درج کریں اور عوامی اینڈ پوائنٹ پر اصلی اسکرین چلائیں — بغیر کلید، بغیر سائن اپ۔ یہی JSON آپ کا کوڈ واپس پائے گا۔
یہ دستیاب ڈیٹا کا خودکار اسکریننگ نتیجہ ہے — فتویٰ یا یہ فیصلہ نہیں کہ کمپنی حلال ہے۔ status کو confidence کے ساتھ پڑھیں، اور ہمیشہ disclaimer فیلڈ ساتھ بھیجیں۔
SDKs اور کاپی-پیسٹ مثالیں
Python اور JavaScript کے لیے سرکاری بلا انحصار کلائنٹس، ساتھ خام curl کال اور MCP کنفیگ۔ اپنی کلید ایک بار HALALSTOCK_API_KEY کے طور پر سیٹ کریں (یہ thl_ سے شروع ہوتی ہے)۔
import os
from halalstock import HalalStock, HalalStockError
# key from your account (starts with thl_); keyless works too but is IP-metered
hs = HalalStock(api_key=os.environ.get("HALALSTOCK_API_KEY"))
try:
v = hs.check("AAPL") # GET /v1/stock/AAPL/halal
# status is a screening result, not a fatwa — read it with confidence
print(v["status"], v["compliance_score"], v["confidence"])
print(v["disclaimer"]) # always relay this to the user
res = hs.screen(["AAPL", "TSLA", "2222.SR"]) # batch, up to 25
print(res["count"], "screened")
except HalalStockError as e:
print("error", e.status, e.message)
import { HalalStock, HalalStockError } from "./halalstock.js";
// key from your account (starts with thl_); keyless works too but is IP-metered
const hs = new HalalStock(process.env.HALALSTOCK_API_KEY);
try {
const v = await hs.check("AAPL"); // GET /v1/stock/AAPL/halal
// status is a screening result, not a fatwa — read it with confidence
console.log(v.status, v.compliance_score, v.confidence);
console.log(v.disclaimer); // always relay this to the user
const res = await hs.screen(["AAPL", "TSLA", "2222.SR"]); // batch, up to 25
console.log(res.count, "screened");
} catch (e) {
if (e instanceof HalalStockError) console.error(e.status, e.detail);
}
# public — no key needed (metered per IP)
curl "https://halalstock.net/v1/stock/AAPL/halal?profile=standard"
# with your key (starts with thl_) for a higher quota
curl "https://halalstock.net/v1/stock/2222.SR/halal" \
-H "Authorization: Bearer $HALALSTOCK_API_KEY"
# batch screen up to 25 tickers
curl "https://halalstock.net/v1/screen?symbols=AAPL,TSLA,2222.SR" \
-H "Authorization: Bearer $HALALSTOCK_API_KEY"
# add to your MCP client config (e.g. Claude Desktop)
{
"mcpServers": {
"halalstock": {
"command": "python",
"args": ["-m", "tahleel.mcp_server"],
"env": {
"HALALSTOCK_API_URL": "https://halalstock.net",
"HALALSTOCK_API_KEY": "thl_your_key"
}
}
}
}
# then just ask: "Is Aramco (2222.SR) halal?" — the agent calls check_halal()
کلائنٹس ریپو سے لیں: /sdk/python/halalstock.py اور /sdk/javascript/halalstock.js۔ دونوں نیچے دیے گئے انہی REST اینڈ پوائنٹس کو لپیٹتے ہیں۔
AI ایجنٹس کے لیے (MCP)
حلال اسٹاک ایک Model Context Protocol سرور فراہم کرتا ہے۔ Claude Desktop، Cursor، یا کسی بھی MCP کلائنٹ کو اس کی طرف لگائیں اور بس پوچھیں کہ کوئی اسٹاک حلال ہے یا نہیں۔
MCP کلائنٹ کنفیگ
# add to your MCP client config (e.g. Claude Desktop)
{
"mcpServers": {
"halalstock": {
"command": "python",
"args": ["-m", "tahleel.mcp_server"],
"env": {
"HALALSTOCK_API_URL": "https://halalstock.net",
"HALALSTOCK_API_KEY": "thl_your_key"
}
}
}
}
ٹولز اور استعمال
# the server exposes two tools:
# check_halal(symbol, profile="standard")
# screen_portfolio(symbols, profile="standard")
# then just ask the agent:
"Is Aramco (2222.SR) halal?"
"Screen AAPL, TSLA and JPM for Sharia compliance."
# With HALALSTOCK_API_URL + HALALSTOCK_API_KEY set, calls
# go to the hosted, metered API. Without them, the server
# screens locally with no API key (best-effort, via Yahoo —
# US names degrade gracefully; still needs a network connection).
اینڈ پوائنٹ حوالہ
زیادہ تر ریڈ اینڈ پوائنٹس کو کلید کی ضرورت نہیں (فی IP میٹرڈ)؛ کچھ کو کلید، چند کو ادا شدہ پلان چاہیے۔
| اینڈ پوائنٹ | لوٹاتا ہے | توثیق |
|---|---|---|
GET /v1/stock/{symbol}/halal | ایک علامت کا مکمل فیصلہ: حالت، اسکور، تناسب، اعتماد، وجوہات | اختیاری کلید |
GET /v1/screen?symbols= | کاما سے الگ 25 ٹِکرز تک کے بیچ فیصلے | اختیاری کلید |
GET /v1/search?q= | نام یا ٹِکر سے اسٹاکس + ETFs کی کائنات تلاش کریں | اختیاری کلید |
GET /v1/screener | پہلے سے اسکرین شدہ انڈیکس سے حالت، ملک، شعبہ، اسکور کے لحاظ سے نام تلاش کریں | اختیاری کلید |
GET /v1/top-halal | تعمیل اسکور کے لحاظ سے ٹاپ حلال اسٹاکس، اختیاری طور پر ملک/شعبہ | اختیاری کلید |
GET /v1/stock/{symbol}/zakat | ہولڈنگ پر واجب زکات (2.5%)؛ intent=investment|trading | اختیاری کلید |
GET /v1/stock/{symbol}/purification | ڈیویڈنڈ تطہیر رقم (ناجائز آمدنی حصہ × ڈیویڈنڈ) | اختیاری کلید |
GET /v1/stock/{symbol}/alternatives | اسی شعبے کے حلال اسٹاکس | اختیاری کلید |
GET /v1/stock/{symbol}/history | وقت کے ساتھ تعمیل حالت (روزانہ اسنیپ شاٹس) | اختیاری کلید |
GET /v1/fundamentals/{symbol} | کراس-تصدیق شدہ بنیادی اعداد (مارکیٹ کیپ، قرض، نقد، آمدنی) ہر فیلڈ کے ذرائع کے ساتھ | اختیاری کلید |
GET /v1/ratios/{symbol} | اسکریننگ تناسب (قرض، نقد، ناجائز آمدنی) حدود اور پاس/فیل کے ساتھ | اختیاری کلید |
GET /v1/profile/{symbol} | کمپنی پروفائل: نام، شعبہ، صنعت، کاروباری خلاصہ، کرنسی، قسم | اختیاری کلید |
GET /v1/dividends/{symbol} | ماخوذ ڈیویڈنڈ تطہیر اعداد (ناجائز تناسب، % تطہیر) ساتھ منسلک فیصلہ | اختیاری کلید |
GET /v1/financials/{symbol} | کثیر مدتی مالی گوشوارے (آمدنی، بیلنس شیٹ، کیش فلو) | ادا شدہ پلان |
GET /v1/compliance-changes | حال ہی میں حلال حالت بدلنے والے اسٹاکس | اختیاری کلید |
GET /v1/whale-watch | بڑے اسلامی فنڈز کی ہولڈنگز — حلال اسمارٹ منی کی پیروی کریں | اختیاری کلید |
GET /v1/sectors | کائنات بھر میں شعبے کے لحاظ سے حلال بمقابلہ کل تقسیم | اختیاری کلید |
GET /v1/methodology | اسکریننگ معیار، حدود، اور لاگو مراحل | کوئی نہیں |
GET /v1/markets | احاطہ شدہ مارکیٹس، ان کے ٹِکر لاحقوں کے ساتھ | کوئی نہیں |
POST /v1/signup | اپنا اکاؤنٹ بنائیں اور API کلید حاصل کریں | کوئی نہیں |
GET /v1/portfolio · POST · DELETE | اپنی کلید سے منسلک ہولڈنگز پورٹ فولیو محفوظ کریں اور اسکرین کریں | کلید درکار |
GET /v1/stock/{symbol}/multi-standard | AAOIFI بمقابلہ DJIM بمقابلہ کل اثاثہ بنیاد پر تعمیل | ادا شدہ پلان |
GET /v1/stock/{symbol}/custom-screen | اپنی قرض/نقد/ناجائز حدود کے ساتھ دوبارہ اسکرین کریں | ادا شدہ پلان |
GET /v1/compare?symbols= | 4 ٹِکرز تک کا ساتھ ساتھ تعمیل موازنہ | ادا شدہ پلان |
GET /v1/screen.csv?symbols= | 100 ٹِکرز تک کے فیصلوں کی بلک CSV برآمد (symbol,name,status,score,as_of) | Business پلان |
GET /v1/portfolio.csv | ہر محفوظ ہولڈنگ کی تعمیل حالت کی بلک CSV برآمد | Business پلان |
GET/POST/DELETE /v1/webhook | ایک کمپلائنس-پش URL رجسٹر کریں؛ جب کوئی فالو/ملکیتی اسٹاک حالت بدلے تو ہم {symbol,old_status,new_status,score,as_of} POST کرتے ہیں | Business پلان |
مارکیٹ کوریج: امریکہ میں درج اسٹاکس مکمل طور پر معاون ہیں (SEC EDGAR + Yahoo + Finnhub)۔ خلیجی اور دیگر بین الاقوامی مارکیٹس بہترین کوشش پر، جہاں قابلِ اعتماد ڈیٹا دستیاب ہو؛ جب کوئی عدد تصدیق نہ ہو سکے تو ہم اندازے کے بجائے status 'unknown' یا verified=false لوٹاتے ہیں۔
ریٹ حدود اور غلطیاں
روزانہ کوٹے کے علاوہ فی منٹ برسٹ حد بھی ہے: Pro = 300 درخواست/منٹ، Business = 600 درخواست/منٹ۔ بڑے کام پھیلائیں — فی منٹ حد لگنے پر 429 آتا ہے جس کے متن میں "max N requests/minute on your plan" ہوتا ہے (روزانہ کوٹا 429 سے مختلف)۔
401
کلید درکار اینڈ پوائنٹ پر API کلید غائب یا غلط ہے۔
402
مفت ٹیئر کلید سے ادا شدہ فیچر کال کیا گیا۔ اپنا پلان اپ گریڈ کریں۔
429
روزانہ کوٹا مکمل، یا فی منٹ برسٹ حد لگ گئی۔ متن بتاتا ہے کون سی۔ رکیں، کلید لیں، یا پلان اپ گریڈ کریں۔