v2 fidc

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

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

fetch('https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/fidc', 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/fidc",
  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/fidc"

	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/fidc")

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 fidc

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

What is inside this FIDC? Portfolio, tranches, aging, cedentes, sacados.

Example: /v2/fidc?id=<cnpj>&kind=tranches

Kinds:

portfolio: api.fidc_portfolio, newest first. Paged by date windows. With no id: the FIDC registry, ordered by cnpj.
tranches: api.fidc_tranches: per series, quota value, quotaholders and returns. Paged by date windows.
aging: api.fidc_aging: the to_maturity, overdue and overdue_total ladders. Paged by date windows.
cedentes: api.fidc_cedentes: the originators a fund buys from, or with cedente the funds that buy from one. Paged by date windows.
sacados: api.fidc_sacados: the largest debtors, as anonymized ranks (there is no debtor-side lookup). Paged by date windows.

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

id is a FIDC CNPJ: 14 digits, punctuation allowed. With no id, kind=portfolio lists the FIDC registry (api.funds, entity_type fidc).

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.

Tab X (the SCR grade ladders of kind=portfolio) is filed from 2023-10: earlier months have no scr rows, not zero-graded ones. Values are as filed.

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

GET

fidc

v2 fidc

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

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

fetch('https://zcjbtpxuhdekpwcxmepn.supabase.co/functions/v1/silo-api/v2/fidc', 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/fidc",
  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/fidc"

	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/fidc")

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

portfolio: the receivables book, long (tab II sectors, tab X SCR ladders, tax debt). tranches: each senior and subordinated series. aging: the to-maturity and overdue ladders. cedentes: the originators it buys from. sacados: its largest debtors, as anonymized ranks. Default: portfolio.

Available options:

portfolio,

tranches,

aging,

cedentes,

sacados

string

By kind: portfolio, tranches, aging, cedentes, sacados take a FIDC's 14-digit fund CNPJ (punctuation allowed). Required for kinds tranches, aging, sacados. Kind cedentes: id or cedente is required. With no id, kind portfolio 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.

series

string

default:all

Hidden parameter (?help=all lists it). kind=tranches: one TAB_X_CLASSE_SERIE, matched exactly as filed. Default: all.

cedente

string

default:all

Hidden parameter (?help=all lists it). kind=cedentes, instead of id: the funds that buy from this originator (CPF or CNPJ, or a listed ticker or CVM code). Default: all.

item

enum<string>

default:all

Hidden parameter (?help=all lists it). kind=portfolio: one part of the book, matched against the row's kind column: sector (tab II), scr_debtor or scr_operation (tab X ladders), tax_debt. Default: all.

Available options:

all,

sector,

scr_debtor,

scr_operation,

tax_debt

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 fidc

Authorizations

Query Parameters

Response