{ "openapi": "3.0.1", "info": { "title": "🇧🇷 B3 Brasil Stock Screener — Bovespa Quotes & Fundamentals", "description": "B3 / Bovespa Brazilian stock screener API — Ibovespa live quotes, market cap (BRL), P/E, P/B, dividend yield, ROE, sector. Petrobras, Vale, Itaú, Ambev universe. Bloomberg Terminal / FactSet / Refinitiv Eikon LATAM equity-data alternative for hedge funds & quants. Pay-per-result.", "version": "0.0", "x-build-id": "rGa63t5eW6mWCVZNu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~b3-brasil-stock-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-b3-brasil-stock-screener", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nexgendata~b3-brasil-stock-screener/runs": { "post": { "operationId": "runs-sync-nexgendata-b3-brasil-stock-screener", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nexgendata~b3-brasil-stock-screener/run-sync": { "post": { "operationId": "run-sync-nexgendata-b3-brasil-stock-screener", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "limit": { "title": "Limit", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of B3 (Brasil, Bolsa, Balcão / Bovespa) listed stocks to return. The Brazilian exchange has roughly 400-450 listed common stocks plus preferred shares (PETR4, VALE3, ITUB4, BBDC4, etc.). Use 10 for a smoke test, 100 for the most-liquid Ibovespa universe, or 500 to pull every listed paper. Records are returned sorted by 2-month liquidity (Liq.2meses) descending — a good proxy for tradeable mid-large caps.", "default": 100 }, "min_market_cap_brl": { "title": "Min market cap / patrimônio líquido (BRL)", "minimum": 0, "maximum": 10000000000000, "type": "integer", "description": "Filter to stocks with patrimônio líquido (book equity, in BRL) at or above this threshold. Used as a market-cap proxy from Fundamentus. Examples: 1000000000 = 1bn BRL (mid-cap floor), 10000000000 = 10bn BRL (large-cap, Ibovespa-heavy). Leave at 0 for no filter.", "default": 0 }, "min_liquidity_2m_brl": { "title": "Min 2-month avg volume (BRL)", "minimum": 0, "maximum": 100000000000, "type": "integer", "description": "Filter to stocks with Liq.2meses (mean daily traded value over the last 2 months in BRL) at or above this threshold. Excellent for excluding illiquid micro-caps. Examples: 1000000 = 1M BRL/day (tradeable), 10000000 = 10M BRL/day (institutional-grade). Leave at 0 for no filter.", "default": 0 }, "max_pe_ratio": { "title": "Max P/L (P/E) ratio", "minimum": 0, "maximum": 1000, "type": "number", "description": "Filter to stocks with P/L (Preço/Lucro, P/E) at or below this value (value-investor screen). Examples: 8 = deep value typical of Brazilian banks/utilities, 15 = classic Graham value, 25 = GARP. Stocks with no reported earnings (P/L = 0 in Fundamentus) are excluded when this filter is set. Leave at 0 to disable.", "default": 0 }, "max_pvp_ratio": { "title": "Max P/VP (P/B) ratio", "minimum": 0, "maximum": 1000, "type": "number", "description": "Filter to stocks with P/VP (Preço/Valor Patrimonial, P/B) at or below this value. Brazilian banks often trade at 0.8-1.5 P/VP. Examples: 1 = trading below book, 2 = reasonable. Leave at 0 to disable.", "default": 0 }, "min_dividend_yield": { "title": "Min dividend yield (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Filter to stocks with trailing dividend yield at or above this value (in percent). Brazil is famous for its high-yield equity culture — utilities (TAEE11, ENBR3), banks (ITSA4, BBAS3), and oil (PETR4) routinely yield 8-15%. Examples: 5 = solid income, 10 = top-decile dividend payer. Leave at 0 for no filter.", "default": 0 }, "min_roe_pct": { "title": "Min ROE (%)", "minimum": 0, "maximum": 1000, "type": "number", "description": "Filter to stocks with Return on Equity at or above this value (in percent). Quality-investor screen. Examples: 15 = good quality, 20 = top-tier (Itaú, WEG, Localiza historically). Leave at 0 for no filter.", "default": 0 }, "sector": { "title": "Ticker / company name keyword", "type": "string", "description": "Optional case-insensitive substring filter applied to the ticker (Papel) and company name. Examples: 'PETR' (Petrobras family — PETR3/PETR4), 'BANCO' (banks), 'VALE', 'ITAU', 'ENERGIA', 'BBDC'. Leave blank for no filter. B3 ticker conventions: digit 3 = ON (ordinary/voting), digit 4 = PN (preferred), 5/6 = preferred classes, 11 = unit/BDR." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. Fundamentus.com.br is a public Brazilian server-rendered site and accepts datacenter proxies fine. Switch to RESIDENTIAL only if you hit rate limits.", "default": { "useApifyProxy": true } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }