fiis

Screen Fiis

Screen FIIs by P/VP, dividend yield, NAV, vacancy, etc.

Use {metric}_gt and {metric}_lt query params to filter (e.g. ?pvp_lt=1&dividend_yield_ttm_gt=8&vacancy_pct_lt=5).

get/api/v1/fiis/screener

Request

Base URL
https://usebolsai.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/usebolsai/apis/bolsai/docs/api/v1/fiis/screener/get.ts
A function with typed inputs. Its response is checked against the schema.

segmentstring nullable

Filter by segment (case-insensitive)

management_typestring nullable

Filter by management type (case-insensitive)

mandatestring nullable

Filter by mandate (Renda/Ganho de Capital)

fund_typestring nullable

Filter by fund_type (Tijolo/Papel/Fundo de Fundos/Híbrido/Fiagro)

administratorstring nullable

Filter by administrator (case-insensitive exact match)

sortstring

Metric to sort by

orderstring

Sort order: asc or desc

limitinteger

Results per page

offsetinteger

Pagination offset

formatstring

Response format: json or csv

Successful Response

unknown required

No recorded changes to this operation across all 14 revisions of this API.