# Americanas Product Scraper (`geodetic_marigold/americanas-scraper`) Actor

Monitor de preços e catálogo da Americanas. Busca por palavra-chave e devolve produtos estruturados (preço, desconto, estoque, marca, categoria, EAN, imagem) prontos para planilha, BI ou IA.

- **URL**: https://apify.com/geodetic\_marigold/americanas-scraper.md
- **Developed by:** [Antonio Fernando Rincon de Mendonça](https://apify.com/geodetic_marigold) (community)
- **Categories:** E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$10.00 / 1,000 produto extraídos

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.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.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/platform/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

## Americanas Product Scraper

Monitore preços e o catálogo da **Americanas** (americanas.com.br) em escala. Busque por palavra-chave e receba produtos estruturados — **preço, preço original, desconto, estoque, marca, categoria, EAN e imagem** — prontos para planilha, BI, monitoramento de concorrência ou pipelines de IA.

> 💸 **Pague só pelo resultado.** A cobrança é por produto retornado. Runs que não acham nada custam **zero**.

### O que ele faz

Dada uma palavra-chave (ex.: `notebook`), o Actor consulta a API pública de catálogo da Americanas e devolve cada produto encontrado, paginando até o limite que você definir.

### Casos de uso

- **Monitoramento de preço** — acompanhe o preço e o desconto de produtos ao longo do tempo.
- **Pesquisa de concorrência** — compare seu catálogo/preços com a maior loja do Brasil.
- **Pesquisa de mercado** — levante faixa de preço, marcas e disponibilidade de uma categoria.
- **Dropshipping / sourcing** — encontre produtos, preços e disponibilidade por busca.
- **Alimentar IA/BI** — dados limpos e tipados para dashboards e modelos.

### Input

| Campo | Tipo | Obrigatório | Descrição |
|-------|------|:-----------:|-----------|
| `searchQuery` | string | ✅ | O que procurar. Ex.: `"notebook"`, `"geladeira frost free"`, `"tênis nike"`. |
| `maxItems` | integer | — | Máximo de produtos a coletar (padrão `100`, máx `3000`). |
| `sort` | string | — | Ordenação: relevância (padrão), menor/maior preço, mais vendidos, maior desconto, lançamentos. |

#### Exemplo

```json
{
  "searchQuery": "notebook",
  "maxItems": 50,
  "sort": "OrderByBestDiscountDESC"
}
````

### Output

Cada item no dataset:

```json
{
  "productId": "13180493",
  "name": "Notebook Acer Aspire 5 ...",
  "brand": "Acer",
  "category": "Notebook",
  "categoryPath": "/Informática/Notebook/",
  "url": "https://www.americanas.com.br/produto/13180493/p",
  "price": 2499.0,
  "listPrice": 3299.0,
  "currency": "BRL",
  "discountPercent": 24,
  "available": true,
  "availableQuantity": 100,
  "sellerName": "Americanas",
  "sku": "13180493",
  "ean": "7891234567890",
  "image": "https://americanas.vteximg.com.br/arquivos/ids/.../img.jpg",
  "searchQuery": "notebook",
  "scrapedAt": "2026-06-24T13:00:00.000Z"
}
```

### Como funciona

O Actor consome a **API pública de catálogo da plataforma VTEX** (que a Americanas usa). Não usa navegador nem renderização — só requisições HTTP que retornam JSON estruturado. Isso o torna rápido, estável e barato de rodar.

### Observações

- Coleta **apenas dados públicos de produtos** (catálogo da loja). Não coleta dados pessoais.
- Respeite os Termos de Uso da Americanas e use os dados de forma responsável.
- A disponibilidade e os preços refletem o momento da coleta.

# Actor input Schema

## `searchQuery` (type: `string`):

O que procurar na Americanas. Ex.: "notebook", "geladeira frost free", "tênis nike".

## `maxItems` (type: `integer`):

Limite superior de produtos a coletar. Valores altos aumentam o tempo do run.

## `sort` (type: `string`):

Como ordenar os resultados. Em branco = relevância padrão da loja.

## Actor input object example

```json
{
  "searchQuery": "notebook",
  "maxItems": 100,
  "sort": ""
}
```

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "searchQuery": "notebook"
};

// Run the Actor and wait for it to finish
const run = await client.actor("geodetic_marigold/americanas-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "searchQuery": "notebook" }

# Run the Actor and wait for it to finish
run = client.actor("geodetic_marigold/americanas-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 '{
  "searchQuery": "notebook"
}' |
apify call geodetic_marigold/americanas-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=geodetic_marigold/americanas-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Americanas Product Scraper",
        "description": "Monitor de preços e catálogo da Americanas. Busca por palavra-chave e devolve produtos estruturados (preço, desconto, estoque, marca, categoria, EAN, imagem) prontos para planilha, BI ou IA.",
        "version": "0.1",
        "x-build-id": "KhE63K8eVZHAJzVS2"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/geodetic_marigold~americanas-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-geodetic_marigold-americanas-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/geodetic_marigold~americanas-scraper/runs": {
            "post": {
                "operationId": "runs-sync-geodetic_marigold-americanas-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/geodetic_marigold~americanas-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-geodetic_marigold-americanas-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",
                "required": [
                    "searchQuery"
                ],
                "properties": {
                    "searchQuery": {
                        "title": "Palavra-chave de busca",
                        "minLength": 2,
                        "maxLength": 200,
                        "type": "string",
                        "description": "O que procurar na Americanas. Ex.: \"notebook\", \"geladeira frost free\", \"tênis nike\"."
                    },
                    "maxItems": {
                        "title": "Máximo de produtos",
                        "minimum": 1,
                        "maximum": 3000,
                        "type": "integer",
                        "description": "Limite superior de produtos a coletar. Valores altos aumentam o tempo do run.",
                        "default": 100
                    },
                    "sort": {
                        "title": "Ordenação",
                        "enum": [
                            "",
                            "OrderByPriceASC",
                            "OrderByPriceDESC",
                            "OrderByTopSaleDESC",
                            "OrderByBestDiscountDESC",
                            "OrderByReleaseDateDESC"
                        ],
                        "type": "string",
                        "description": "Como ordenar os resultados. Em branco = relevância padrão da loja.",
                        "default": ""
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
