v2

latestOpenAPI 3.1.02026-07-26512050.1 KB
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

Query parameters

segmentstring nullable

Filter by segment (case-insensitive)

Filter by segment (case-insensitive)

management_typestring nullable

Filter by management type (case-insensitive)

Filter by management type (case-insensitive)

mandatestring nullable

Filter by mandate (Renda/Ganho de Capital)

Filter by mandate (Renda/Ganho de Capital)

fund_typestring nullable

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

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

administratorstring nullable

Filter by administrator (case-insensitive exact match)

Filter by administrator (case-insensitive exact match)

sortstring

Metric to sort by

Metric to sort by

orderstring

Sort order: asc or desc

Sort order: asc or desc

limitinteger

Results per page

Results per page

offsetinteger

Pagination offset

Pagination offset

formatstring

Response format: json or csv

Response format: json or csv

Response

Successful Response

{"stackTrail":"paths:/api/v1/fiis/screener:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}