{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper API - Walmart, Target, Best Buy Prices", "description": "Amazon, Walmart, Target, Best Buy and Home Depot product data from ASINs, product ids or search keywords: title, price, list price, brand, availability, rating, review count, image and URL, one row per product or search result. Uses your own Nimble API key.", "version": "0.1", "x-build-id": "gmO1mQ5XDhGdph1FJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~amazon-walmart-product-price-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-amazon-walmart-product-price-scraper-api", "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/nabeelbaghoor~amazon-walmart-product-price-scraper-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-amazon-walmart-product-price-scraper-api", "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/nabeelbaghoor~amazon-walmart-product-price-scraper-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-amazon-walmart-product-price-scraper-api", "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": { "mode": { "title": "What to read", "enum": [ "products", "catalog" ], "type": "string", "description": "Template run reads product pages or search results for each input line, using the template picked below. Template catalog lists the extraction templates your account can run, with their target site and page type, and needs no inputs.", "default": "products" }, "template": { "title": "Template", "enum": [ "amazon_pdp", "amazon_serp", "amazon_category", "walmart_pdp", "walmart_search", "target_pdp", "best_buy_pdp", "home_depot_pdp" ], "type": "string", "description": "The pre-built extraction template to run. Product page templates return one product per input; search and category templates return every product on the results page.", "default": "amazon_pdp" }, "templateName": { "title": "Other template name", "type": "string", "description": "Optional. Run any other template by its name instead of the one picked above, such as a template of your own account. Use the template catalog mode to see the names available to you." }, "inputs": { "title": "Inputs", "type": "array", "description": "One input per line. A plain value fills the template's one required parameter: an ASIN such as B08N5WRWNW for Amazon product pages, a keyword such as wireless headphones for Amazon or Walmart search. For templates that take more than one parameter, give a JSON object per line, such as {\"asin\": \"B0DLKFK6LR\", \"zip_code\": \"10001\"}. Each line is checked against the parameters the template documents before it is sent.", "items": { "type": "string" } }, "zipCode": { "title": "ZIP code", "type": "string", "description": "Optional US ZIP code, such as 10001 or 90210, for location-specific price and availability. Sent with localization switched on, and only to templates that support localization." }, "country": { "title": "Country", "type": "string", "description": "Optional two-letter ISO 3166-1 code, such as US, GB or DE, for the country the site is read from. Leave blank to let the provider choose." }, "locale": { "title": "Locale", "type": "string", "description": "Optional language preference for the results, such as en or en-US. Leave blank to let the provider choose." }, "maxPagesPerInput": { "title": "Pages per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "Search and category templates only. Read this many result pages per keyword, starting from the first. Paging stops early at an empty page or at a page that repeats earlier results. Product page templates always read one page.", "default": 1 }, "catalogSearch": { "title": "Catalog search", "type": "string", "description": "Template catalog only. Filter templates by keyword, such as amazon or walmart." }, "catalogPrivacy": { "title": "Catalog privacy", "enum": [ "public", "private", "all" ], "type": "string", "description": "Template catalog only. Public templates are maintained by the provider or its community; private templates are your own account's.", "default": "public" }, "catalogVertical": { "title": "Catalog vertical", "enum": [ "Ecommerce", "any" ], "type": "string", "description": "Template catalog only. Keep only ecommerce templates, or list every vertical, such as search engines and social media.", "default": "Ecommerce" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many rows. One search page can return dozens of products, so this is what bounds a run over many keywords and pages.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 600, "type": "integer", "description": "Pacing ceiling for calls to the provider. Its default limit is far higher; rate limited calls are retried with a pause rather than dropped.", "default": 60 }, "apiKey": { "title": "Nimble API key", "type": "string", "description": "Your own Nimble API key, from the API keys page of your account settings. This actor is bring-your-own-key and never ships a key of its own. Leave blank to use the DATA_API_KEY environment secret instead." }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Override the host the actor calls. Only useful for testing against a different environment." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }