> ## Documentation Index > Fetch the complete documentation index at: https://octo-98895abd.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi.json post /rpc/portfolio_equivalents openapi: 3.1.0 info: title: SILO Data API version: '75' summary: >- Read-only Brazilian public financial data: CVM filings, BACEN series, B3 quotes and the B3 BDI group. description: > Schema `api` over PostgREST. Views are `GET /`; functions are `POST /rpc/` with a JSON body. **This document is generated** from the live Postgres catalog by `scripts/gen_openapi.py` — `pg_get_function_arguments` for the RPC signatures, `information_schema.columns` for the view columns, and the granted-to-`anon` privilege set for which objects exist at all. It is not hand-maintained, and `tests/test_openapi_spec.py` fails the build when it drifts from the SQL. ### Two different ceilings Reading one for the other is the most expensive mistake on this API. * **The row cap refuses.** Fifty-nine set-returning functions raise SQLSTATE `22023` when the window they were handed would produce more than 1000 rows. Nothing is trimmed, and the error says why and how to fix it (the message, plus PostgREST's `details` and `hint`). Five of them (`panel`, `quote_history`, `fund_nav`, `index_history`, `trade_consolidated_history`) take a `p_after` cursor so you can walk the series; the other fifty-four ask you to narrow the window. `fund_nav` paging additionally REQUIRES `p_entity_type` — its cursor is a bare period, which is unique only within one family, and CNPJs that file under both `fi` and `fidc` in the same month would otherwise be ambiguous. * **The tier ceiling clamps.** Three other functions (`search_funds`, `option_chain`, `option_exercises`) silently lower `p_limit` to a per-tier maximum. No error is raised, so the only way to know the result was cut is to know the ceiling. Signing in raises it. Separately from both, PostgREST's server-wide `db-max-rows = 1000` cuts every response, on every endpoint, for every tier. On the GET views `Content-Range` is the signal (`0-999/*`); `Prefer: count=exact` turns the `*` into a total. ### Retention Most of this warehouse is append-only history. The **B3 BDI group** — `short_interest`, `short_interest_by_sector`, `investor_flow`, `lending_trades`, `lending_participants` — is not: B3 keeps roughly 21 business days and publishes no archive. A missed session cannot be bought back. See Market Coverage. license: name: See repository url: https://github.com/PedroDnT/SILO-BZ servers: - url: https://zcjbtpxuhdekpwcxmepn.supabase.co/rest/v1 description: Supabase PostgREST, schema `api` security: - apikey: [] tags: - name: ANBIMA - name: Company events - name: Coverage & catalog - name: Derivatives - name: FIDC - name: FNET documents - name: Financials - name: Funds - name: Holdings - name: Inflation - name: Lookup - name: Macro - name: Macro expectations - name: Other - name: Panel - name: Portfolio - name: Quotes - name: Rates - name: Research - name: Screens - name: Securities lending - name: Short interest & flows paths: /rpc/portfolio_equivalents: post: tags: - Portfolio summary: portfolio_equivalents description: >- 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. operationId: rpc_portfolio_equivalents requestBody: required: true content: application/json: schema: type: object properties: p_classes: type: - array - 'null' items: type: - string - 'null' p_as_of: type: - string - 'null' format: date description: Defaults to `CURRENT_DATE`. required: - p_classes responses: '200': description: >- The result set, oldest first. An unknown id is an empty array, not a 404 and never a guessed value. content: application/json: schema: type: array items: type: object properties: classe_anbima: type: - string - 'null' class_indices: type: - array - 'null' items: type: - string - 'null' n_etfs: type: - integer - 'null' format: int32 ticker: type: - string - 'null' etf_cnpj: type: - string - 'null' etf_name: type: - string - 'null' underlying_index: type: - string - 'null' segment: type: - string - 'null' pl_brl: type: - number - 'null' pl_as_of: type: - string - 'null' format: date fee_pct_year: type: - number - 'null' fee_as_of: type: - string - 'null' format: date snapshot_source: type: - string - 'null' pl_rank: type: - integer - 'null' format: int32 is_equivalent: type: - boolean - 'null' status: type: - string - 'null' reason: type: - string - 'null' '400': description: >- Bad request. Contract violations raise SQLSTATE `22023` with a message naming the limit or the argument at fault. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: >- No usable `apikey`, or a request for a schema outside `api`. `Accept-Profile: public` and any `cvm_*` / `b3_cotahist` / `cia_*` path answer 401 for every caller, by grant — schema `api` is the entire public surface. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: No such endpoint in schema `api`. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Error: type: object description: >- PostgREST error body. `code` carries the SQLSTATE — `22023` is a contract refusal. properties: code: type: - string - 'null' examples: - '22023' message: type: - string - 'null' details: type: - string - 'null' hint: type: - string - 'null' securitySchemes: apikey: type: apiKey in: header name: apikey description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.