v2 funds

curl --request GET \
  --url https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds \
  --header 'apikey: <api-key>'

import requests

url = "https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

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

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "target": "<string>",
    "innererror": {
      "sqlstate": "<string>",
      "hint": "<string>",
      "details": "<string>"
    }
  }
}

API Reference

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.

GET

funds

v2 funds

curl --request GET \
  --url https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds \
  --header 'apikey: <api-key>'

import requests

url = "https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/funds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

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

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "target": "<string>",
    "innererror": {
      "sqlstate": "<string>",
      "hint": "<string>",
      "details": "<string>"
    }
  }
}

Authorizations

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:profile

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.

Available options:

profile,

nav,

holdings,

debentures,

properties

family

enum<string>

default:all

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.

Available options:

all,

fi,

fidc,

fii,

fip,

fiagro

string

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.

from

string<date>

First date of the window, YYYY-MM-DD. Default: the resource's default window, counted back from to.

string<date>

Last date of the window, YYYY-MM-DD. Default: the latest complete period, from coverage.

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.

holding

string

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.

status

string

default:all

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.

Response

The v2 envelope.

data

any[]

required

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

Overview

Data

Get started

Guides

API reference

Endpoints

v2 (preview)

v2 endpoints (preview)

v2 funds

Authorizations

Query Parameters

Response