Skip to main content
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>'
{
  "data": {
    "symbol": "NVDA",
    "name": "NVIDIA Corporation",
    "updated_at": "2026-03-07T14:30:00Z",
    "determination": {
      "status": "compliant",
      "confidence": 0.94,
      "methodology": "aaoifi-ss21@2024",
      "explanation": "NVIDIA Corporation passes all AAOIFI Standard 21 screens with comfortable margins."
    },
    "screens": {
      "business_activity": {
        "result": "pass",
        "primary_activities": [
          "Semiconductors",
          "GPU Computing",
          "Data Center"
        ],
        "prohibited_activities": [
          "<string>"
        ],
        "concerns": [
          "<string>"
        ]
      },
      "debt_to_market_cap": {
        "result": "pass",
        "value": 0.082,
        "threshold": 0.3,
        "operator": "<=",
        "buffer": 21.8
      },
      "prohibited_revenue": {
        "result": "pass",
        "value": 0.082,
        "threshold": 0.3,
        "operator": "<=",
        "buffer": 21.8
      },
      "cash_to_market_cap": {
        "result": "pass",
        "value": 0.082,
        "threshold": 0.3,
        "operator": "<=",
        "buffer": 21.8
      }
    },
    "revenue_breakdown": {
      "total_revenue": 60922000000,
      "permissible": {
        "amount": 123,
        "percentage": 98.6
      },
      "prohibited": {
        "amount": 123,
        "percentage": 1.4,
        "breakdown": {
          "interest_income": 123,
          "gambling": 123,
          "alcohol": 123,
          "weapons": 123,
          "tobacco": 123,
          "adult_entertainment": 123
        }
      }
    },
    "purification": {
      "required": true,
      "percentage": 1.8
    },
    "filing_context": {
      "filing_set_summary": "10-K (FY2025) + 10-Q (Q1 2026)",
      "analysis_date": "2023-11-07T05:31:56Z",
      "filing_set_hash": "<string>"
    },
    "stability": {
      "rating": "stable",
      "drivers": [
        {
          "code": "<string>",
          "message": "<string>",
          "severity": "info"
        }
      ]
    }
  },
  "meta": {
    "request_id": "req_abc123",
    "methodology": "aaoifi-ss21@2024",
    "as_of": "2026-03-08T12:00:00Z",
    "retry_after": 120
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

symbol
string
required

Stock ticker symbol (e.g., AAPL, NVDA, MSFT).

Required string length: 1 - 10
Example:

"NVDA"

Response

Compliance data found

data
object

When determination.status is pending, only symbol, name, and determination are present. All other fields (screens, purification, revenue_breakdown, filing_context, stability) are omitted until analysis completes.

meta
object