Ações

Filtrar ações por indicadores

Changed on

Filtra 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&dividendYieldMin=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.

IndicadorChaveUnidadePlano
PreçolastPricereaisStartup e Pro
Variação no diachangePercentporcentagem (2.81 = 2,81%)Startup e Pro
VolumevolumeaçõesStartup e Pro
Valor de mercadomarketCapreaisStartup e Pro
P/LtrailingPEmúltiploStartup e Pro
P/VPpriceToBookmúltiploStartup e Pro
EV/EBITDAenterpriseToEbitdamúltiploStartup e Pro
EV/ReceitaenterpriseToRevenuemúltiploStartup e Pro
PEGpegRatiomúltiploStartup e Pro
LPAearningsPerSharereaisStartup e Pro
VPAbookValuePerSharereaisStartup e Pro
Margem líquidanetMarginfração (0.06 = 6%)Startup e Pro
Valor da firmaenterpriseValuereaisStartup e Pro
Variação 52 semanasfiftyTwoWeekChangefração (0.06 = 6%)Startup e Pro
Dividend yielddividendYieldfração (0.06 = 6%)Startup e Pro
ROEreturnOnEquityfração (0.06 = 6%)Pro
ROAreturnOnAssetsfração (0.06 = 6%)Pro
Margem brutagrossMarginfração (0.06 = 6%)Pro
Margem EBITDAebitdaMarginfração (0.06 = 6%)Pro
Margem operacionaloperatingMarginfração (0.06 = 6%)Pro
Dívida/PLdebtToEquitymúltiploPro
Dívida líquida/EBITDAnetDebtToEbitdamúltiploPro
Liquidez correntecurrentRatiomúltiploPro
Liquidez secaquickRatiomúltiploPro
Crescimento da receitarevenueGrowthfração (0.06 = 6%)Pro
Crescimento do lucroearningsGrowthfração (0.06 = 6%)Pro
Crescimento anual da receitarevenueGrowthAnnualfração (0.06 = 6%)Pro
Crescimento anual do lucroearningsGrowthAnnualfração (0.06 = 6%)Pro
ReceitatotalRevenuereaisPro
EBITDAebitdareaisPro
Fluxo de caixa livrefreeCashflowreaisPro
Dívida brutatotalDebtreaisPro
CaixatotalCashreaisPro
get/api/v2/stocks/screener

Request

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

Query parameters

searchstring

Parte do ticker, do nome da empresa ou de um ticker antigo.

Example:BANCO
type'stock' | 'fund' | 'bdr'

Tipo do ativo. Padrão: stock.

Example:stock
subType'stock' | 'unit' | 'fii' | 'etf' | 'fi-infra' | 'fi-agro' | 'fip' | 'fidc' | 'bdr'

Subtipo do ativo: stock, unit, fii, etf, fi-infra, fi-agro, fip, fidc ou bdr.

Example:unit
sectorstring

Setor. Aceita parte do nome.

Example:Finance
subsectorstring

Subsetor. Nome exato.

Example:Energia Elétrica
sortBy'symbol' | 'name' | 'lastPrice' | 'changePercent' | 'volume' | 'marketCap' | 'trailingPE' | 'priceToBook' | 'enterpriseToEbitda' | 'enterpriseToRevenue' | 'pegRatio' | 'earningsPerShare' | 'bookValuePerShare' | 'netMargin' | 'enterpriseValue' | 'fiftyTwoWeekChange' | 'dividendYield' | 'returnOnEquity' | 'returnOnAssets' | 'grossMargin' | 'ebitdaMargin' | 'operatingMargin' | 'debtToEquity' | 'netDebtToEbitda' | 'currentRatio' | 'quickRatio' | 'revenueGrowth' | 'earningsGrowth' | 'revenueGrowthAnnual' | 'earningsGrowthAnnual' | 'totalRevenue' | 'ebitda' | 'freeCashflow' | 'totalDebt' | 'totalCash'

Campo de ordenação: uma chave de métrica, symbol ou name. 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. Plano Startup e Pro.

lastPriceMaxnumber

Preço: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.

changePercentMinnumber

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

changePercentMaxnumber

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

volumeMinnumber

Volume: valor mínimo, inclusive. Unidade: ações. Plano Startup e Pro.

volumeMaxnumber

Volume: valor máximo, inclusive. Unidade: ações. Plano Startup e Pro.

marketCapMinnumber

Valor de mercado: valor mínimo, inclusive. Unidade: reais. Plano Startup e Pro.

marketCapMaxnumber

Valor de mercado: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.

trailingPEMinnumber

P/L: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

trailingPEMaxnumber

P/L: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

priceToBookMinnumber

P/VP: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

priceToBookMaxnumber

P/VP: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

enterpriseToEbitdaMinnumber

EV/EBITDA: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

