v2 statements

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

import requests

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

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/statements', 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/statements",
  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/statements"

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

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 statements

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

What did the company file? Income, balance sheet, cash flow, headline figures and every stored version.

Example: /v2/statements?id=PETR4&kind=income

Kinds:

all: api.financials: every line, one row per account, latest stored version. Paged by date windows. With no id (every kind): the research universe, whose cnpj links a ticker to its filer.
income: api.income_statements: one row per filed period, with period_months.
balance: api.balance_sheets: one row per filed date. A balance sheet is a point in time, so the source has no period_months.
cashflow: api.cash_flow_statements: one row per filed period, with period_months.
headline: api.company_financials: headline figures per filed period. The function takes no p_doc_type, so period is a selection on the rows’ doc_type.
versions: api.financial_statement_history: every stored version of one statement (hidden statement, default DRE), with filing metadata. No as_of: it already shows every version.

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

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

GET

statements

v2 statements

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

import requests

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

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/statements', 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/statements",
  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/statements"

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

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

all: every filed line, long (api.financials). income, balance, cashflow: the standard lines, wide. headline: revenue, net income, assets, equity, margins (api.company_financials). versions: every stored version of one statement (api.financial_statement_history). Default: all.

Available options:

all,

income,

balance,

cashflow,

headline,

versions

period

enum<string>

default:both

quarterly: ITR filings. annual: DFP filings. A quarterly filing holds the 3-month and the year-to-date figure; period_months on the row says which. Never add the two. Default: both.

Available options:

both,

quarterly,

annual

scope

enum<string>

default:consolidated

Consolidated and individual are separate filings of the same period; they are never merged. Default: consolidated.

Available options:

consolidated,

individual

string

By kind: all, income, balance, cashflow, headline, versions take a listed company's ticker, 14-digit CNPJ or CVM code. With no id, kinds all, income, balance, cashflow, headline, versions read api.research_universe (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.

as_of

string<date>

Hidden parameter (?help=all lists it). Point in time: only documents CVM received before this date, at the highest version known then. Not for kind versions. Default: none: the latest stored version of every document, which is NOT point in time.

statement

enum<string>

default:DRE

Hidden parameter (?help=all lists it). kind versions: the one statement to read (DRE income, BPA assets, BPP liabilities and equity, DFC_MD or DFC_MI cash flow, DMPL, DRA, DVA). Default: DRE.

Available options:

DRE,

BPA,

BPP,

DFC_MD,

DFC_MI,

DMPL,

DRA,

DVA

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 statements

Authorizations

Query Parameters

Response