{ "openapi": "3.0.1", "info": { "title": "Amazon Creator Shop Scraper", "description": "Scrape Amazon influencer/creator storefronts (/shop/{handle}): profile info, affiliate disclosure, curated Idea Lists with products and creator comments, and creator videos.", "version": "1.0", "x-build-id": "Eg56dNXLyUjwm1fDL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~amazon-creator-shop-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-amazon-creator-shop-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/crawlerbros~amazon-creator-shop-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-amazon-creator-shop-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/crawlerbros~amazon-creator-shop-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-amazon-creator-shop-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": [ "handles" ], "properties": { "handles": { "title": "Creator handles", "type": "array", "description": "Amazon influencer handles, e.g. `gearvlogz` (from amazon.com/shop/gearvlogz). Combined with `marketplaceDomain` to build the shop URL.", "default": [], "items": { "type": "string" } }, "shopUrls": { "title": "Shop URLs", "type": "array", "description": "Full creator storefront URLs, e.g. `https://www.amazon.com/shop/gearvlogz`. Use this for non-default marketplaces or when you already have the exact URL.", "default": [], "items": { "type": "string" } }, "marketplaceDomain": { "title": "Marketplace domain", "enum": [ "amazon.com", "amazon.ca", "amazon.com.mx", "amazon.com.br", "amazon.ie", "amazon.es", "amazon.co.uk", "amazon.fr", "amazon.com.be", "amazon.nl", "amazon.de", "amazon.it", "amazon.se", "amazon.co.za", "amazon.pl", "amazon.eg", "amazon.com.tr", "amazon.sa", "amazon.ae", "amazon.in", "amazon.sg", "amazon.com.au", "amazon.co.jp" ], "type": "string", "description": "Amazon domain to use when building shop URLs from `handles`.", "default": "amazon.com" }, "tabs": { "title": "Content to scrape", "enum": [ "all", "profile", "ideaLists", "videos" ], "type": "string", "description": "Which tab(s) of the storefront to extract.", "default": "all" }, "crawlIdeaLists": { "title": "Crawl Idea List items", "type": "boolean", "description": "When true, opens each Idea List (up to `maxLists`) and extracts individual products (up to `maxItemsPerList`). When false, only the list summary cards (title, declared item count, image) are emitted.", "default": true }, "maxLists": { "title": "Max Idea Lists per shop", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of Idea Lists to process per shop.", "default": 10 }, "maxItemsPerList": { "title": "Max items per Idea List", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of product items to extract per Idea List.", "default": 30 }, "maxVideos": { "title": "Max videos per shop", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of creator videos to extract per shop (tabs=all or videos).", "default": 20 }, "useResidentialProxy": { "title": "Force residential proxy", "type": "boolean", "description": "By default the actor uses the free AUTO (datacenter) proxy group with a homepage-priming retry, escalating to residential only after repeated blocks. Enable this to always use residential proxy from the start (higher reliability, uses paid proxy credit).", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. Defaults to the free AUTO (datacenter) group.", "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 } } } } } } } } } }