> ## 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.

# v2 funds

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

What is this fund and how is it doing? Profile, NAV, holdings, debentures, FII properties.

Example: `/v2/funds?id=33000167000101&kind=nav`

Kinds:

- `profile`: api.fund_profile: one row per family the CNPJ files under. With no id: the api.funds registry view, ordered by cnpj, paged with order + limit + offset.
- `nav`: api.fund_nav: monthly NAV, quota, quotaholders and flows, oldest first. With no to, the series ends at the family's latest complete period. Refuses above 1000 rows: narrow from, or pin family.
- `holdings`: api.fund_holdings: the listed equities a fund holds (CDA), or with holding the funds that hold a ticker. Paged by date windows.
- `debentures`: api.fund_debentures: the debentures a fund holds, or with holding the funds that hold an issuer's paper. Paged by date windows.
- `properties`: api.fii_property_history: an FII's properties, every filed version, newest first.

With no `from`, a dated kind reads the last 36 months to `to`.

id is a fund CNPJ: 14 digits, punctuation allowed. Find one with /v2/search?kind=fund&q=<name>.

kind=nav columns are per family: a null outside the family's list is not applicable, not missing (coverage?kind=catalog, applicability).

FIDC delinquency (api.fund_nav, panel) starts 2013-01 and is on every row only from 2020-11 (regime break; coverage?kind=catalog lists it under regime_breaks). Through 2020-10-31 a fund with no tab VI row that month is null, not zero and not clean books; from 2020-11-30 it is filed on every row (a fund with none files 0). Never read a pre-2020-11 null as zero or fill it, and never compare a count of reporting funds across 2020-10 -> 2020-11.

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



## OpenAPI

````yaml /api-docs/v2/openapi.json get /funds
openapi: 3.1.0
info:
  title: SILO API v2 (preview, not deployed)
  version: v2
  description: >-
    The v2 gateway over SILO's schema `api`: 14 resources, five shared
    parameters, one envelope and one error object. Generated from
    supabase/functions/silo-api/registry.ts by scripts/gen_openapi_v2.py; do not
    edit by hand. Preview, not deployed. The v2 gateway is built but not
    deployed yet; this call works once the owner deploys `silo-api`.
servers:
  - url: https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2
    description: The silo-api Edge Function (preview, not deployed).
security:
  - apikey: []
  - apikey: []
    bearerAuth: []
