Raw schema
{
"type": "object",
"properties": {
"search": {
"type": "string",
"description": "Free-text match on ticker, fund name or ISIN. Omit to screen the whole universe."
},
"assetClass": {
"type": "string",
"description": "Exact asset-class group: EQUITY, FIXED_INCOME, COMMODITY, REAL_ESTATE, MULTI_ASSET, CASH, CURRENCY, DIGITAL_ASSETS, ALTERNATIVES or OTHER."
},
"category": {
"type": "string",
"description": "Exact category string. Call get_etf_filter_options for the valid values; a wrong guess silently returns zero rows."
},
"domicile": {
"type": "string",
"description": "Exact fund domicile, e.g. \"Ireland\", \"Luxembourg\", \"United States\"."
},
"region": {
"type": "string",
"description": "Exact investment-region string."
},
"exchange": {
"type": "string",
"description": "Exact listing exchange, e.g. XETRA, LSE, \"NYSE ARCA\"."
},
"currency": {
"type": "string",
"description": "Exact trading currency, e.g. EUR, USD, GBX."
},
"indexKey": {
"type": "string",
"description": "Exact tracked-index key, e.g. SP500, MSCI_WORLD, NASDAQ100. Use get_etf_index_group to compare every fund on one index instead."
},
"distributionPolicy": {
"type": "string",
"enum": [
"ACCUMULATING",
"DISTRIBUTING"
],
"description": "Accumulating (reinvests income) or distributing (pays it out) — the usual first cut for a European investor."
},
"productType": {
"type": "string",
"description": "Exact wrapper type, e.g. UCITS_FUND."
},
"ucitsStatus": {
"type": "string",
"enum": [
"UCITS",
"NON_UCITS"
],
"description": "UCITS restricts to wrappers a European retail investor can actually buy."
},
"issuer": {
"type": "string",
"description": "Substring match on the fund family/issuer, e.g. \"iShares\", \"Amundi\", \"Vanguard\"."
},
"strategy": {
"type": "string",
"description": "Exact strategy classification string."
},
"benchmarkSearch": {
"type": "string",
"description": "Substring match on the stated benchmark name."
},
"marketDevelopment": {
"type": "string",
"description": "Exact market-development classification, e.g. developed vs emerging."
},
"currencyHedged": {
"type": "string",
"enum": [
"HEDGED",
"NOT_LABELLED_HEDGED"
],
"description": "HEDGED selects funds labelled currency-hedged. NOT_LABELLED_HEDGED selects funds not so labelled — absence of a label is not proof a fund is unhedged."
},
"holdingSearch": {
"type": "string",
"description": "Look-through filter: find funds by a CONSTITUENT ticker or company name, e.g. \"NVDA\" or \"NVIDIA\". Only funds with a stored holdings snapshot can match."
},
"holdingMode": {
"type": "string",
"enum": [
"INCLUDES",
"EXCLUDES"
],
"default": "INCLUDES",
"description": "INCLUDES keeps funds holding the constituent. EXCLUDES keeps only funds with a holdings snapshot that confirms absence — funds with no snapshot are dropped, never assumed clean."
},
"holdingMinWeightPct": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "Minimum constituent weight in percentage points for holdingSearch to count as a match."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metric": {
"type": "string",
"enum": [
"expenseRatioPct",
"totalAssets",
"yieldTtmPct",
"holdingsCount",
"fundAgeYears",
"inceptionYear",
"nav",
"return1mPct",
"return3mPct",
"return6mPct",
"return1yPct",
"returnYtdPct",
"volatility1yPct",
"avgVolume90d",
"avgTurnover90d",
"top10ConcentrationPct"
],
"description": "Numeric metric to filter on."
},
"operator": {
"type": "string",
"enum": [
">=",
"<=",
">",
"<",
"=",
".."
],
"default": ">=",
"description": "Comparison operator. Use '..' for an inclusive between range with valueMax."
},
"value": {
"type": [
"string",
"number"
],
"description": "Threshold. For money metrics combine with unit for K/M/B/T scaling."
},
"valueMax": {
"type": [
"string",
"number"
],
"description": "Upper bound for '..' range rules. Ignored for other operators."
},
"unit": {
"type": "string",
"enum": [
"",
"K",
"M",
"B",
"T"
],
"default": "",
"description": "Optional money unit for money metrics: '', K, M, B or T."
},
"groupId": {
"type": "integer",
"minimum": 1,
"default": 1,
"description": "Rules with the same groupId are ANDed; different groups are ORed."
}
},
"required": [
"metric"
],
"additionalProperties": false
},
"default": [],
"description": "Numeric rules. A fund with no value for a ruled metric never matches that rule."
},
"includeSecondary": {
"type": "boolean",
"default": false,
"description": "Return every venue listing as its own row. Default false: one row per FUND (by fund ISIN), showing its most liquid listing with the others under otherListings. Use exchange/currency to choose the venue, e.g. exchange \"SW\" for the SIX line."
},
"sortBy": {
"type": "string",
"enum": [
"expenseRatioPct",
"totalAssets",
"yieldTtmPct",
"return1mPct",
"return3mPct",
"return6mPct",
"return1yPct",
"returnYtdPct",
"volatility1yPct",
"avgVolume90d",
"avgTurnover90d",
"top10ConcentrationPct",
"holdingsCount",
"nav",
"ticker",
"name"
],
"default": "totalAssets",
"description": "Sort field applied to the returned rows."
},
"order": {
"type": "string",
"enum": [
"desc",
"asc"
],
"default": "desc",
"description": "Sort direction. Nulls always sort last regardless of direction."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25,
"description": "Maximum ETFs to return, 1-100."
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}