# Zoya API Reference

The Zoya API offers data covering Shariah compliance information for global stocks. It is available in basic and advanced packages, where the advanced package includes additional data fields, screening methodologies, and global coverage. The basic package is limited to the US market using the AAOIFI methodology.

## API endpoints

```text
Sandbox: https://sandbox-api.zoya.finance/graphql
Live: https://api.zoya.finance/graphql
```

## Authentication

Send the API key in the `Authorization` header:

- Sandbox: `Authorization: sandbox-YOUR_API_KEY_HERE`
- Live: `Authorization: live-YOUR_API_KEY_HERE`

## Machine-readable resources

- [Full API documentation](https://developer.zoya.finance/llms-full.txt)
- [GraphQL schema SDL](https://developer.zoya.finance/schema.graphql)

## Start here

- [Overview](https://developer.zoya.finance/docs#introduction)
- [Quickstart](https://developer.zoya.finance/docs#quickstart)
- [Authentication](https://developer.zoya.finance/docs#authentication)
- [Environments](https://developer.zoya.finance/docs#environments)
- [API Explorer](https://developer.zoya.finance/docs#api-explorer)
- [Changelog](https://developer.zoya.finance/docs#changelog)

## Policies

- [Plans and licensing](https://developer.zoya.finance/docs#plans-and-licensing)
- [Attribution](https://developer.zoya.finance/docs#attribution)
- [Terms of use](https://developer.zoya.finance/docs#terms-of-use)

## Concepts

- [GraphQL](https://developer.zoya.finance/docs#graphql)
- [Compliance statuses](https://developer.zoya.finance/docs#compliance-statuses)
- [Screening methodology](https://developer.zoya.finance/docs#screening-methodology)
- [Symbols and identifiers](https://developer.zoya.finance/docs#symbols-and-identifiers)
- [Markets and coverage](https://developer.zoya.finance/docs#markets-and-coverage)
- [Data freshness](https://developer.zoya.finance/docs#data-freshness)
- [Required vs optional fields](https://developer.zoya.finance/docs#required-vs-optional-fields)
- [Pagination](https://developer.zoya.finance/docs#pagination)
- [Error handling](https://developer.zoya.finance/docs#error-handling)
- [Rate limits](https://developer.zoya.finance/docs#rate-limits)

## Guides

- [Get Shariah compliance rating for a specific stock](https://developer.zoya.finance/docs#group-userguide-get-shariah-compliance-rating-for-a-specific-stock)
- [Get all Shariah compliance ratings for the US market](https://developer.zoya.finance/docs#group-userguide-get-all-shariah-compliance-ratings-for-the-us-market)
- [Get a list of all Shariah-compliant stocks in the US market](https://developer.zoya.finance/docs#group-userguide-get-a-list-of-all-shariah-compliant-stocks-in-the-us-market)
- [Get the full Shariah compliance report for a specific stock](https://developer.zoya.finance/docs#group-userguide-get-the-full-shariah-compliance-report-for-a-specific-stock)
- [Get a Shariah compliance report for a non-US stock](https://developer.zoya.finance/docs#group-userguide-get-a-shariah-compliance-report-for-a-non-us-stock)
- [Get all Shariah compliance reports for a region](https://developer.zoya.finance/docs#group-userguide-get-all-shariah-compliance-reports-for-a-region)
- [Get all compliant stocks from MENA regions](https://developer.zoya.finance/docs#group-userguide-get-all-compliant-stocks-from-mena-regions)
- [Get a list of Shariah compliance reports for ETFs](https://developer.zoya.finance/docs#group-userguide-get-a-list-of-shariah-compliance-reports-for-et-fs)
- [Get list of regions with available Shariah compliance reports](https://developer.zoya.finance/docs#group-userguide-get-list-of-regions-with-available-shariah-compliance-reports)
- [Calculate zakat due on a portfolio](https://developer.zoya.finance/docs#group-userguide-calculate-zakat-due-on-a-portfolio)

## Operations

- [Basic Compliance](https://developer.zoya.finance/docs#group-Operations-Basic-Compliance)
- [funds](https://developer.zoya.finance/docs#Operations-Basic-Compliancequery-funds)
- [report](https://developer.zoya.finance/docs#Operations-Basic-Compliancequery-report)
- [reports](https://developer.zoya.finance/docs#Operations-Basic-Compliancequery-reports)
- [Advanced Compliance](https://developer.zoya.finance/docs#group-Operations-Advanced-Compliance)
- [externalScreens](https://developer.zoya.finance/docs#Operations-Advanced-Compliancequery-externalScreens)
- [menaScreens](https://developer.zoya.finance/docs#Operations-Advanced-Compliancequery-menaScreens)
- [regions](https://developer.zoya.finance/docs#Operations-Advanced-Compliancequery-regions)
- [report](https://developer.zoya.finance/docs#Operations-Advanced-Compliancequery-report)
- [reports](https://developer.zoya.finance/docs#Operations-Advanced-Compliancequery-reports)

## Types

- [AAOIFIReport](https://developer.zoya.finance/docs#definition-AAOIFIReport)
- [AWSDateTime](https://developer.zoya.finance/docs#definition-AWSDateTime)
- [AdvancedComplianceQuery](https://developer.zoya.finance/docs#definition-AdvancedComplianceQuery)
- [AdvancedComplianceReport](https://developer.zoya.finance/docs#definition-AdvancedComplianceReport)
- [AdvancedComplianceReportsPage](https://developer.zoya.finance/docs#definition-AdvancedComplianceReportsPage)
- [AdvancedReportFilters](https://developer.zoya.finance/docs#definition-AdvancedReportFilters)
- [AdvancedReportInput](https://developer.zoya.finance/docs#definition-AdvancedReportInput)
- [AdvancedReportsInput](https://developer.zoya.finance/docs#definition-AdvancedReportsInput)
- [BasicComplianceQuery](https://developer.zoya.finance/docs#definition-BasicComplianceQuery)
- [BasicComplianceReport](https://developer.zoya.finance/docs#definition-BasicComplianceReport)
- [BasicComplianceReportsPage](https://developer.zoya.finance/docs#definition-BasicComplianceReportsPage)
- [BasicFundReport](https://developer.zoya.finance/docs#definition-BasicFundReport)
- [BasicFundReportsPage](https://developer.zoya.finance/docs#definition-BasicFundReportsPage)
- [BasicFundsInput](https://developer.zoya.finance/docs#definition-BasicFundsInput)
- [BasicReportFilters](https://developer.zoya.finance/docs#definition-BasicReportFilters)
- [BasicReportsInput](https://developer.zoya.finance/docs#definition-BasicReportsInput)
- [Boolean](https://developer.zoya.finance/docs#definition-Boolean)
- [ComplianceStatus](https://developer.zoya.finance/docs#definition-ComplianceStatus)
- [Float](https://developer.zoya.finance/docs#definition-Float)
- [Int](https://developer.zoya.finance/docs#definition-Int)
- [MENAScreens](https://developer.zoya.finance/docs#definition-MENAScreens)
- [ScreeningMethodology](https://developer.zoya.finance/docs#definition-ScreeningMethodology)
- [String](https://developer.zoya.finance/docs#definition-String)
- [ZakatCalculation](https://developer.zoya.finance/docs#definition-ZakatCalculation)
- [ZakatCalculationMethod](https://developer.zoya.finance/docs#definition-ZakatCalculationMethod)
- [ZakatHolding](https://developer.zoya.finance/docs#definition-ZakatHolding)
- [ZakatHoldingCalculation](https://developer.zoya.finance/docs#definition-ZakatHoldingCalculation)
- [ZakatHoldingStrategy](https://developer.zoya.finance/docs#definition-ZakatHoldingStrategy)
- [ZakatQuery](https://developer.zoya.finance/docs#definition-ZakatQuery)