BRbrapi-dev
Fundos

Filtrar fundos listados por indicadores

Changed on

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:

  • FIIs de papel com dividend yield de pelo menos 12% e P/VP até 0,95: ?assetType=fii&segmentType=papel&dividendYieldMin=0.12&priceToNavMax=0.95&sortBy=dividendYield
  • ETFs de renda fixa pela menor taxa: ?assetType=etf&etfCategory=fixed-income&sortBy=totalFeePercent&sortOrder=asc

dividendYield 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.

IndicadorChaveUnidade
PreçolastPricereais
Variação no diachangePercentporcentagem (2.81 = 2,81%)
Volumevolumequantidade
Liquidez diáriaaverageDailyTradedValuereais
Valor de mercadomarketCapreais
Dividend yield 12mdividendYieldfração (0.06 = 6%)
Último rendimentolastDividendreais
Yield do último rendimentolastDividendYieldfração (0.06 = 6%)
Meses com rendimentoincomeMonths12mquantidade
Valor patrimonial/cotanavPerSharereais
P/VPpriceToNavmúltiplo
Patrimônio líquidoequityreais
CotistastotalInvestorsquantidade
Variação em 12 mesespriceChange12mfração (0.06 = 6%)
Taxa totaltotalFeePercentporcentagem (2.81 = 2,81%)
get/api/v2/funds/screener

Request

  • Base URL
    https://brapi.dev
  • URL
    https://brapi.dev/api/v2/funds/screener
  • Auth
    HTTP bearer

Query parameters

searchstring

Parte do ticker ou do nome do fundo.

Example:KINEA
assetType'fii' | 'fiagro' | 'fiinfra' | 'etf' | 'fidc' | 'fip' | 'fif'

Tipo do fundo: fii, fiagro, fiinfra, etf, fidc, fip ou fif. Sem ele, todos os fundos listados.

Example:fii
segmentType'tijolo' | 'papel' | 'hibrido' | 'fof'

Tipo do FII pelo último informe: tijolo (imóveis), papel (CRI, LCI e títulos), fof (cotas de outros FIIs) ou hibrido.

Example:papel
segmentstring

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.

Example:Logística
etfCategory'fixed-income' | 'equity' | 'crypto' | 'real-estate'

Categoria do ETF pela lista da bolsa: fixed-income, equity, crypto ou real-estate.

Example:fixed-income
sortBy'symbol' | 'name' | 'lastPrice' | 'changePercent' | 'volume' | 'averageDailyTradedValue' | 'marketCap' | 'dividendYield' | 'lastDividend' | 'lastDividendYield' | 'incomeMonths12m' | 'navPerShare' | 'priceToNav' | 'equity' | 'totalInvestors' | 'priceChange12m' | 'totalFeePercent'

Campo de ordenação: uma chave de métrica, symbol ou name. Padrão: averageDailyTradedValue. Valores nulos ficam no fim.

Example:dividendYield
sortOrder'asc' | 'desc'

Ordem. Padrão: desc.

Example:desc
pageinteger

Número da página. Começa em 1.

Example:1
limitinteger

Itens por página. Máximo: 200.

Example:20
lastPriceMinnumber

Preço: valor mínimo, inclusive. Unidade: reais.

lastPriceMaxnumber

Preço: valor máximo, inclusive. Unidade: reais.

changePercentMinnumber

Variação no dia: valor mínimo, inclusive. Unidade: porcentagem (2.81 = 2,81%).

changePercentMaxnumber

Variação no dia: valor máximo, inclusive. Unidade: porcentagem (2.81 = 2,81%).

volumeMinnumber

Volume: valor mínimo, inclusive. Unidade: quantidade.

volumeMaxnumber

Volume: valor máximo, inclusive. Unidade: quantidade.

averageDailyTradedValueMinnumber

Liquidez diária: valor mínimo, inclusive. Unidade: reais.

averageDailyTradedValueMaxnumber

Liquidez diária: valor máximo, inclusive. Unidade: reais.

marketCapMinnumber

Valor de mercado: valor mínimo, inclusive. Unidade: reais.

marketCapMaxnumber

Valor de mercado: valor máximo, inclusive. Unidade: reais.

dividendYieldMinnumber

Dividend yield 12m: valor mínimo, inclusive. Unidade: fração (0.06 = 6%).

dividendYieldMaxnumber

Dividend yield 12m: valor máximo, inclusive. Unidade: fração (0.06 = 6%).

lastDividendMinnumber

Último rendimento: valor mínimo, inclusive. Unidade: reais.

lastDividendMaxnumber

Último rendimento: valor máximo, inclusive. Unidade: reais.

lastDividendYieldMinnumber

Yield do último rendimento: valor mínimo, inclusive. Unidade: fração (0.06 = 6%).

lastDividendYieldMaxnumber

Yield do último rendimento: valor máximo, inclusive. Unidade: fração (0.06 = 6%).

incomeMonths12mMinnumber

Meses com rendimento: valor mínimo, inclusive. Unidade: quantidade.

incomeMonths12mMaxnumber

Meses com rendimento: valor máximo, inclusive. Unidade: quantidade.

navPerShareMinnumber

Valor patrimonial/cota: valor mínimo, inclusive. Unidade: reais.

navPerShareMaxnumber

Valor patrimonial/cota: valor máximo, inclusive. Unidade: reais.

priceToNavMinnumber

P/VP: valor mínimo, inclusive. Unidade: múltiplo.

priceToNavMaxnumber

P/VP: valor máximo, inclusive. Unidade: múltiplo.

equityMinnumber

Patrimônio líquido: valor mínimo, inclusive. Unidade: reais.

equityMaxnumber

Patrimônio líquido: valor máximo, inclusive. Unidade: reais.

totalInvestorsMinnumber

Cotistas: valor mínimo, inclusive. Unidade: quantidade.

totalInvestorsMaxnumber

Cotistas: valor máximo, inclusive. Unidade: quantidade.

priceChange12mMinnumber

Variação em 12 meses: valor mínimo, inclusive. Unidade: fração (0.06 = 6%).

priceChange12mMaxnumber

Variação em 12 meses: valor máximo, inclusive. Unidade: fração (0.06 = 6%).

totalFeePercentMinnumber

Taxa total: valor mínimo, inclusive. Unidade: porcentagem (2.81 = 2,81%).

totalFeePercentMaxnumber

Taxa total: valor máximo, inclusive. Unidade: porcentagem (2.81 = 2,81%).

Response

Fundos que passam nos filtros, com paginação.

requestedAtstring date-time required

Data e hora da requisição em ISO 8601.

tookinteger required

Tempo de processamento, em milissegundos.

Example response

{
  "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",
        "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
}

Changes