API Documentation

Integrate Akinda's proprietary Shariah compliance data into your application.

Authentication

Query param: ?apikey=YOUR_KEY | Header: X-API-Key: YOUR_KEY

Rate Limits & Bandwidth

Tier	Rate	Bandwidth	Endpoints
Basic Free	250 / day	1 GB / mo	`/compliance`
Personal Standard	300 / min	30 GB / mo	`/compliance/basic-report`
Personal Ultimate	2,000 / min	150 GB / mo	`/compliance/basic-report/full-report`
Business Standard	1,000 / min	50 GB / mo	`/compliance/basic-report`
Business Ultimate	3,000 / min	200 GB / mo	`/compliance/basic-report/full-report`
Business Enterprise	Unlimited	Unlimited	`All endpoints`

1. Shariah Compliance Status

Available to all tiers. Returns the halal status of a ticker symbol.

GET https://ai-stock-screener.site/api/v1/compliance/{ticker}?apikey={api_key}

Parameter	Type	Example
ticker *	string	AAPL

response.json

{
  "ticker": "AAPL",
  "company_name": "Apple Inc.",
  "halal_status": "HALAL"
}

2. Basic Shariah Compliance Report

Requires Personal Standard tier or above. Adds key financial screening ratios.

GET https://ai-stock-screener.site/api/v1/basic-report/{ticker}?apikey={api_key}

Parameter	Type	Description	Example
ticker *	string	Stock ticker symbol (path param)	AAPL
apikey *	string	Your API key (query or X-API-Key header)	ak_xxxx…

response.json

{
  "ticker": "AAPL",
  "company_name": "Apple Inc.",
  "halal_status": "HALAL",
  "debt_ratio": 22.45,
  "liquidity_ratio": 18.30,
  "impure_ratio": 0.12
}

Field	Type	Description
ticker	string	Uppercase ticker symbol
company_name	string	Full legal company name
halal_status	string	HALAL, DOUBTFUL, or HARAM
debt_ratio	float	Interest-bearing debt / total assets (%)
liquidity_ratio	float	Cash & equivalents / total assets (%)
impure_ratio	float	Impermissible revenue / total revenue (%)

3. Full Shariah Compliance Report

Requires Personal Ultimate tier or above. Includes AI-extracted SEC filing analysis.

GET https://ai-stock-screener.site/api/v1/full-report/{ticker}?apikey={api_key}

Parameter	Type	Description	Example
ticker *	string	Stock ticker symbol (path param)	MSFT
apikey *	string	Your API key (query or X-API-Key header)	ak_xxxx…

response.json

{
  "ticker": "AAPL",
  "company_name": "Apple Inc.",
  "halal_status": "HALAL",
  "halal_rating": 9,
  "debt_ratio": 22.45,
  "liquidity_ratio": 18.30,
  "impure_ratio": 0.12,
  "ai_interest_debt": 109500000,
  "ai_prohibited_revenue": 0,
  "ai_operating_lease": 14200000,
  "ai_last_scanned": "Mar 15, 2026",
  "ai_data_available": true
}

Field	Type	Description
ticker	string	Uppercase ticker symbol
company_name	string	Full legal company name
halal_status	string	HALAL, DOUBTFUL, or HARAM
halal_rating	int	Shariah compliance score 1–10 (AI-derived)
debt_ratio	float	Interest-bearing debt / total assets (%)
liquidity_ratio	float	Cash & equivalents / total assets (%)
impure_ratio	float	Impermissible revenue / total revenue (%)
ai_interest_debt	int64	AI-extracted interest-bearing debt from SEC filings (USD)
ai_prohibited_revenue	int64	AI-extracted prohibited revenue amount (USD)
ai_operating_lease	int64	AI-extracted operating lease obligations (USD)
ai_last_scanned	string	Date of last AI scan of SEC filing (Mon DD, YYYY)
ai_data_available	bool	Whether AI data has been extracted for this ticker

Error Codes

401 UnauthorizedInvalid or missing API key

403 ForbiddenSubscription tier too low for this endpoint

429 Too Many RequestsRate limit or bandwidth quota exceeded