Filtrar ações por indicadores
Changed onFiltra e ordena ações da B3 por preço e indicadores fundamentalistas, como P/L, P/VP, dividend yield e ROE. Uma chamada percorre todas as ações.
Cada indicador aceita {chave}Min e {chave}Max. Os limites são inclusivos e usam a mesma unidade da resposta. Frações seguem /api/v2/stocks/statistics e /api/v2/stocks/financial-data: 6% é 0.06. Um filtro remove os ativos sem o dado. Na ordenação, os nulos ficam no fim.
Exemplos:
- P/L entre 0 e 8 e dividend yield de pelo menos 6%: ?trailingPEMin=0&trailingPEMax=8÷ndYieldMin=0.06&sortBy=dividendYield
- ROE de pelo menos 15%, do maior para o menor: ?returnOnEquityMin=0.15&sortBy=returnOnEquity
Empresas com prejuízo têm P/L negativo. Para excluí-las, envie trailingPEMin=0 junto com trailingPEMax.
quote e dividendYield usam o último preço. P/L, P/VP e os outros indicadores usam o preço da atualização diária dos fundamentos. Em units, P/L e P/VP usam o último preço da unit. dividendYield soma os proventos em dinheiro dos últimos 12 meses.
Planos Startup e Pro. Os indicadores do plano Pro não vêm em metrics no plano Startup. Um filtro ou uma ordenação com esses indicadores no plano Startup retorna 403.
| Indicador | Chave | Unidade | Plano |
|---|---|---|---|
| Preço | lastPrice | reais | Startup e Pro |
| Variação no dia | changePercent | porcentagem (2.81 = 2,81%) | Startup e Pro |
| Volume | volume | ações | Startup e Pro |
| Valor de mercado | marketCap | reais | Startup e Pro |
| P/L | trailingPE | múltiplo | Startup e Pro |
| P/VP | priceToBook | múltiplo | Startup e Pro |
| EV/EBITDA | enterpriseToEbitda | múltiplo | Startup e Pro |
| EV/Receita | enterpriseToRevenue | múltiplo | Startup e Pro |
| PEG | pegRatio | múltiplo | Startup e Pro |
| LPA | earningsPerShare | reais | Startup e Pro |
| VPA | bookValuePerShare | reais | Startup e Pro |
| Margem líquida | netMargin | fração (0.06 = 6%) | Startup e Pro |
| Valor da firma | enterpriseValue | reais | Startup e Pro |
| Variação 52 semanas | fiftyTwoWeekChange | fração (0.06 = 6%) | Startup e Pro |
| Dividend yield | dividendYield | fração (0.06 = 6%) | Startup e Pro |
| ROE | returnOnEquity | fração (0.06 = 6%) | Pro |
| ROA | returnOnAssets | fração (0.06 = 6%) | Pro |
| Margem bruta | grossMargin | fração (0.06 = 6%) | Pro |
| Margem EBITDA | ebitdaMargin | fração (0.06 = 6%) | Pro |
| Margem operacional | operatingMargin | fração (0.06 = 6%) | Pro |
| Dívida/PL | debtToEquity | múltiplo | Pro |
| Dívida líquida/EBITDA | netDebtToEbitda | múltiplo | Pro |
| Liquidez corrente | currentRatio | múltiplo | Pro |
| Liquidez seca | quickRatio | múltiplo | Pro |
| Crescimento da receita | revenueGrowth | fração (0.06 = 6%) | Pro |
| Crescimento do lucro | earningsGrowth | fração (0.06 = 6%) | Pro |
| Crescimento anual da receita | revenueGrowthAnnual | fração (0.06 = 6%) | Pro |
| Crescimento anual do lucro | earningsGrowthAnnual | fração (0.06 = 6%) | Pro |
| Receita | totalRevenue | reais | Pro |
| EBITDA | ebitda | reais | Pro |
| Fluxo de caixa livre | freeCashflow | reais | Pro |
| Dívida bruta | totalDebt | reais | Pro |
| Caixa | totalCash | reais | Pro |
Request
- Base URLhttps://brapi.dev
- URLhttps://brapi.dev/api/v2/stocks/screener
- AuthHTTP bearer
Query parameters
Parte do ticker, do nome da empresa ou de um ticker antigo.
Tipo do ativo. Padrão: stock.
Subtipo do ativo: stock, unit, fii, etf, fi-infra, fi-agro, fip, fidc ou bdr.
Setor. Aceita parte do nome.
Subsetor. Nome exato.
Campo de ordenação: uma chave de métrica, symbol ou name. Valores nulos ficam no fim.
Ordem. Padrão: desc.
Número da página. Começa em 1.
Itens por página. Máximo: 200.
Preço: valor mínimo, inclusive. Unidade: reais. Plano Startup e Pro.
Preço: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.
Variação no dia: valor mínimo, inclusive. Unidade: porcentagem (2.81 = 2,81%). Plano Startup e Pro.
Variação no dia: valor máximo, inclusive. Unidade: porcentagem (2.81 = 2,81%). Plano Startup e Pro.
Volume: valor mínimo, inclusive. Unidade: ações. Plano Startup e Pro.
Volume: valor máximo, inclusive. Unidade: ações. Plano Startup e Pro.
Valor de mercado: valor mínimo, inclusive. Unidade: reais. Plano Startup e Pro.
Valor de mercado: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.
P/L: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
P/L: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
P/VP: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
P/VP: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
EV/EBITDA: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
EV/EBITDA: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
EV/Receita: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
EV/Receita: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
PEG: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
PEG: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.
LPA: valor mínimo, inclusive. Unidade: reais. Plano Startup e Pro.
LPA: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.
VPA: valor mínimo, inclusive. Unidade: reais. Plano Startup e Pro.
VPA: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.
Margem líquida: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.
Margem líquida: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.
Valor da firma: valor mínimo, inclusive. Unidade: reais. Plano Startup e Pro.
Valor da firma: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.
Variação 52 semanas: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.
Variação 52 semanas: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.
Dividend yield: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.
Dividend yield: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.
ROE: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
ROE: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
ROA: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
ROA: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Margem bruta: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Margem bruta: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Margem EBITDA: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Margem EBITDA: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Margem operacional: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Margem operacional: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Dívida/PL: valor mínimo, inclusive. Unidade: múltiplo. Plano Pro.
Dívida/PL: valor máximo, inclusive. Unidade: múltiplo. Plano Pro.
Dívida líquida/EBITDA: valor mínimo, inclusive. Unidade: múltiplo. Plano Pro.
Dívida líquida/EBITDA: valor máximo, inclusive. Unidade: múltiplo. Plano Pro.
Liquidez corrente: valor mínimo, inclusive. Unidade: múltiplo. Plano Pro.
Liquidez corrente: valor máximo, inclusive. Unidade: múltiplo. Plano Pro.
Liquidez seca: valor mínimo, inclusive. Unidade: múltiplo. Plano Pro.
Liquidez seca: valor máximo, inclusive. Unidade: múltiplo. Plano Pro.
Crescimento da receita: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Crescimento da receita: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Crescimento do lucro: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Crescimento do lucro: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Crescimento anual da receita: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Crescimento anual da receita: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Crescimento anual do lucro: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Crescimento anual do lucro: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.
Receita: valor mínimo, inclusive. Unidade: reais. Plano Pro.
Receita: valor máximo, inclusive. Unidade: reais. Plano Pro.
EBITDA: valor mínimo, inclusive. Unidade: reais. Plano Pro.
EBITDA: valor máximo, inclusive. Unidade: reais. Plano Pro.
Fluxo de caixa livre: valor mínimo, inclusive. Unidade: reais. Plano Pro.
Fluxo de caixa livre: valor máximo, inclusive. Unidade: reais. Plano Pro.
Dívida bruta: valor mínimo, inclusive. Unidade: reais. Plano Pro.
Dívida bruta: valor máximo, inclusive. Unidade: reais. Plano Pro.
Caixa: valor mínimo, inclusive. Unidade: reais. Plano Pro.
Caixa: valor máximo, inclusive. Unidade: reais. Plano Pro.
Response
Ativos que passam nos filtros, com paginação.
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
},
"metrics": {
"trailingPE": 5.22,
"priceToBook": 1.31,
"enterpriseToEbitda": 4.58,
"enterpriseToRevenue": 2.28,
"pegRatio": 0.07,
"earningsPerShare": 10.35,
"bookValuePerShare": 37.32,
"netMargin": 0.2439,
"enterpriseValue": 1250458100000,
"fiftyTwoWeekChange": 0.6539,
"dividendYield": 0.0712,
"returnOnEquity": 0.2773,
"returnOnAssets": 0.1046,
"grossMargin": 0.506,
"ebitdaMargin": 0.4983,
"operatingMargin": 0.3386,
"debtToEquity": 1.41,
"netDebtToEbitda": 2.28,
"currentRatio": 0.85,
"quickRatio": 0.58,
"revenueGrowth": 0.1123,
"earningsGrowth": 0.7238,
"revenueGrowthAnnual": 0.0137,
"earningsGrowthAnnual": 2.0085,
"totalRevenue": 548493000000,
"ebitda": 273323000000,
"freeCashflow": 105334000000,
"totalDebt": 676283000000,
"totalCash": 53764000000
},
"fundamentalsUpdatedAt": "2026-09-29T15:20:56.282Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"totalItems": 2302,
"totalPages": 116,
"hasNextPage": true
},
"requestedAt": "2025-01-24T17:32:38.000Z",
"took": 45
}Changes
- info
endpoint added
- info