v2 positioning

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

import requests

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

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

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

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 positioning

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

Who is short, lending or flowing in? Short interest, lending trades and brokers, investor flow.

Example: /v2/positioning?id=PETR4

Kinds:

short_interest: api.short_interest (a GET view), newest first. With no id, every ticker, paged with order + limit + offset.
short_by_sector: api.short_interest_by_sector (a GET view), newest first.
lending: api.lending_trades (a GET view): count, quantity, rates and how many brokers stood on each leg, newest first.
lending_brokers: api.lending_participants (a GET view): per broker, quantity lent, borrowed and net, and how much it crossed its own clients, newest first.
investor_flow: api.investor_flow (a GET view): buy, sell and net by investor type, newest first.

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

B3 keeps about 21 business days of the lending book and publishes no archive: history starts when SILO began capturing, and a missed session is lost, not late.

Short interest reads only B3’s own Total rows of the open-position book (is_total), never the per-market rows added up. Read pct_float with float_basis: index_free_float and shares_outstanding are different denominators.

lending_brokers: the broker is the B3 participant on the leg (doador / tomador), not the beneficial owner; about 75% of trades carry the same broker on both legs. Never read a large borrow as the broker being short.

investor_flow is in R$ thousands, differenced from B3’s month-to-date snapshots; a row with flow_basis unknown_opening_snapshot carries null flows on purpose.

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

GET

positioning

v2 positioning

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

import requests

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

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

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

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

short_interest: the short balance per ticker and session, with % of float and days to cover. short_by_sector: the short balance by B3 sector. lending: daily lending trades per ticker. lending_brokers: per ticker, session and broker, quantity lent and borrowed. investor_flow: daily net flow by investor type. Default: short_interest.

Available options:

short_interest,

short_by_sector,

lending,

lending_brokers,

investor_flow

string

By kind: short_interest takes a B3 ticker (none: every ticker); lending, lending_brokers take a B3 ticker. Kinds short_by_sector, investor_flow take no id. 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.

sector

string

default:all

Hidden parameter (?help=all lists it). kind short_interest and short_by_sector: one B3 sector, exactly as B3 publishes it (Não classificado holds the tickers with none). Default: all.

investor_type

string

default:all

Hidden parameter (?help=all lists it). kind investor_flow: one investor type, exactly as B3 publishes it. 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 positioning

Authorizations

Query Parameters

Response