comparison

Compare Symbols

Compare Shariah compliance across multiple symbols.

Accepts 2-5 ticker symbols and returns screening results, market quotes, and stored database data for each symbol side by side.

curl example:

curl -X POST https://api.halalterminal.com/api/compare \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sk_live_abc123def456" \
  -d '{"symbols": ["AAPL", "MSFT"]}'

Python example:

import requests

resp = requests.post(
    "https://api.halalterminal.com/api/compare",
    headers={"X-API-Key": "sk_live_abc123def456"},
    json={"symbols": ["AAPL", "MSFT"]},
)
comparison = resp.json()
for item in comparison["items"]:
    print(item["symbol"], item["screening"]["status"])
post/api/compare

Request

  • Base URL: https://api.halalterminal.com
  • URL: https://api.halalterminal.com/api/compare
  • Auth: API key in header X-API-Key

Request body

symbolsstring[] required

List of 2-5 stock ticker symbols to compare

Example request

{
  "symbols": [
    "AAPL",
    "MSFT"
  ]
}

Response

Side-by-side compliance comparison for the requested symbols

symbolsstring[] required

Symbols that were compared

countinteger required

Number of symbols in the comparison

Example response

{
  "count": 2,
  "items": [
    {
      "database": {
        "sector": "Technology"
      },
      "quote": {
        "price": 198.5
      },
      "screening": {
        "status": "COMPLIANT"
      },
      "symbol": "AAPL"
    },
    {
      "database": {
        "sector": "Technology"
      },
      "quote": {
        "price": 415.2
      },
      "screening": {
        "status": "COMPLIANT"
      },
      "symbol": "MSFT"
    }
  ],
  "symbols": [
    "AAPL",
    "MSFT"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.