{ "openapi": "3.0.1", "info": { "title": "Americanas Scraper: Brazil Product Prices, Sellers & Offers API", "description": "Americanas scraper and API for Brazil e-commerce. Extract product prices, discounts, Pix offers, installments (parcelamento), EAN, SKU, marketplace sellers, stock, images and specs by search term, category or URL. Retail price monitoring in Brazil. Export JSON, CSV, Excel. No login.", "version": "0.1", "x-build-id": "qMl9LLlOpNDMqXiFr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~americanas-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-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/scrapers_lat~americanas-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-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/scrapers_lat~americanas-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-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", "properties": { "searchTerm": { "title": "Search Term", "type": "string", "description": "Full-text query to search the Americanas catalog (e.g. \"geladeira\", \"iphone\", \"tênis nike\"). Maps to the VTEX ft parameter. Leave empty to use a Category or Start URL instead." }, "categoryId": { "title": "Category", "type": "string", "description": "Restrict results to one Americanas category. Accepts a numeric VTEX category id (e.g. 322) or a category path (e.g. \"eletrodomesticos/geladeira\"). Combine with a Search Term to search within a category." }, "startUrl": { "title": "Start URL", "type": "string", "description": "Advanced. A full VTEX catalog search URL whose query string (ft, fq, O, etc.) is used as-is, e.g. https://www.americanas.com.br/api/catalog_system/pub/products/search?ft=notebook&O=OrderByPriceASC . When set, its parameters take precedence." }, "maxProducts": { "title": "Max Products", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of product offers to collect. Each SKU and seller is one record. Leave empty for no limit (paid plans). Free Apify plans are capped at 10 per run." }, "sortOrder": { "title": "Sort Order", "enum": [ "", "OrderByPriceASC", "OrderByPriceDESC", "OrderByTopSaleDESC", "OrderByReviewRateDESC", "OrderByNameASC", "OrderByNameDESC", "OrderByReleaseDateDESC", "OrderByBestDiscountDESC" ], "type": "string", "description": "Order in which the catalog returns products. Maps to the VTEX O parameter.", "default": "" }, "minPrice": { "title": "Minimum Price (BRL)", "minimum": 0, "type": "integer", "description": "Only return offers priced at or above this amount, in Brazilian reais. Applied server-side via the VTEX price facet. Optional." }, "maxPrice": { "title": "Maximum Price (BRL)", "minimum": 0, "type": "integer", "description": "Only return offers priced at or below this amount, in Brazilian reais. Applied server-side via the VTEX price facet. Optional." }, "brands": { "title": "Brands", "type": "array", "description": "Only keep offers whose brand matches one of these names (case-insensitive, partial match). Leave empty for all brands.", "items": { "type": "string" } }, "onlyAvailable": { "title": "Only In-Stock Offers", "type": "boolean", "description": "When enabled, only offers that are currently available (in stock) are returned. Optional.", "default": false }, "withDetails": { "title": "Full description + specifications (paid add-on)", "type": "boolean", "description": "On by default for paid plans. Adds the full product description and the complete specifications table to every record. Requires a paid Apify plan; billed per record only when detail content is present.", "default": true }, "withAiDescription": { "title": "AI description clean + translate (paid add-on)", "type": "boolean", "description": "Off by default. When on, produces a clean Portuguese description plus an English translation for each product. Requires a paid Apify plan. Billed only when produced.", "default": false }, "withAiAttributes": { "title": "AI attribute extraction (paid add-on)", "type": "boolean", "description": "Off by default. When on, extracts structured product attributes and English keyword tags. Requires a paid Apify plan. Billed only when produced.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Route requests through Apify Proxy. A Brazil-based residential proxy can help if you run into rate limits. Not required by 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 } } } } } } } } } }