# Brazil Business Directory Scraper (`nickslam/brazilyello-scraper`) Actor Scrapes business directory data from BrazilYello (brazilyello.com) including company information, reviews, products, and more - **URL**: https://apify.com/nickslam/brazilyello-scraper.md - **Developed by:** [Nick](https://apify.com/nickslam) (community) - **Categories:** Lead generation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.50 / 1,000 base results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Brazil Business Directory Scraper Scrapes business directory data from [BrazilYello](https://www.brazilyello.com), the Brazil business directory. Find companies by keyword search, category, or location and extract their contact details, descriptions, and more. --- ### What It Does The Actor browses BrazilYello and extracts company information into structured data. You can: - **Filter by category** - e.g. restaurants, consultants, estate-agents - **Search by keywords** - e.g. "Lawyers", "IT consulting", "Bakeries" - **Filter by location** - choose one or more Brazilian cities (São Paulo, Rio de Janeiro, Belo Horizonte, Curitiba, Campinas, Porto Alegre, Goiânia, etc.) - **Browse the full directory** - leave filters empty to scrape the entire directory Results are saved as a dataset you can download as JSON, CSV, or Excel. --- ### What You Can Configure #### Search & Filters | Option | Description | |--------|-------------| | **Categories** | Filter by business type (e.g. restaurants, consultants) | | **Search Keywords** | Search for specific companies or terms | | **Locations** | Limit to Brazil cities (see input schema list) | #### Scope & Limits | Option | Description | |--------|-------------| | **Max Results** | Maximum number of companies to scrape (default: 20) | | **Max Pages** | Maximum listing pages to crawl (default: 5) | | **Start Page** | Page number to start from (useful for resuming previous searches) | #### Data Options | Option | What It Adds | |--------|---------------| | **Include Contact & Details** | Business hours, year established, employees, contact person | | **Include Extended Company Information** | Website URL, description, Google Maps coordinates | | **Include Registration & Legal** | Registration number, VAT number | | **Include Metadata** | Listing type, verified status, years with platform, tags | | **Include Media & Content** | Photos, logo, products/services | | **Include Review Summary** | Average rating and review count | | **Include Individual Reviews** | Full review text, author, date (slower - requires extra pages) | #### Other | Option | Description | |--------|-------------| | **Enable Rate Limiting** | Add delays between requests (recommended: On) | --- ### What Data You Get Every company record includes the **core fields** (always included): - **Company Name** - **Company URL** - link to the profile on BrazilYello - **Phone Number** - **Address** - **Categories** - business types - **Location** - city/region Optional fields (enable in the input) add website, description, maps, hours, registration, media, reviews, and metadata. --- ### Output Format The Actor outputs a dataset. Each item is one company with the selected fields. Download as **JSON**, **CSV**, or **Excel** from the Apify run. --- ### Pricing (Pay per event) | Tier | Price per 1,000 results | When it applies | |------|--------------------------|-----------------| | **Base** | $0.50 | No extended fields, no search keywords, no individual reviews | | **Extended** | $1.00 | Any of: Extended Company Info, Contact & Details, Registration & Legal, Media & Content, Review Summary, Metadata | | **Premium** | $2.00 | Search keywords **or** Include Individual Reviews | --- ### Tips - **Rate limiting** - Keep enabled to reduce the chance of being blocked. - **Individual reviews** - Turn on only when needed; it makes the run slower. - **Start page** - Use this to resume if a run stops or times out. # Actor input Schema ## `categories` (type: `array`): Optional: Filter by business categories. Example: For category page like `https://www.brazilyello.com/category/Estate_agents` enter only `Estate_agents`. ## `searchKeywords` (type: `string`): Optional: Search for specific companies or keywords. Enables premium pricing. ## `locations` (type: `array`): Optional: Filter by Brazil cities/regions. If not provided, all cities will be scraped. ## `maxResults` (type: `integer`): Maximum number of companies to scrape ## `startPage` (type: `integer`): Page number to start scraping from. Useful for resuming previous searches. ## `maxPages` (type: `integer`): Maximum number of pages to scrape. Each page usually contains around 20 companies. ## `enableRateLimiting` (type: `boolean`): Enable rate limiting (2 seconds delay) or disable (0.5 seconds delay) ## `hybridStrategy` (type: `string`): `fast` = Cheerio + Impit HTTP (default). `browser` = Playwright (fallback). ## `includeContactDetails` (type: `boolean`): Include business hours, year established, employees, contact person ## `includeExtendedCompanyInfo` (type: `boolean`): Include website, description, and maps coordinates ## `includeRegistrationLegal` (type: `boolean`): Include registration number and VAT number ## `includeMetadata` (type: `boolean`): Include listing type, verified status, years with platform, tags ## `includeMediaContent` (type: `boolean`): Include photos, logo, products ## `includeReviewSummary` (type: `boolean`): Include review summary (rating and count) - Fast extraction ## `includeIndividualReviews` (type: `boolean`): Include individual reviews - Slower (requires additional pages). Enables premium pricing. ## `proxy` (type: `object`): Select proxies to be used by the crawler. Recommended: Use Apify Proxy with Residential proxies for better Cloudflare bypass. ## Actor input object example ```json { "categories": [ "restaurants", "consultants" ], "searchKeywords": "restaurant, IT services", "locations": [ "Sao_Paulo", "Rio_de_Janeiro" ], "maxResults": 20, "startPage": 1, "maxPages": 5, "enableRateLimiting": true, "hybridStrategy": "fast", "includeContactDetails": false, "includeExtendedCompanyInfo": false, "includeRegistrationLegal": false, "includeMetadata": false, "includeMediaContent": false, "includeReviewSummary": false, "includeIndividualReviews": false, "proxy": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } } ```` # Actor output Schema ## `companyData` (type: `string`): Dataset containing all scraped company information # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "categories": [ "restaurants" ], "locations": [ "Sao_Paulo" ], "proxy": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } }; // Run the Actor and wait for it to finish const run = await client.actor("nickslam/brazilyello-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "categories": ["restaurants"], "locations": ["Sao_Paulo"], "proxy": { "useApifyProxy": True, "apifyProxyGroups": ["RESIDENTIAL"], "apifyProxyCountry": "BR", }, } # Run the Actor and wait for it to finish run = client.actor("nickslam/brazilyello-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "categories": [ "restaurants" ], "locations": [ "Sao_Paulo" ], "proxy": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } }' | apify call nickslam/brazilyello-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=nickslam/brazilyello-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Brazil Business Directory Scraper", "description": "Scrapes business directory data from BrazilYello (brazilyello.com) including company information, reviews, products, and more", "version": "1.0", "x-build-id": "MCV1lOYS4QbK53skU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nickslam~brazilyello-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nickslam-brazilyello-scraper", "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/nickslam~brazilyello-scraper/runs": { "post": { "operationId": "runs-sync-nickslam-brazilyello-scraper", "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/nickslam~brazilyello-scraper/run-sync": { "post": { "operationId": "run-sync-nickslam-brazilyello-scraper", "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": { "categories": { "title": "Categories", "type": "array", "description": "Optional: Filter by business categories.\n\nExample: For category page like `https://www.brazilyello.com/category/Estate_agents` enter only `Estate_agents`.", "items": { "type": "string" } }, "searchKeywords": { "title": "Search Keywords ($$)", "type": "string", "description": "Optional: Search for specific companies or keywords. Enables premium pricing." }, "locations": { "title": "Locations", "type": "array", "description": "Optional: Filter by Brazil cities/regions. If not provided, all cities will be scraped.", "items": { "type": "string", "enum": [ "Ananindeua", "Anapolis", "Aparecida_de_Goiania", "Aracaju", "Barueri", "Bauru", "Belem", "Belford_Roxo", "Belo_Horizonte", "Betim", "Blumenau", "Boa_Vista", "Brasilia", "Camacari", "Campina_Grande", "Campinas", "Campo_Grande", "Canoas", "Carapicuiba", "Cariacica", "Caruaru", "Cascavel", "Caucaia", "Caxias_do_Sul", "Colombo", "Contagem", "Cuiaba", "Curitiba", "Diadema", "Duque_de_Caxias", "Embu", "Feira_de_Santana", "Florianopolis", "Fortaleza", "Foz_do_Iguacu", "Franca", "Goiania", "Governador_Valadares", "Gravatai", "Guaruja", "Guarulhos", "Imperatriz", "Ipatinga", "Itaborai", "Itaquaquecetuba", "Jaboatao_dos_Guararapes", "Joao_Pessoa", "Joinville", "Juazeiro", "Juazeiro_do_Norte", "Juiz_de_Fora", "Jundiai", "Limeira", "Londrina", "Macapa", "Maceio", "Mage", "Manaus", "Marilia", "Maringa", "Maua", "Mogi_das_Cruzes", "Montes_Claros", "Mossoro", "Natal", "Niteroi", "Nova_Iguacu", "Novo_Hamburgo", "Olinda", "Osasco", "Paulista", "Pelotas", "Petrolina", "Petropolis", "Piracicaba", "Ponta_Grossa", "Porto_Alegre", "Porto_Velho", "Praia_Grande", "Recife", "Ribeirao_das_Neves", "Ribeirao_Preto", "Rio_Branco", "Rio_de_Janeiro", "Salvador", "Santa_Luzia", "Santa_Maria", "Santarem", "Santo_Andre", "Santos", "Sao_Bernardo_do_Campo", "Sao_Goncalo", "Sao_Joao_de_Meriti", "Sao_Jose_do_Rio_Preto", "Sao_Jose_dos_Campos", "Sao_Jose_dos_Pinhais", "Sao_Luis", "Sao_Paulo", "Sao_Vicente", "Serra", "Sorocaba", "Sumare", "Suzano", "Taboao_da_Serra", "Taubate", "Teresina", "Uberaba", "Uberlandia", "Varzea_Grande", "Viamao", "Vila_Velha", "Vitoria", "Vitoria_da_Conquista", "Volta_Redonda" ], "enumTitles": [ "Ananindeua", "Anápolis", "Aparecida de Goiânia", "Aracaju", "Barueri", "Bauru", "Belém", "Belford Roxo", "Belo Horizonte", "Betim", "Blumenau", "Boa Vista", "Brasília", "Camaçari", "Campina Grande", "Campinas", "Campo Grande", "Canoas", "Carapicuíba", "Cariacica", "Caruaru", "Cascavel", "Caucaia", "Caxias do Sul", "Colombo", "Contagem", "Cuiabá", "Curitiba", "Diadema", "Duque de Caxias", "Embu", "Feira de Santana", "Florianópolis", "Fortaleza", "Foz do Iguaçu", "Franca", "Goiânia", "Governador Valadares", "Gravataí", "Guarujá", "Guarulhos", "Imperatriz", "Ipatinga", "Itaboraí", "Itaquaquecetuba", "Jaboatão dos Guararapes", "João Pessoa", "Joinville", "Juazeiro", "Juazeiro do Norte", "Juiz de Fora", "Jundiaí", "Limeira", "Londrina", "Macapá", "Maceió", "Magé", "Manaus", "Marília", "Maringá", "Mauá", "Mogi das Cruzes", "Montes Claros", "Mossoró", "Natal", "Niterói", "Nova Iguaçu", "Novo Hamburgo", "Olinda", "Osasco", "Paulista", "Pelotas", "Petrolina", "Petrópolis", "Piracicaba", "Ponta Grossa", "Porto Alegre", "Porto Velho", "Praia Grande", "Recife", "Ribeirão das Neves", "Ribeirão Preto", "Rio Branco", "Rio de Janeiro", "Salvador", "Santa Luzia", "Santa Maria", "Santarém", "Santo André", "Santos", "São Bernardo do Campo", "São Gonçalo", "São João de Meriti", "São José do Rio Preto", "São José dos Campos", "São José dos Pinhais", "São Luís", "São Paulo", "São Vicente", "Serra", "Sorocaba", "Sumaré", "Suzano", "Taboão da Serra", "Taubaté", "Teresina", "Uberaba", "Uberlândia", "Várzea Grande", "Viamão", "Vila Velha", "Vitória", "Vitória da Conquista", "Volta Redonda" ] } }, "maxResults": { "title": "Max Results", "minimum": 1, "type": "integer", "description": "Maximum number of companies to scrape", "default": 20 }, "startPage": { "title": "Start Page", "minimum": 1, "type": "integer", "description": "Page number to start scraping from. Useful for resuming previous searches.", "default": 1 }, "maxPages": { "title": "Max Pages", "minimum": 1, "type": "integer", "description": "Maximum number of pages to scrape. Each page usually contains around 20 companies.", "default": 5 }, "enableRateLimiting": { "title": "Enable Rate Limiting", "type": "boolean", "description": "Enable rate limiting (2 seconds delay) or disable (0.5 seconds delay)", "default": true }, "hybridStrategy": { "title": "Strategy", "type": "string", "description": "`fast` = Cheerio + Impit HTTP (default). `browser` = Playwright (fallback).", "default": "fast" }, "includeContactDetails": { "title": "Include Contact & Details ($)", "type": "boolean", "description": "Include business hours, year established, employees, contact person", "default": false }, "includeExtendedCompanyInfo": { "title": "Include Extended Company Information ($)", "type": "boolean", "description": "Include website, description, and maps coordinates", "default": false }, "includeRegistrationLegal": { "title": "Include Registration & Legal ($)", "type": "boolean", "description": "Include registration number and VAT number", "default": false }, "includeMetadata": { "title": "Include Metadata ($)", "type": "boolean", "description": "Include listing type, verified status, years with platform, tags", "default": false }, "includeMediaContent": { "title": "Include Media & Product Information ($)", "type": "boolean", "description": "Include photos, logo, products", "default": false }, "includeReviewSummary": { "title": "Include Review Summary ($)", "type": "boolean", "description": "Include review summary (rating and count) - Fast extraction", "default": false }, "includeIndividualReviews": { "title": "Include Individual Reviews ($$)", "type": "boolean", "description": "Include individual reviews - Slower (requires additional pages). Enables premium pricing.", "default": false }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Select proxies to be used by the crawler. Recommended: Use Apify Proxy with Residential proxies for better Cloudflare bypass." } } }, "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 } } } } } } } } } } ```