Filtra e ordena os fundos negociados na B3 (FIIs, Fiagros, FI-Infra, ETFs, FIDCs e FIPs) por preço, rendimentos, P/VP, liquidez, patrimônio e cotistas. Uma chamada percorre todos os fundos.
assetType escolhe o tipo de fundo. Para FIIs, segmentType separa tijolo, papel, fundos de fundos e híbridos, e segment usa o segmento do cadastro da CVM. Para ETFs, etfCategory separa renda fixa, renda variável, cripto e imobiliário.
Cada indicador aceita {chave}Min e {chave}Max. Os limites são inclusivos e usam a mesma unidade da resposta: 10% é 0.1. Um filtro remove os fundos sem o dado. Na ordenação, os nulos ficam no fim.
Exemplos:
?assetType=fii&segmentType=papel÷ndYieldMin=0.12&priceToNavMax=0.95&sortBy=dividendYield?assetType=etf&etfCategory=fixed-income&sortBy=totalFeePercent&sortOrder=ascdividendYield soma só os rendimentos dos últimos 12 meses pela data-com, sem amortizações, e divide pelo último preço. priceToNav usa o último preço e o valor patrimonial por cota do último informe. averageDailyTradedValue divide o valor negociado nos últimos 30 dias pelos pregões do período.
Plano Pro.
| Indicador | Chave | Unidade |
|---|---|---|
| Preço | lastPrice | reais |
| Variação no dia | changePercent | porcentagem (2.81 = 2,81%) |
| Volume | volume | quantidade |
| Liquidez diária | averageDailyTradedValue | reais |
| Valor de mercado | marketCap | reais |
| Dividend yield 12m | dividendYield | fração (0.06 = 6%) |
| Último rendimento | lastDividend | reais |
| Yield do último rendimento | lastDividendYield | fração (0.06 = 6%) |
| Meses com rendimento | incomeMonths12m | quantidade |
| Valor patrimonial/cota | navPerShare | reais |
| P/VP | priceToNav | múltiplo |
| Patrimônio líquido | equity | reais |
| Cotistas | totalInvestors | quantidade |
| Variação em 12 meses | priceChange12m | fração (0.06 = 6%) |
| Taxa total | totalFeePercent | porcentagem (2.81 = 2,81%) |
Bearer Token de API obtido no dashboard em brapi.dev/dashboard
In: header
Parte do ticker ou do nome do fundo.
Tipo do fundo: fii, fiagro, fiinfra, etf, fidc, fip ou fif. Sem ele, todos os fundos listados.
Value in
Tipo do FII pelo último informe: tijolo (imóveis), papel (CRI, LCI e títulos), fof (cotas de outros FIIs) ou hibrido.
Value in
Segmento do FII no cadastro da CVM, como Logística, Shoppings, Escritórios ou Títulos e Val. Mob. Nome exato, sem diferença de maiúsculas.
Categoria do ETF pela lista da bolsa: fixed-income, equity, crypto ou real-estate.
Value in
Campo de ordenação: uma chave de métrica, symbol ou name. Padrão: averageDailyTradedValue. Valores nulos ficam no fim.
"averageDailyTradedValue"Value in
Ordem. Padrão: desc.
"desc"Value in
Número da página. Começa em 1.
0 <= value <= 100001Itens por página. Máximo: 200.
0 <= value <= 20020Preço: valor mínimo, inclusive. Unidade: reais.
Preço: valor máximo, inclusive. Unidade: reais.
Variação no dia: valor mínimo, inclusive. Unidade: porcentagem (2.81 = 2,81%).
Variação no dia: valor máximo, inclusive. Unidade: porcentagem (2.81 = 2,81%).
Volume: valor mínimo, inclusive. Unidade: quantidade.
Volume: valor máximo, inclusive. Unidade: quantidade.
Liquidez diária: valor mínimo, inclusive. Unidade: reais.
Liquidez diária: valor máximo, inclusive. Unidade: reais.
Valor de mercado: valor mínimo, inclusive. Unidade: reais.
Valor de mercado: valor máximo, inclusive. Unidade: reais.
Dividend yield 12m: valor mínimo, inclusive. Unidade: fração (0.06 = 6%).
Dividend yield 12m: valor máximo, inclusive. Unidade: fração (0.06 = 6%).
Último rendimento: valor mínimo, inclusive. Unidade: reais.
Último rendimento: valor máximo, inclusive. Unidade: reais.
Yield do último rendimento: valor mínimo, inclusive. Unidade: fração (0.06 = 6%).
Yield do último rendimento: valor máximo, inclusive. Unidade: fração (0.06 = 6%).
Meses com rendimento: valor mínimo, inclusive. Unidade: quantidade.
Meses com rendimento: valor máximo, inclusive. Unidade: quantidade.
Patrimônio líquido: valor mínimo, inclusive. Unidade: reais.
Patrimônio líquido: valor máximo, inclusive. Unidade: reais.
Cotistas: valor mínimo, inclusive. Unidade: quantidade.
Cotistas: valor máximo, inclusive. Unidade: quantidade.
Variação em 12 meses: valor mínimo, inclusive. Unidade: fração (0.06 = 6%).
Variação em 12 meses: valor máximo, inclusive. Unidade: fração (0.06 = 6%).
Taxa total: valor mínimo, inclusive. Unidade: porcentagem (2.81 = 2,81%).
Taxa total: valor máximo, inclusive. Unidade: porcentagem (2.81 = 2,81%).
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/funds/screener"{ "results": [ { "symbol": "PETR4", "name": "Petróleo Brasileiro S.A.", "longName": "Petroleo Brasileiro SA Petrobras Preference Shares", "assetType": "stock", "subType": "stock", "exchange": "B3", "currency": "BRL", "sector": "Energy Minerals", "subsector": "Petróleo, Gás e Biocombustíveis", "isActive": true, "logoUrl": "https://icons.brapi.dev/icons/PETR4.svg", "quote": { "lastPrice": 36.65, "changePercent": -0.95, "volume": 27681100, "marketCap": 483937892568 }, "fund": { "cnpj": "11728688000147", "type": "fii", "segmentType": "tijolo", "segment": "Logística", "mandate": "Renda", "managementType": "Ativa", "etfCategory": null, "managerName": "string", "administratorName": "string", "reportDate": "2026-09-30", "lastDividendDate": "2026-09-30" }, "metrics": { "averageDailyTradedValue": 21450000, "marketCap": 5120000000, "dividendYield": 0.0874, "lastDividend": 1.1, "lastDividendYield": 0.0069, "incomeMonths12m": 12, "navPerShare": 156.12, "priceToNav": 1.01, "equity": 5040000000, "totalInvestors": 412000, "priceChange12m": 0.052, "totalFeePercent": 0.1 } } ], "pagination": { "page": 1, "limit": 20, "totalItems": 2302, "totalPages": 116, "hasNextPage": true }, "requestedAt": "2025-01-24T17:32:38.000Z", "took": 45}