dividends

Get Purification Rate As Of

Rate from the latest screening pass on or before as_of; falls back to the current rate (mode = fallback_current) when no pass precedes the date.

get/api/dividends/{symbol}/purification-rate

Request

  • Base URL: https://api.halalterminal.com
  • URL: https://api.halalterminal.com/api/dividends/{symbol}/purification-rate
  • Auth: API key in header X-API-Key

Path parameters

symbolstring required

Ticker symbol, e.g. IBM.

Query parameters

as_ofstring required

Date, YYYY-MM-DD.

Response

Purification rate in force at the given date.

symbolstring required

Ticker symbol.

as_ofstring required

Requested date, YYYY-MM-DD.

ratenumber nullable

Purification rate in percent (e.g. 0.96), null when unknown.

screened_atstring nullable

Timestamp of the screening pass that supplied the rate.

modestring required

'as_of' when a pass on or before the date exists, else 'fallback_current'.

notestring nullable

Set when the rate was adjusted from the legacy screening convention.

Example response

{
  "as_of": "2026-05-08",
  "mode": "as_of",
  "note": "legacy 100 percent convention replaced by the impure revenue share",
  "rate": 0.96,
  "screened_at": "2026-05-01T08:00:00+00:00",
  "symbol": "IBM"
}

Changes

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