{ "openapi": "3.0.1", "info": { "title": "Amazon Product Data API - Search, Prices, Offers, Bestsellers", "description": "Read Amazon product data from 24 marketplaces: keyword search results, product pages by ASIN, GTIN or URL, seller offers and the buy box, bestseller, category and deals listings, seller profiles and feedback, brand stores, charts, wishlists, autocomplete and ASIN to GTIN lookups. Bring your own key.", "version": "0.1", "x-build-id": "yY5Q6NJLeFOqnYAOw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~amazon-product-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-amazon-product-data-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-product-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-amazon-product-data-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-product-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-amazon-product-data-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": { "service": { "title": "What to read", "enum": [ "search", "product", "offers", "bestsellers", "category", "deals", "alsoBought", "shopByLook", "sellerProfile", "sellerFeedback", "sellerProducts", "reviewerProfile", "store", "charts", "wishlist", "authorPage", "stockEstimation", "autocomplete", "asinToGtin", "categories", "account" ], "type": "string", "description": "One service per run. Listing services return one row per entry on the page: search results, bestsellers, category, deals, offers, also bought, shop by look, seller catalogue, seller feedback, brand store, charts, wishlist and author titles. Page services return one row per identifier: product page, seller profile, reviewer profile and stock estimate. Lookup services return many small rows: autocomplete, ASIN to GTIN and the category tree. The account service reads your own plan and credits and costs the provider nothing.", "default": "search" }, "amazonDomain": { "title": "Amazon marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.ca", "amazon.com.mx", "amazon.com.br", "amazon.com.au", "amazon.co.jp", "amazon.in", "amazon.nl", "amazon.se", "amazon.pl", "amazon.com.be", "amazon.ie", "amazon.com.tr", "amazon.ae", "amazon.sa", "amazon.eg", "amazon.sg", "amazon.co.za", "amazon.cn" ], "type": "string", "description": "Which Amazon site to read from. Sent with every request except the account summary. A page URL given as an identifier carries its own domain and the provider uses that instead.", "default": "amazon.com" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "One search term per line, for the search, autocomplete and category tree services. A line that starts with http is sent as a search results page URL instead, for the search service.", "items": { "type": "string" } }, "identifiers": { "title": "Identifiers", "type": "array", "description": "One per line, for every other service: an ASIN (or a 12 to 14 digit GTIN, EAN, UPC or ISBN-13 where the service converts them) for product, offers, also bought, shop by look, stock estimate and ASIN to GTIN; an author ASIN for author page; a seller id for seller profile, feedback and products; a reviewer id for reviewer profile; a brand store id; a wishlist id; a category id for bestsellers, category and deals (leave empty for the deals homepage); a parent category id for the category tree (leave empty for the root). A line that starts with http is sent as that page's URL wherever the service accepts one.", "items": { "type": "string" } }, "identifierType": { "title": "How to read each identifier", "enum": [ "auto", "asin", "gtin", "url", "sellerId", "reviewerId", "storeId", "wishlistId", "categoryId", "parentId" ], "type": "string", "description": "Leave on automatic and each line is read by its shape: a URL when it starts with http, a GTIN when it is 12 to 14 digits and the service converts them, otherwise the kind the selected service reads by default. Set it explicitly when a line could be mistaken, for example a numeric category id on a service that also takes ASINs, or to look one category up by id in the category tree.", "default": "auto" }, "pages": { "title": "Pages per identifier", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many pages of a listing to walk for each search term or identifier, one request per page, stopping early when the provider reports no further page. Each page costs one credit at the provider. Ignored when a provider-side max page is set, because the provider then concatenates the pages itself.", "default": 1 }, "page": { "title": "Start page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "The page to start from, for the listing services that number their pages. Leave blank to start at the first page." }, "maxPage": { "title": "Provider-side max page", "minimum": 1, "maximum": 5, "type": "integer", "description": "Ask the provider to read this many pages in one request and concatenate them, for the listing services. The provider allows up to 5 on real-time requests and charges one credit per page actually returned. When set, the pages per identifier input is ignored." }, "sortBy": { "title": "Sort order", "enum": [ "bestseller_rankings", "most_recent", "price_low_to_high", "price_high_to_low", "featured", "average_review", "relevance", "bestsellers", "running_time_ascending", "running_time_descending", "title_ascending", "title_descending", "popularity", "publication_date", "most_reviews", "priority_high_to_low" ], "type": "string", "description": "How to order the entries, on the services that take a sort. Search and category take the first six. The Audible values apply to search on Audible domains only. Popularity, publication date and most reviews apply to author pages, and priority to wishlists." }, "searchCategoryId": { "title": "Limit search to a category id", "type": "string", "description": "A category id from the category tree service to restrict search results to. Accepted by the search service only; on bestsellers, category and deals the category id is the identifier itself." }, "refinements": { "title": "Refinements", "type": "string", "description": "A comma separated list of refinement values, for example p_85/2470955011,p_36/2421886011, to filter search, category or seller product results by rating, price range, brand and similar. Refinement values are returned in the refinements array of a first, unfiltered request and change by search term and category." }, "excludeSponsored": { "title": "Exclude sponsored results", "type": "boolean", "description": "Leave sponsored search results out of the search service's answer.", "default": false }, "directSearch": { "title": "Search the term exactly", "type": "boolean", "description": "Stop the provider from auto correcting a suspected spelling mistake in a search term.", "default": false }, "numberOfResults": { "title": "Number of search results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Ask for this many search results per page. You cannot request more than the search page shows." }, "topFree": { "title": "Top 100 free", "type": "boolean", "description": "Read the Top 100 Free version of a bestsellers category rather than the paid one. Not every category has one.", "default": false }, "dealTypes": { "title": "Deal types", "type": "string", "description": "Which deal types to include on the deals service, comma separated: lightning_deal, customers_most_loved, trending, summer_favorites, back_to_school, off_to_college. Leave blank for all. Deal types vary by marketplace and a type that does not exist there is redirected to Today's Deals by the provider, and still charged." }, "priceRange": { "title": "Deal price range tier", "type": "string", "description": "A price tier for the deals service. On amazon.com the tiers are 1 (under $25), 2 ($25 to $50), 3 ($50 to $100), 4 ($100 to $200) and 5 ($200 and above); other marketplaces have their own tiers." }, "discount": { "title": "Deal discount range", "enum": [ "10_percent_off", "25_percent_off", "50_percent_off", "70_percent_off" ], "type": "string", "description": "Only deals with a discount inside this range, for the deals service." }, "primeEarlyAccess": { "title": "Prime early access deals only", "type": "boolean", "description": "Filter the deals service to Prime Early Access deals.", "default": false }, "primeExclusive": { "title": "Prime exclusive deals only", "type": "boolean", "description": "Filter the deals service to Prime Exclusive deals.", "default": false }, "minimumRating": { "title": "Minimum deal rating", "enum": [ "1_and_up", "2_and_up", "3_and_up", "4_and_up" ], "type": "string", "description": "Only deals for products at or above this customer rating, for the deals service." }, "offersPrime": { "title": "Prime eligible offers only", "type": "boolean", "description": "Limit the offers service to offers that are Prime eligible.", "default": false }, "offersFreeShipping": { "title": "Free shipping offers only", "type": "boolean", "description": "Limit the offers service to offers with free shipping.", "default": false }, "conditionNew": { "title": "New condition only", "type": "boolean", "description": "Limit the offers service to offers in new condition.", "default": false }, "conditionUsedLikeNew": { "title": "Used, like new", "type": "boolean", "description": "Limit the offers service to offers in used, like new condition.", "default": false }, "conditionUsedVeryGood": { "title": "Used, very good", "type": "boolean", "description": "Limit the offers service to offers in used, very good condition.", "default": false }, "conditionUsedGood": { "title": "Used, good", "type": "boolean", "description": "Limit the offers service to offers in used, good condition.", "default": false }, "conditionUsedAcceptable": { "title": "Used, acceptable", "type": "boolean", "description": "Limit the offers service to offers in used, acceptable condition.", "default": false }, "showDifferentAsins": { "title": "Include offers for other ASINs", "type": "boolean", "description": "Keep offers the provider returns for ASINs other than the one asked for, which happens when the original is out of stock. Off by default, so the offers are about the ASIN you gave.", "default": false }, "skipGtinCache": { "title": "Force a fresh GTIN lookup", "type": "boolean", "description": "The provider caches each GTIN to ASIN mapping for two months. Set this to look a GTIN up again, at two credits instead of one, when you suspect the cached mapping is stale. Product and offers services.", "default": false }, "includeSummarizationAttributes": { "title": "Include review summary attributes", "type": "boolean", "description": "Add the summarization attributes and what customers say to a product page, at two credits instead of one.", "default": false }, "includeAPlusBody": { "title": "Include the A plus description HTML", "type": "boolean", "description": "Add the HTML of the manufacturer's A plus description section to a product page.", "default": false }, "variantPrices": { "title": "Include variant prices", "type": "boolean", "description": "Add a price to each variant of a product, at two credits instead of one.", "default": false }, "includeBookDescriptionRaw": { "title": "Include raw book description HTML", "type": "boolean", "description": "Add the raw HTML of a book's description to a product page, for ASINs that have one.", "default": false }, "includeSafetyProductResources": { "title": "Include safety product resources", "type": "boolean", "description": "Add the safety images and contacts section to a product page, at three credits instead of one.", "default": false }, "includeAllBookFormats": { "title": "Include all book formats and editions", "type": "boolean", "description": "Add every format and edition of a book to a product page, at one extra credit per supported format.", "default": false }, "includeImageBlockVideos": { "title": "Include image block videos", "type": "boolean", "description": "Add the structured video data from the product's image block, at two credits instead of one.", "default": false }, "importDelivery": { "title": "Include import delivery costs", "type": "boolean", "description": "Add shipping and import delivery costs to the buy box of a product page, at two credits instead of one.", "default": false }, "autocompleteAlias": { "title": "Autocomplete department alias", "type": "string", "description": "The department alias to scope autocomplete suggestions to, for example aps for all departments or stripbooks for books on amazon.com. Aliases vary by marketplace; leave blank for all departments." }, "reviewerProfilePages": { "title": "Reviewer profile review pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages of a reviewer's reviews to read on the reviewer profile service, ten reviews per page and one credit per page." }, "offerId": { "title": "Offer id for the stock estimate", "type": "string", "description": "Estimate stock for one specific seller offer rather than the buy box winner, using an offer id from a recent offers request. Offer ids change over time." }, "formatId": { "title": "Author page format id", "type": "string", "description": "Restrict an author's titles to one format, using a format id from the format_ids array of an earlier author page result." }, "categoryType": { "title": "Category tree type", "enum": [ "standard", "bestsellers", "gift_ideas", "most_wished_for", "movers_and_shakers", "new_releases", "deals" ], "type": "string", "description": "Which kind of category ids to browse on the category tree service: standard ids work with search and category, the bestseller kinds with bestsellers, and deals with deals.", "default": "standard" }, "customerLocation": { "title": "Customer location", "enum": [ "us", "gb", "ca", "de", "fr", "it", "es", "nl", "be", "ie", "at", "ch", "pl", "pt", "rs", "tr", "sa", "ae", "il", "mx", "co", "jp", "nz" ], "type": "string", "description": "Read the page as a customer in this country would see it, which surfaces cross border shipping and pricing. Leave blank to read as a customer in the marketplace's own country. Cannot be combined with a customer zipcode, and the deals service does not take it." }, "customerZipcode": { "title": "Customer zipcode", "type": "string", "description": "Read the page as a customer at this postal code, for highly localised listings such as grocery delivery. The zipcode must first be set up for the marketplace in your provider dashboard. Cannot be combined with a customer location, and the deals service does not take it." }, "language": { "title": "Language", "type": "string", "description": "The display language for the Amazon page, as a locale code the marketplace supports, for example en_US, de_DE or es_MX." }, "currency": { "title": "Currency", "type": "string", "description": "The currency to request Amazon pages in, where the marketplace supports it, for example EUR or GBP." }, "associateId": { "title": "Associate id", "type": "string", "description": "Your Amazon affiliate tag, appended to every product link the provider returns." }, "includeFields": { "title": "Include only these fields", "type": "string", "description": "A comma separated list of response fields to keep, in dot notation, for example search_results.title,search_results.asin,search_results.price. Everything else is left out of the record." }, "excludeFields": { "title": "Exclude these fields", "type": "string", "description": "A comma separated list of response fields to drop, in dot notation, for example product.images." }, "extraParameters": { "title": "Extra query parameters", "type": "object", "description": "Any other parameter the provider documents for the selected service that this actor does not have its own field for. Given as a JSON object, for example {\"output\": \"json\"}. Nothing here is invented: it is passed to the provider exactly as written, so check the name against the provider's own documentation first." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many rows. A listing page can return dozens of entries and a walk over several pages hundreds, so this is what bounds a run that reads a long list of search terms.", "default": 500 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 300, "type": "integer", "description": "Pacing ceiling. The provider's rate limit depends on your plan, so the default is conservative. Raise it if your plan allows.", "default": 30 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key for the Amazon product data provider. 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 } } } } } } } } } }