Mizan

Screen one company against all four standards. Returns a 'say' sentence, the live price, the consolidated share count, the filing figures used, the business screen per standard ('business': main_business, by_standard pass/fail/review, excluded_under), and each standard's ratio, threshold and verdict. In each screens entry, 'compliant' is the overall verdict (false when that standard excludes the company's business, null when the business needs a closer look) and 'debt_compliant' is the debt test alone. Verdicts within one percent of a threshold are flagged borderline. A company name (for example nvidia) also works.

{
  "type": "object",
  "properties": {
    "ticker": {
      "type": "string",
      "description": "US listing symbol (a common company name also works)."
    }
  },
  "required": [
    "ticker"
  ],
  "additionalProperties": false
}

The four standards, their denominators and thresholds. Screens a US-listed company against four published Shariah equity standards (AAOIFI, Dow Jones Islamic Market, S&P Shariah, MSCI Islamic), first on its business (prohibited industries each standard excludes) and then on its debt, using live...

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

How much of a dividend to give to charity. Returns the company's purification ratio (interest income over total revenue, from its latest 10-K that reports interest income; 'latest_annual_filing' and 'note' say when that is older than the latest 10-K) and, if a dividend amount is given, the amount to give to charity. For a company whose main business every standard excludes, 'business_screen' explains that purification does not make it permissible.

{
  "type": "object",
  "properties": {
    "ticker": {
      "type": "string",
      "description": "US listing symbol."
    },
    "dividend": {
      "type": "number",
      "description": "The dividend received, in any currency."
    }
  },
  "required": [
    "ticker"
  ],
  "additionalProperties": false
}

Halal alternatives to a holding. Companies Mizan covers in the same industry (or the nearest related one) whose business is permitted and whose debt passes all four standards at the last quarter-end, largest first, plus Shariah index funds for US and UK investors. Screen a pick live with screen_company before buying.

{
  "type": "object",
  "properties": {
    "ticker": {
      "type": "string",
      "description": "The holding to replace: a US listing symbol or company name."
    }
  },
  "required": [
    "ticker"
  ],
  "additionalProperties": false
}

Screen a whole portfolio. Screens up to 15 holdings under all four standards and returns the share of the portfolio that is compliant under each, the holdings that fail, and a combined dividend purification ratio.

{
  "type": "object",
  "properties": {
    "holdings": {
      "type": "string",
      "description": "Comma-separated tickers, each optionally followed by a colon and the value held, for weighting."
    }
  },
  "required": [
    "holdings"
  ],
  "additionalProperties": false
}

Zakat owed on cash, gold, silver, shares and business stock, using live gold and silver prices.

{
  "type": "object",
  "properties": {
    "currency": {
      "type": "string",
      "enum": [
        "USD",
        "GBP",
        "EUR",
        "CAD",
        "AUD"
      ],
      "description": "Defaults to USD."
    },
    "cash": {
      "type": "number",
      "minimum": 0,
      "description": "Cash and bank balances."
    },
    "gold_grams": {
      "type": "number",
      "minimum": 0,
      "description": "Gold held, in grams."
    },
    "gold_value": {
      "type": "number",
      "minimum": 0,
      "description": "Or the value of gold held."
    },
    "silver_grams": {
      "type": "number",
      "minimum": 0,
      "description": "Silver held, in grams."
    },
    "silver_value": {
      "type": "number",
      "minimum": 0,
      "description": "Or the value of silver held."
    },
    "shares_trading": {
      "type": "number",
      "minimum": 0,
      "description": "Market value of shares held for trading (counted in full)"
    },
    "shares_longterm": {
      "type": "number",
      "minimum": 0,
      "description": "Market value of shares held long term."
    },
    "share_zakatable_pct": {
      "type": "number",
      "minimum": 0,
      "description": "Share of long-term holdings treated as zakatable, default 25."
    },
    "business_stock": {
      "type": "number",
      "minimum": 0,
      "description": "Value of business stock for sale."
    },
    "owed_to_you": {
      "type": "number",
      "minimum": 0,
      "description": "Money owed to you that you expect to be repaid."
    },
    "debts_due_now": {
      "type": "number",
      "minimum": 0,
      "description": "Debts due now, deducted."
    },
    "nisab": {
      "type": "string",
      "enum": [
        "silver",
        "gold"
      ],
      "description": "Which nisab to use. Defaults to silver."
    }
  },
  "required": [],
  "additionalProperties": false
}