> ## Documentation Index > Fetch the complete documentation index at: https://docs.halal.sh/llms.txt > Use this file to discover all available pages before exploring further. # Get ETF Holdings > Returns ETF holdings with per-holding compliance status and weight, ordered by weight (largest first) and paginated. ## OpenAPI ````yaml GET /etfs/{symbol}/holdings openapi: 3.1.0 info: title: halal.sh API version: 1.0.0 description: > The halal.sh API provides Shariah compliance screening for public equities and ETFs, based on AAOIFI Shari'ah Standard No. 21. Unlike a black-box verdict, every determination exposes the individual screens, the financial ratios with their thresholds, the revenue breakdown, and the source filings behind each number. The Evidence Packet endpoint returns the full audit trail — accession numbers, XBRL tags, and extraction strategies — for compliance, reporting, and reproducibility. ## Conventions - **Base URL** — `https://api.halal.sh/v1` - **Authentication** — send your key in the `X-API-Key` header. - **Envelope** — every success response is `{ "data": …, "meta": … }`. Every error is `{ "error": { "code", "message" } }`. - **Ratios** — screen `value`, `threshold`, and `buffer` are decimals (`0.082` means 8.2%, `0.30` means 30%). Fields named `*percentage`, `purity.percentage`, and holding `weight` are whole-number percentages (`66.74` means 66.74%). Each field documents its unit. - **Status** — compliance status is always `compliant`, `non-compliant`, or `pending`. Treat unknown future values as `pending`. - **Money** — values are in the instrument's reporting currency (USD for US filers). contact: name: halal.sh API support url: https://halal.sh/developers email: api@halal.sh servers: - url: https://api.halal.sh/v1 description: Production security: - apiKey: [] tags: - name: Instruments description: Compliance, financials, evidence, history, and health for a single stock. - name: Screening description: Batch screening and search across the instrument universe. - name: ETFs description: Shariah purity and holdings breakdown for ETFs. - name: Methodology description: The screening methodology, its thresholds, and version. paths: /etfs/{symbol}/holdings: get: tags: - ETFs summary: Get ETF holdings description: | Returns ETF holdings with per-holding compliance status and weight, ordered by weight (largest first) and paginated. operationId: getEtfHoldings parameters: - $ref: '#/components/parameters/EtfSymbol' - name: limit in: query schema: type: integer default: 100 minimum: 1 maximum: 250 - name: offset in: query schema: type: integer default: 0 minimum: 0 responses: '200': description: Holdings content: application/json: schema: $ref: '#/components/schemas/EtfHoldingsResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/SandboxRestricted' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' components: parameters: EtfSymbol: name: symbol in: path required: true description: ETF ticker symbol (e.g. SPY, HLAL). schema: type: string minLength: 1 maxLength: 10 example: SPY schemas: EtfHoldingsResponse: type: object properties: data: type: object properties: symbol: type: string holdings: type: array items: type: object properties: rank: type: integer nullable: true example: 1 symbol: type: string nullable: true example: NVDA name: type: string nullable: true example: NVIDIA Corp weight: type: number nullable: true description: Holding weight as a percentage. example: 7.58 cusip: type: string nullable: true example: 67066G104 isin: type: string nullable: true example: US67066G1040 sector: type: string nullable: true industry: type: string nullable: true compliance_status: $ref: '#/components/schemas/ComplianceStatus' health_status: $ref: '#/components/schemas/HealthStatus' meta: allOf: - $ref: '#/components/schemas/Meta' - type: object properties: total: type: integer description: Total holdings in the fund. limit: type: integer offset: type: integer has_more: type: boolean ComplianceStatus: type: string enum: - compliant - non-compliant - pending description: | Compliance determination. `pending` means the instrument has not been analysed yet. This enum may gain values in future; treat any unknown value as `pending`. HealthStatus: type: string enum: - fragile - robust - antifragile nullable: true description: Financial resilience rating, independent of Shariah compliance. Meta: type: object properties: request_id: type: string description: Unique ID for this request. Include it in support requests. example: req_abc123 as_of: type: string format: date-time description: When this response was generated. methodology: type: string description: Methodology used, as `id@version`. Present on compliance responses. example: aaoifi-ss21@2026.1 ErrorResponse: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - bad_request - unauthorized - sandbox_restricted - not_found - rate_limit_exceeded - service_unavailable - internal_error example: not_found message: type: string example: No instrument found for symbol 'XYZ'. retry_after: type: integer description: Seconds until the rate limit resets (only on 429). meta: $ref: '#/components/schemas/Meta' responses: Unauthorized: description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: unauthorized message: Invalid or revoked API key. meta: request_id: req_abc123 SandboxRestricted: description: Symbol or feature not available on the sandbox plan content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: sandbox_restricted message: >- Symbol 'TSLA' is not available in the sandbox. Upgrade to Plus for full access. meta: request_id: req_abc123 NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: not_found message: No instrument found for symbol 'XYZ'. meta: request_id: req_abc123 RateLimited: description: Rate limit exceeded headers: X-RateLimit-Limit: schema: type: integer description: Maximum requests allowed in the current daily window. X-RateLimit-Remaining: schema: type: integer description: Requests remaining in the current daily window. X-RateLimit-Reset: schema: type: string format: date-time description: ISO 8601 timestamp when the daily window resets (midnight UTC). Retry-After: schema: type: integer description: Seconds to wait before retrying. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: rate_limit_exceeded message: Daily request limit (100) exceeded. Resets at midnight UTC. retry_after: 3600 meta: request_id: req_abc123 securitySchemes: apiKey: type: apiKey in: header name: X-API-Key ````