enterpriseToEbitdaMaxnumber

EV/EBITDA: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

enterpriseToRevenueMinnumber

EV/Receita: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

enterpriseToRevenueMaxnumber

EV/Receita: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

pegRatioMinnumber

PEG: valor mínimo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

pegRatioMaxnumber

PEG: valor máximo, inclusive. Unidade: múltiplo. Plano Startup e Pro.

earningsPerShareMinnumber

LPA: valor mínimo, inclusive. Unidade: reais. Plano Startup e Pro.

earningsPerShareMaxnumber

LPA: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.

bookValuePerShareMinnumber

VPA: valor mínimo, inclusive. Unidade: reais. Plano Startup e Pro.

bookValuePerShareMaxnumber

VPA: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.

netMarginMinnumber

Margem líquida: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.

netMarginMaxnumber

Margem líquida: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.

enterpriseValueMinnumber

Valor da firma: valor mínimo, inclusive. Unidade: reais. Plano Startup e Pro.

enterpriseValueMaxnumber

Valor da firma: valor máximo, inclusive. Unidade: reais. Plano Startup e Pro.

fiftyTwoWeekChangeMinnumber

Variação 52 semanas: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.

fiftyTwoWeekChangeMaxnumber

Variação 52 semanas: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Startup e Pro.

dividendYieldMinnumber

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

dividendYieldMaxnumber

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

returnOnEquityMinnumber

ROE: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

returnOnEquityMaxnumber

ROE: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

returnOnAssetsMinnumber

ROA: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

returnOnAssetsMaxnumber

ROA: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

grossMarginMinnumber

Margem bruta: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

grossMarginMaxnumber

Margem bruta: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

ebitdaMarginMinnumber

Margem EBITDA: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

ebitdaMarginMaxnumber

Margem EBITDA: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

operatingMarginMinnumber

Margem operacional: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

operatingMarginMaxnumber

Margem operacional: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

debtToEquityMinnumber

Dívida/PL: valor mínimo, inclusive. Unidade: múltiplo. Plano Pro.

debtToEquityMaxnumber

Dívida/PL: valor máximo, inclusive. Unidade: múltiplo. Plano Pro.

netDebtToEbitdaMinnumber

Dívida líquida/EBITDA: valor mínimo, inclusive. Unidade: múltiplo. Plano Pro.

netDebtToEbitdaMaxnumber

Dívida líquida/EBITDA: valor máximo, inclusive. Unidade: múltiplo. Plano Pro.

currentRatioMinnumber

Liquidez corrente: valor mínimo, inclusive. Unidade: múltiplo. Plano Pro.

currentRatioMaxnumber

Liquidez corrente: valor máximo, inclusive. Unidade: múltiplo. Plano Pro.

quickRatioMinnumber

Liquidez seca: valor mínimo, inclusive. Unidade: múltiplo. Plano Pro.

quickRatioMaxnumber

Liquidez seca: valor máximo, inclusive. Unidade: múltiplo. Plano Pro.

revenueGrowthMinnumber

Crescimento da receita: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

revenueGrowthMaxnumber

Crescimento da receita: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

earningsGrowthMinnumber

Crescimento do lucro: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

earningsGrowthMaxnumber

Crescimento do lucro: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

revenueGrowthAnnualMinnumber

Crescimento anual da receita: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

revenueGrowthAnnualMaxnumber

Crescimento anual da receita: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

earningsGrowthAnnualMinnumber

Crescimento anual do lucro: valor mínimo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

earningsGrowthAnnualMaxnumber

Crescimento anual do lucro: valor máximo, inclusive. Unidade: fração (0.06 = 6%). Plano Pro.

totalRevenueMinnumber

Receita: valor mínimo, inclusive. Unidade: reais. Plano Pro.

totalRevenueMaxnumber

Receita: valor máximo, inclusive. Unidade: reais. Plano Pro.

ebitdaMinnumber

EBITDA: valor mínimo, inclusive. Unidade: reais. Plano Pro.

ebitdaMaxnumber

EBITDA: valor máximo, inclusive. Unidade: reais. Plano Pro.

freeCashflowMinnumber

Fluxo de caixa livre: valor mínimo, inclusive. Unidade: reais. Plano Pro.

freeCashflowMaxnumber

Fluxo de caixa livre: valor máximo, inclusive. Unidade: reais. Plano Pro.

totalDebtMinnumber

Dívida bruta: valor mínimo, inclusive. Unidade: reais. Plano Pro.

totalDebtMaxnumber

Dívida bruta: valor máximo, inclusive. Unidade: reais. Plano Pro.

totalCashMinnumber

Caixa: valor mínimo, inclusive. Unidade: reais. Plano Pro.

totalCashMaxnumber

Caixa: valor máximo, inclusive. Unidade: reais. Plano Pro.

Response

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