portfolio_equivalents

The market equivalent of an ANBIMA class (catalog v68, #609): the active ETFs that track an index the owner-reviewed list (src/portfolio/rules/equivalents/class_index.yaml, generated into public.portfolio_class_index; only pairs with status aprovada) maps to the class, read in reverse (class -> index). One row per (class, ETF CNPJ) among cvm_etf_registry.is_active ETFs, the universe portfolio_fee_peers uses; class_indices lists every mapped index and n_etfs counts the ETFs. pl_brl and fee_pct_year are the third-party values etfsbrasil.com.br prints (etf_market_snapshot.nav and taxa_adm_pct, each the newest snapshot that has one dated no later than p_as_of, dated pl_as_of and fee_as_of), the values portfolio_fees serves as etf_site_pl and etf_site_taxa_adm: never a CVM filing, never rescaled. is_equivalent marks the largest by PL across all the class’s indices (pl_rank 1, ties by ticker); an ETF with no PL is never ranked. segment is the registry’s as filed: fixed_income_br trades in B3’s FORWARD segment (prices in trade_consolidated_history), the others on the cash tape (quote_history). A class with no approved pair (status sem_par) or with no active ETF on its indices (sem_etf) comes back as one row with NULL ETF columns; when no ETF has a PL every row is sem_pl and none is the equivalent. The index is never inferred from a fund’s name. reason is Portuguese. It names an ETF with the same objective, not a recommendation. 1 to 50 non-blank classes (outer spaces trimmed, duplicates collapsed); otherwise RAISES 22023; one page, never trimmed.

Row cap. A window producing more than 1000 rows raises SQLSTATE 22023 naming this function. Nothing is trimmed to fit — PostgREST would silently cut the response at 1000 and a cut-short series is indistinguishable from one that simply ends. This function does not page — narrow the window instead.

POST /rpc/portfolio_equivalents

portfolio_equivalents

cURL

curl --request POST \
  --url https://zcjbtpxuhdekpwcxmepn.supabase.co/rest/v1/rpc/portfolio_equivalents \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "p_classes": [
    "<string>"
  ],
  "p_as_of": "2023-12-25"
}
'

200

[
  {
    "classe_anbima": "<string>",
    "class_indices": [
      "<string>"
    ],
    "n_etfs": 123,
    "ticker": "<string>",
    "etf_cnpj": "<string>",
    "etf_name": "<string>",
    "underlying_index": "<string>",
    "segment": "<string>",
    "pl_brl": 123,
    "pl_as_of": "2023-12-25",
    "fee_pct_year": 123,
    "fee_as_of": "2023-12-25",
    "snapshot_source": "<string>",
    "pl_rank": 123,
    "is_equivalent": true,
    "status": "<string>",
    "reason": "<string>"
  }
]

Authorizations

apikey · string · header · required

The publishable key (sb_publishable_…), on every request. It is NOT a JWT — sending it as Authorization: Bearer is rejected as an invalid JWT. It identifies the project, not you, and maps to the Postgres anon role.

Body

application/json

p_classes · (string | null)[] | null · required

p_as_of · string<date> | null

Defaults to CURRENT_DATE.

Response

200

application/json

The result set, oldest first. An unknown id is an empty array, not a 404 and never a guessed value.

classe_anbima · string | null

class_indices · (string | null)[] | null

n_etfs · integer<int32> | null

ticker · string | null

etf_cnpj · string | null

etf_name · string | null

underlying_index · string | null

segment · string | null

pl_brl · number | null

pl_as_of · string<date> | null

fee_pct_year · number | null

fee_as_of · string<date> | null

snapshot_source · string | null

pl_rank · integer<int32> | null

is_equivalent · boolean | null

status · string | null

reason · string | null