paths:
  /funds:
    get:
      summary: v2 funds
      description: >-
        <Warning>Preview, not deployed. The v2 gateway is built but not deployed
        yet; this call works once the owner deploys `silo-api`.</Warning>


        What is this fund and how is it doing? Profile, NAV, holdings,
        debentures, FII properties.


        Example: `/v2/funds?id=33000167000101&kind=nav`


        Kinds:


        - `profile`: api.fund_profile: one row per family the CNPJ files under.
        With no id: the api.funds registry view, ordered by cnpj, paged with
        order + limit + offset.

        - `nav`: api.fund_nav: monthly NAV, quota, quotaholders and flows,
        oldest first. With no to, the series ends at the family's latest
        complete period. Refuses above 1000 rows: narrow from, or pin family.

        - `holdings`: api.fund_holdings: the listed equities a fund holds (CDA),
        or with holding the funds that hold a ticker. Paged by date windows.

        - `debentures`: api.fund_debentures: the debentures a fund holds, or
        with holding the funds that hold an issuer's paper. Paged by date
        windows.

        - `properties`: api.fii_property_history: an FII's properties, every
        filed version, newest first.


        With no `from`, a dated kind reads the last 36 months to `to`.


        id is a fund CNPJ: 14 digits, punctuation allowed. Find one with
        /v2/search?kind=fund&q=<name>.


        kind=nav columns are per family: a null outside the family's list is not
        applicable, not missing (coverage?kind=catalog, applicability).


        FIDC delinquency (api.fund_nav, panel) starts 2013-01 and is on every
        row only from 2020-11 (regime break; coverage?kind=catalog lists it
        under regime_breaks). Through 2020-10-31 a fund with no tab VI row that
        month is null, not zero and not clean books; from 2020-11-30 it is filed
        on every row (a fund with none files 0). Never read a pre-2020-11 null
        as zero or fill it, and never compare a count of reporting funds across
        2020-10 -> 2020-11.


        `GET /v2/funds?help` describes the main parameters, `?help=all` adds the
        hidden ones.
      operationId: v2_funds
      parameters:
        - name: kind
          in: query
          required: false
          description: >-
            profile: one fund's registry row and AUM (with no id: the fund
            registry). nav: the monthly NAV and flows series. holdings: the
            listed equities it holds (CDA). debentures: the debentures it holds.
            properties: an FII's real estate. Default: profile.
          schema:
            type: string
            enum:
              - profile
              - nav
              - holdings
              - debentures
              - properties
            default: profile
          example: nav
        - name: family
          in: query
          required: false
          description: >-
            One fund family. kind=nav: the series filed under that family (one
            CNPJ can file under two). With no id: the registry rows of that
            family. Default: all.
          schema:
            type: string
            enum:
              - all
              - fi
              - fidc
              - fii
              - fip
              - fiagro
            default: all
        - name: id
          in: query
          required: false
          description: >-
            By kind: profile, nav, holdings, debentures, properties take a
            14-digit fund CNPJ (punctuation allowed). Required for kinds nav,
            properties. Kind holdings: id or holding is required. Kind
            debentures: id or holding is required. With no id, kind profile
            reads api.funds (what SILO holds). Default: none.
          schema:
            type: string
          example: '33000167000101'
        - name: from
          in: query
          required: false
          description: >-
            First date of the window, YYYY-MM-DD. Default: the resource's
            default window, counted back from to.
          schema:
            type: string
            format: date
        - name: to
          in: query
          required: false
          description: >-
            Last date of the window, YYYY-MM-DD. Default: the latest complete
            period, from coverage.
          schema:
            type: string
            format: date
        - name: limit
          in: query
          required: false
          description: >-
            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.
          schema:
            type: integer
            minimum: 1
        - name: cursor
          in: query
          required: false
          description: >-
            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.
          schema:
            type: string
        - name: holding
          in: query
          required: false
          description: >-
            Hidden parameter (`?help=all` lists it). Reverse lookup, instead of
            id. kind=holdings: the funds that hold this ticker. kind=debentures:
            the funds that hold this issuer's debentures (ticker, CVM code or
            CNPJ). Default: none: what the fund in id holds.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: >-
            Hidden parameter (`?help=all` lists it). With no id: only registry
            rows whose status is this, exactly as CVM publishes it (e.g. EM
            FUNCIONAMENTO NORMAL). Default: all.
          schema:
            type: string
            default: all
      responses:
        '200':
          description: The v2 envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
        default:
          description: >-
            The v2 error object. A SILO refusal (over_limit) keeps its message,
            hint and details verbatim.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Envelope:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items: {}
          description: Always a list. Rows as the endpoint returned them; null stays null.
        meta:
          type: object
          required:
            - resource
            - kind
            - request
            - id_known
          properties:
            resource:
              type: string
            kind:
              type:
                - string
                - 'null'
            request:
              type: object
              description: Every parameter the resource takes, with the default applied.
            id_known:
              type:
                - boolean
                - 'null'
              description: Whether SILO holds the id; null when the call names none.
            endpoint:
              type: string
              description: The api.* endpoint that answered.
          additionalProperties: true
        next_page_url:
          type: string
          description: Present only when more rows remain. It carries one opaque cursor.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - target
            - innererror
          properties:
            code:
              type: string
              enum:
                - bad_request
                - unknown_parameter
                - unknown_id
                - unauthorized
                - forbidden_for_tier
                - over_limit
                - rate_limited
                - timeout
                - unavailable
                - internal
            message:
              type: string
            target:
              type:
                - string
                - 'null'
            innererror:
              type: object
              properties:
                sqlstate:
                  type:
                    - string
                    - 'null'
                hint:
                  type:
                    - string
                    - 'null'
                details:
                  type:
                    - string
                    - 'null'
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: apikey
      description: >-
        The public publishable key. It identifies the project, not you, and is
        the anonymous tier.
      x-default: sb_publishable__yfFQsykAglrvc9GS6_PYw_B24ex437
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Optional. A user JWT from Supabase Auth, for the signed-in tier. Never a
        secret key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.