v2 portfolio

Preview, not deployed. The v2 gateway is built but not deployed yet; this call works once the owner deploys silo-api.

Diagnose a portfolio: resolve statement lines, fees, look-through, movement (POST).

Example: POST /v2/portfolio?kind=resolve {"names": ["ITAU RF DI"]}

Kinds:

• resolve: api.portfolio_resolve: up to 5 ranked candidate funds per statement line (a printed CNPJ wins, then an ETF ticker, an exact name, a trigram match).
• fees: api.portfolio_fees: the disclosed fee and the fee estimated from the balancete, never mixed.
• fee_peers: api.portfolio_fee_peers: the admin fee against funds and ETFs of the same filed class, one row per CNPJ.
• lookthrough: api.portfolio_lookthrough: one CDA month, holdings followed through fund quotas up to max_depth levels.
• movement: api.portfolio_movement: the fund’s monthly quota return against its filed class (movimento incomum).
• instruments: api.portfolio_instruments: CRA, CRI and debenture codes matched to their series, one line per code.
• fund_terms: api.portfolio_fund_terms: manager, administrator and redemption terms as filed, one line per CNPJ.
• equivalents: api.portfolio_equivalents: the active ETFs tracking an index the owner-reviewed list maps to each filed class.
• debenture_returns: api.portfolio_debenture_returns: 13 month-ends of median fund marks (CDA block 4) per debenture ticker; marks, not trades. Needs month.

A data call is a POST: kind, month and the hidden parameters go in the query string, the lists go in a JSON body (see body). ?help stays a GET. Read-only: every kind is one api.portfolio_* function.

Each list is capped by its function (200 entries, 70 for debenture_returns, 50 classes for equivalents) and refused above it, never trimmed.

Not served: portfolio_credit_returns (held back with the ANBIMA-linked endpoints). The class in fees, fee_peers, movement and equivalents is the ANBIMA class label as filed in the CVM Extrato; no ANBIMA table is read.

GET /v2/portfolio?help describes the main parameters, ?help=all adds the hidden ones.

POST /portfolio

v2 portfolio

cURL

curl --request POST \
  --url https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/portfolio \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "names": [
    "ITAU RF DI"
  ]
}
'

200

{
  "data": [
    "<unknown>"
  ],
  "meta": {
    "resource": "<string>",
    "kind": "<string>",
    "request": {},
    "id_known": true,
    "endpoint": "<string>"
  },
  "next_page_url": "<string>"
}

Authorizations

apikeyapikey & bearerAuth

apikey · string · header · default: sb_publishable__yfFQsykAglrvc9GS6_PYw_B24ex437 · required

The public publishable key. It identifies the project, not you, and is the anonymous tier.

Query Parameters

kind · enum<string> · default: resolve

resolve: statement lines to candidate funds. fees: estimated and disclosed fees. fee_peers: the admin fee against its filed class. lookthrough: holdings through fund quotas. movement: the month's quota return against its class. instruments: CRA, CRI and debenture codes. fund_terms: manager, administrator, redemption terms. equivalents: the ETFs that track a class's index. debenture_returns: 13 month-ends of debenture marks. Default: resolve.

Available options: resolve, fees, fee_peers, lookthrough, movement, instruments, fund_terms, equivalents, debenture_returns

month · string<date>

Any day of the month. fees, lookthrough, movement: the month read. debenture_returns: the window's last month. Default: the latest complete month, as each function defines it (fees: each fund's newest balancete; lookthrough: the last complete CDA month; movement: the last complete FI month). debenture_returns has no default month and needs one.

limit · integer

The page size. More rows than one page come through next_page_url, never cut silently; a call stops at the tier's rows-per-call cap with meta.tier_cap_reached. Default: the tier's page maximum (10 anonymous, 100 signed in); a larger value is coerced to it.

Required range: x >= 1

cursor · string

The opaque cursor from a previous next_page_url. It carries every other parameter: send it alone (another parameter with a different value is bad_request). Default: none: the first page.

max_depth · integer · default: 4

Hidden parameter (?help=all lists it). lookthrough: fund-quota levels looked through, 1..6 (the SQL default is 4). Default: 4.

Required range: x >= 0

as_of · string<date>

Hidden parameter (?help=all lists it). fee_peers: dates the comparison and excludes later documents; it reads the latest Extrato, so it is not a historical backtest. equivalents: snapshots dated after it are not read. Default: today (the SQL default).

max_monthly_drop_pct · number

Hidden parameter (?help=all lists it). debenture_returns: a monthly PU drop beyond this is flagged queda_pu_possivel_evento. Default: none: every decrease is flagged limite_pendente (the threshold is the owner's to set).

Required range: x >= 0

Body

application/json

A JSON object of lists. Every other parameter goes in the query string.

id · (string | null)[]

The list: fund CNPJs (fees, fee_peers, lookthrough, movement, fund_terms; resolve: the CNPJ each line prints, parallel to names), instrument codes (instruments), filed ANBIMA class labels (equivalents) or debenture tickers (debenture_returns). Null entries are allowed where the function takes them. Default: none: required by every kind except resolve.

names · (string | null)[]

resolve: one statement line each, the fund name as printed. Default: none: required by resolve.

quotas · (number | null)[]

resolve: the quota value each line prints, parallel to names, for the tie-break. Default: none.

quota_dates · (string<date> | null)[]

resolve: the date each quota refers to, parallel to names. Default: none.

Response

200

application/json

The v2 envelope.

data · any[] · required

Always a list. Rows as the endpoint returned them; null stays null.

meta · object · required

Show child attributes

next_page_url · string

Present only when more rows remain. It carries one opaque cursor.