Get Etf Holdings

Retrieve the full list of holdings for an ETF.

Returns every underlying position with its ticker, name, portfolio weight, share count, market value, and Shariah compliance status (if previously screened).

curl example:

curl -X GET "http://localhost:8000/api/etf/VTI/holdings"

Python requests example:

import requests
resp = requests.get("http://localhost:8000/api/etf/VTI/holdings")
data = resp.json()
print(data["holdings_count"], "holdings")

get/api/etf/{symbol}/holdings

Request

Base URL: https://api.halalterminal.com
URL: https://api.halalterminal.com/api/etf/{symbol}/holdings
Auth: API key in header X-API-Key

Path parameters

symbolstring required

ETF ticker symbol.

Response

ETF holdings list with weights and compliance statuses.

symbolstring required

ETF ticker symbol.

namestring

ETF fund name.

holdings_countinteger

Total number of holdings in the ETF.

data_sourcestring

Provider that supplied the holdings data (e.g. 'yfinance').

Example response

{
  "data_source": "yfinance",
  "holdings": [
    {
      "compliance_status": "compliant",
      "market_value": 32436000,
      "name": "Apple Inc.",
      "shares": 180200,
      "symbol": "AAPL",
      "weight": 6.5
    },
    {
      "compliance_status": "compliant",
      "market_value": 28920000,
      "name": "Microsoft Corp.",
      "shares": 120500,
      "symbol": "MSFT",
      "weight": 5.8
    }
  ],
  "holdings_count": 2,
  "name": "Vanguard Total Stock Market ETF",
  "symbol": "VTI"
}

Changes

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