Skip to main content
GET
v2 screens

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

list (the default, no kind given): the screens, one line each, with their defaults. Any other value runs that screen (api.screen_). Default: list.

Available options:
list,
captive_vehicles,
delinquency_drivers,
dormant_funds,
dormant_trend,
evergreen_aging,
late_filers,
overdue_securit,
restatements,
silent_filers,
zombie_growth
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.

date
string<date>

Hidden parameter (?help=all lists it). zombie_growth: the aging month-end (p_period). delinquency_drivers, restatements, late_filers: the window end (p_end). Default: the screen's own: zombie_growth the latest aging month; delinquency_drivers the latest complete FIDC month; restatements today; late_filers the newest month whose deadline has passed.

months
integer

Hidden parameter (?help=all lists it). delinquency_drivers (2..24), restatements, late_filers (1..36): the window length in months. Default: the screen's SQL default (12).

Required range: x >= 0
lookback_months
integer

Hidden parameter (?help=all lists it). captive_vehicles, evergreen_aging, dormant_funds, dormant_trend: the trailing window in months. Default: the screen's SQL default: captive_vehicles 3, evergreen_aging 12, dormant_funds 3, dormant_trend 3.

Required range: x >= 0
history_months
integer

Hidden parameter (?help=all lists it). dormant_trend: month-ends emitted, 1..60. Default: the SQL default (36).

Required range: x >= 0
min_months
integer

Hidden parameter (?help=all lists it). delinquency_drivers: observations a fund needs, 2..months. Default: the SQL default (6).

Required range: x >= 0
min_aum
number

Hidden parameter (?help=all lists it). zombie_growth, captive_vehicles: the NAV floor, BRL. Default: the screen's SQL default: zombie_growth 1000000, captive_vehicles 50000000 (BRL).

Required range: x >= 0
min_nav
number

Hidden parameter (?help=all lists it). dormant_funds: keep rows whose last NAV is at least this, BRL (an output filter). Default: none: no floor.

Required range: x >= 0
min_delinq_pct
number

Hidden parameter (?help=all lists it). zombie_growth: delinquency floor, percent of NAV, 0..100. Default: the SQL default (5).

Required range: x >= 0
max_investors
integer

Hidden parameter (?help=all lists it). captive_vehicles: flagged when the window minimum quotaholder count is below this, 1..1000. Default: the SQL default (10).

Required range: x >= 0
min_longtail_pct
number

Hidden parameter (?help=all lists it). evergreen_aging: share of delinquency overdue more than 1080 days, 0..100. Default: the SQL default (70).

Required range: x >= 0
max_variation_pp
number

Hidden parameter (?help=all lists it). evergreen_aging: largest move of that share across the window, percentage points. Default: the SQL default (10).

Required range: x >= 0
min_volume
number

Hidden parameter (?help=all lists it). overdue_securit: paid-in volume floor, BRL. Default: the SQL default (100000).

Required range: x >= 0
min_delta_brl
number

Hidden parameter (?help=all lists it). delinquency_drivers: the up/down threshold on delinquency, BRL. Default: the SQL default (1000000).

Required range: x >= 0
min_delta_pp
number

Hidden parameter (?help=all lists it). delinquency_drivers: the up/down threshold on the rate, percentage points. Default: the SQL default (1.0).

Required range: x >= 0
min_restatements
integer

Hidden parameter (?help=all lists it). restatements: re-filings (versao > 1) in the window, 1..1000. Default: the SQL default (3).

Required range: x >= 0
min_rate_pct
number

Hidden parameter (?help=all lists it). restatements: re-filings as percent of the fund's documents in the window, 0..100. Default: the SQL default (20).

Required range: x >= 0
min_days_late
integer

Hidden parameter (?help=all lists it). late_filers: days past the cited deadline that count as late, 1..90. Default: the SQL default (5).

Required range: x >= 0
min_late
integer

Hidden parameter (?help=all lists it). late_filers: late months a fund needs in the window. Default: the SQL default (2).

Required range: x >= 0
min_silent_months
integer

Hidden parameter (?help=all lists it). silent_filers: complete months with no filing, 1..120. Default: the SQL default (3).

Required range: x >= 0
max_silent_months
integer

Hidden parameter (?help=all lists it). silent_filers: and at most this many, up to 240. Default: the SQL default (24).

Required range: x >= 0
dormancy
enum<string>
default:all

Hidden parameter (?help=all lists it). dormant_funds: keep one dormancy (an output filter). empty_shell: no quotaholder. parked_capital: quotaholders, no flow. Default: all.

Available options:
all,
empty_shell,
parked_capital
driver
enum<string>
default:all

Hidden parameter (?help=all lists it). delinquency_drivers: keep one class of move (an output filter). Default: all.

Available options:
all,
consistent_worsening,
value_up_rate_masked,
denominator_only,
improvement,
stable
modality
enum<string>
default:all

Hidden parameter (?help=all lists it). restatements: count only one FNET modalidade. RE: voluntary. RC: required by CVM. Default: all.

Available options:
all,
RE,
RC
family
enum<string>
default:all

Hidden parameter (?help=all lists it). late_filers (fii, fidc) and silent_filers (fi, fidc, fii, fiagro): keep one family (an output filter). Default: all.

Available options:
all,
fi,
fidc,
fii,
fiagro

Response

The v2 envelope.

data
any[]
required

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

meta
object
required
next_page_url
string

Present only when more rows remain. It carries one opaque cursor.