# halal.sh API

## Docs

- [Get ETF](https://docs.halal.sh/api-reference/etfs/get-etf.md): Returns Shariah purity analysis for an ETF — compliant/non-compliant/pending holdings breakdown.
- [Get ETF Holdings](https://docs.halal.sh/api-reference/etfs/get-holdings.md): Returns ETF holdings with per-holding compliance status and weight.
- [Get ETF Purity History](https://docs.halal.sh/api-reference/etfs/get-purity-history.md): Returns how the ETF's Shariah purity percentage has changed over time.
- [Get Compliance](https://docs.halal.sh/api-reference/instruments/get-compliance.md): Returns the full AAOIFI Standard 21 compliance determination for a stock, including business activity screening, all financial ratios with thresholds, revenue breakdown, and purification data.
- [Get Evidence Packet](https://docs.halal.sh/api-reference/instruments/get-evidence.md): Returns a complete compliance audit bundle with determination, every metric with its calculation and source filings, confidence breakdown, and stability metrics.
- [Get Financials](https://docs.halal.sh/api-reference/instruments/get-financials.md): Returns the extracted financial metrics used in compliance screening, with full provenance including source filings, XBRL tags, and extraction strategies.
- [Get Financial Health](https://docs.halal.sh/api-reference/instruments/get-health.md): Returns the financial health rating for a stock — fragile, robust, or antifragile — based on five fundamental ratios. This is independent of Shariah compliance and measures the company's financial resilience.
- [Get Compliance History](https://docs.halal.sh/api-reference/instruments/get-history.md): Returns quarterly compliance status over time with stability metrics.
- [Get Instrument](https://docs.halal.sh/api-reference/instruments/get-instrument.md): Returns identity, current price, and compliance status summary for a stock.
- [Get Methodology](https://docs.halal.sh/api-reference/methodology/get-methodology.md): Returns thresholds, calculation basis, definitions, and changelog for a methodology.
- [List Methodologies](https://docs.halal.sh/api-reference/methodology/list-methodologies.md): Returns all supported screening methodologies with their current versions.
- [Screen Instruments](https://docs.halal.sh/api-reference/screening/screen.md): Filter the universe of instruments by compliance status, financial health, sector, market cap, and other criteria. Returns compliance summary for each matching instrument.
- [Search Instruments](https://docs.halal.sh/api-reference/screening/search.md): Search for stocks by symbol or company name. Returns `200` with empty `results` array when no instruments match the query.
- [Authentication](https://docs.halal.sh/authentication.md): API keys, rate limits, and keeping your credentials secure.
- [Changelog](https://docs.halal.sh/changelog.md): Updates and changes to the halal.sh API.
- [Compliance Screening](https://docs.halal.sh/concepts/compliance.md): How AAOIFI Standard 21 screening works and what the API returns.
- [Evidence Packets](https://docs.halal.sh/concepts/evidence-packets.md): Audit-ready compliance bundles with full provenance — the data that makes halal.sh a system of record.
- [Methodology Versioning](https://docs.halal.sh/concepts/methodology-versioning.md): How compliance methodologies are versioned and why it matters for reproducibility.
- [Stability Metrics](https://docs.halal.sh/concepts/stability-metrics.md): Flip rate, threshold distance, and trend analysis for compliance risk management.
- [Embed a Compliance Badge](https://docs.halal.sh/guides/embed-compliance-badge.md): Add a Shariah compliance badge to your app with a single API call.
- [ETF Purification](https://docs.halal.sh/guides/etf-purification.md): Analyze ETF holdings for Shariah purity and calculate purification amounts.
- [Handle Pending Analysis](https://docs.halal.sh/guides/handle-pending-analysis.md): How to handle stocks that are being analyzed for the first time.
- [Screen a Portfolio](https://docs.halal.sh/guides/screen-a-portfolio.md): Check compliance for a list of stocks in a single API call.
- [Introduction](https://docs.halal.sh/introduction.md): Shariah compliance data for every public company — with full provenance.
- [Quickstart](https://docs.halal.sh/quickstart.md): Get your API key and make your first compliance request in under 2 minutes.

## OpenAPI Specs

- [openapi](https://docs.halal.sh/openapi.yaml)