# Amazon Scraper (`epctex/amazon-scraper`) Actor The fastest and most reliable Amazon scraper ever. Extract key data like reviews, prices, ASINs, without relying on Amazon's API. Tailor searches with specific URLs, keywords, and local postal codes for targeted insights. Download in various formats for easy analysis. - **URL**: https://apify.com/epctex/amazon-scraper.md - **Developed by:** [epctex](https://apify.com/epctex) (community) - **Categories:** E-commerce - **Stats:** 415 total users, 8 monthly users, 95.0% runs succeeded, 22 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing $40.00/month + usage To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors ## 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 ## Amazon Scraper Actor ### What is Amazon Scraper actor? The Amazon Scraper is a data scraping tool designed to simplify your market research on Amazon. It's the perfect assistant for extracting a great deal of detailed product information and much more. Whether you're digging into specific product URLs or making a wide keyword search, this tool is your best assistant to get valuable insights from Amazon's massive e-commerce platform. Easy to use and incredibly flexible, the Amazon Scraper actor saves you time and effort, making your research process a breeze. #### Key features - πŸ—οΈ Versatile Keyword Search: Just type in a keyword, and the tool gathers a wide array of product details, including titles, descriptions, and features. - πŸ”— Direct Product URL Scraping: Get in-depth information about a specific product by simply entering its URL. *(For instance, using the URL https://www.amazon.com/EXCELLENT-ELITE-SPANKER-Tactical-Adjustable/dp/B0725FT5ZW will fetch information for that particular product.)* - πŸ“‚ Category Scraping: Explore entire categories and gather data on all listed products with ease. *(For example, https://www.amazon.com/s?i=specialty-aps&bbn=16225007011&rh=n%3A16225007011%2Cn%3A1292115011 targets the Computer Monitors subcategory.)* - πŸ›’ Seller Products Fetching: Extract details on all products offered by a specific seller using their profile URL. - πŸ” Utilization of Search URLs: Direct Amazon search URLs can also be used for scraping. *(For example, the URL https://www.amazon.com/s?k=tactical+dog+harness can be used to scrape information on tactical dog harnesses.)* - 🌍 Multi-TLD Compatibility: The scraper supports various Amazon TLDs, enabling queries on different Amazon international websites like .com, .co.uk, .de, and others. This feature allows for a broader and more diverse data extraction, accommodating global market research and analysis. - πŸ“ Postal Code for Location Specificity: Refine your search results geographically by entering the local postal code, ensuring more relevant data collection. However, it's important to note that not all countries may support the location setting by postal code. ### Use Cases | Who Can Use Amazon Scraper - **Market researchers** to monitor market trends, consumer preferences, and competitive insights. - **E-commerce businesses** for optimizing product listings, pricing strategies, and understanding competitor offerings. - **Startups** to validate product ideas and identify niches within Amazon's marketplace. - Data analysts for **collecting large datasets for analysis, forecasting, and reporting**. - **Content creators** to generate product-related content by extracting detailed information. - Developers to **integrate Amazon data into apps or websites** for enhanced user experiences. - **Dropshippers** to identify profitable products to list in online stores. - Corporate strategists to **make informed decisions** on product launches, market entry, and expansion. - **Digital marketers** to tailor marketing campaigns based on in-depth product and market insights. - **Brand managers** to monitor brand presence, customer feedback, and market positioning on Amazon. - Academic researchers for **conducting studies on consumer behavior, e-commerce trends,** and product dynamics. - SEO specialists to improve product visibility and **search rankings on Amazon**. ### Input Either start with a keyword or specific store URLs to your research. πŸ’‘When you want to scrape over a specific list URL, just copy and paste the link as one of the **startUrl**. If you start with a keyword, and you want to localize your search, you can choose a specific Amazon domain, and further localize it by entering a postal code. ![](https://cdn.epctex.com/actors/amazon/2.png) You can limit the number of output results by either writing a number for number of listing items or list end page. πŸ’‘If you would like to scrape only the first page of a list then put the link for the page and have the *endPage* as 1. πŸ’‘With the last approach that is explained above you can also fetch any interval of pages. If you provide the 5th page of a list and define the *endPage* parameter as 6 then you'll have the 5th and 6th pages only. It is recommended to keep the other options as default. ![](https://cdn.epctex.com/actors/amazon/4.png?refresh=) #### Input Parameters Explained - `search`: (Optional) (String) Enter the keyword for Amazon search. This keyword is used to find products related to your query on the Amazon platform. - `startUrls`: (Optional) (Array) Specify URLs to initiate the scraping process. These should be either a list URL or a detail URL of the product or category you're interested in. - `amazonTld`: (Optional) (String) Choose the specific Amazon top-level domain (TLD) that corresponds to your target country. For example, select 'Germany' to use amazon.de. This setting influences both search results and the functionality of the postal code feature. Ensure accurate selection for optimal location setting. - `postalCode`: (Optional) (String) Input the local postal code to increase the specificity of location-based data. This option should be utilized in conjunction with the 'Amazon Country Domain' setting. Please note that the effectiveness of this feature varies, as not all countries may support location filtering by postal code. - `maxItems`: (Optional) (Number) You can limit scraped items. This should be useful when you search through the big lists or search results. - `proxy`: (Required) (Proxy Object) Proxy configuration. - `extendOutputFunction`: (Optional) (String) Function that takes a JQuery handle ($) as an argument and returns an object with data. - `customMapFunction`: (Optional) (String) Function that takes each object's handle as an argument and returns the object with executing the function. This solution requires the use of **Proxy servers**, either your own proxy servers or you can use [Apify Proxy](https://www.apify.com/docs/proxy). #### Amazon Scraper Input Examples ##### Fetch a Single Product ![](https://cdn.epctex.com/actors/amazon/5.png) ```json { "startUrls": [ "https://www.amazon.com/EXCELLENT-ELITE-SPANKER-Tactical-Adjustable/dp/B0725FT5ZW" ], "endPage": 2, "maxItems": 10, "proxy": { "useApifyProxy": true } } ```` ##### Fetch Products of a Category ![](https://cdn.epctex.com/actors/amazon/6.png) ```json { "startUrls": [ "https://www.amazon.com/s?i=specialty-aps&bbn=16225007011&rh=n%3A16225007011%2Cn%3A1292115011" ], "endPage": 2, "maxItems": 10, "proxy": { "useApifyProxy": true } } ``` ##### Fetch Results of a Search ![](https://cdn.epctex.com/actors/amazon/7.png) ```json { "startUrls": [ "https://www.amazon.com/s?k=tactical+dog+harness" ], "endPage": 2, "maxItems": 10, "proxy": { "useApifyProxy": true } } ``` ##### Fetch Results of a Search by Keyword ![](https://cdn.epctex.com/actors/amazon/8.png) ```json { "search": "tactical dog harness", "amazonTld": ".com", "endPage": 2, "maxItems": 10, "proxy": { "useApifyProxy": true } } ``` ##### Fetch Products of a Seller ![](https://cdn.epctex.com/actors/amazon/9.png) ```json { "startUrls": [ "https://www.amazon.com/sp?ie=UTF8&seller=A2OVB8DG3JN6N0" ], "amazonTld": ".com", "endPage": 2, "maxItems": 10, "proxy": { "useApifyProxy": true } } ``` #### Compute Unit Consumption The actor is optimized to run blazing fast and scrape as many items as possible. Therefore, it forefronts all the detailed requests. If the actor doesn't block very often it'll scrape 100 listings in 2 minutes with ~0.02-0.04 compute units. #### Bugs, fixes, updates, and changelog This scraper is under active development. If you have any feature requests you can create an issue from [here](https://github.com/epctex-support/amazon-scraper/issues). ### During the Run During the run, the actor will output messages letting you know what is going on. Each message always contains a short label specifying which page from the provided list is currently specified. When items are loaded from the page, you should see a message about this event with a loaded item count and total item count for each page. If you provide incorrect input to the actor, it will immediately stop with a failure state and output an explanation of what is wrong. #### Amazon Export During the run, the actor stores results into a dataset. Each item is a separate item in the dataset. You can manage the results in any language (Python, PHP, Node JS/NPM). See the FAQ or our API reference to learn more about getting results from this Amazon actor. ### Output #### Product Detail ```json { "type": "product", "title": "TSPRO Tactical Dog Vest Harnesses with Handle 1.5 inch Wide Military Grade Strong Padded Thick Dog Harnesses Heavy Duty Dog Harnesses Quick-Release Buckle for Medium Large Dogs(Khaki-L)", "url": "https://www.amazon.com/TSPRO-Tactical-Harnesses-Military-Quick-Release/dp/B0BPSRP1ZR/ref=sr_1_43?dib=eyJ2IjoiMSJ9.sSdvwLMclQZDy2UPq_En39-40LSoj2nej9GjYGXj76z5tyCniBvXFTVLTW1KgHfCHGB9X3vfJCK-VBj5qdUgeBBFGVRxs133M6EU1dnmTM0eKhYhGYH4JeRu5SJZ3wtkceVJjNPbHKSsEESaG2jytA.Ne54E_KFU9hMXNKmqgVvo0Ia0ALV8Q1WexY_0mwu_3k&dib_tag=se&keywords=tactical+dog+harness&qid=1705102403&sr=8-43", "inStock": true, "maxQuantitySelection": "28", "brand": "TSPRO", "price": { "value": 39.99, "currency": "$" }, "listPrice": { "value": 49.99, "currency": "$" }, "shippingPrice": { "value": null, "currency": null }, "shippingText": "FREE delivery Friday, January 19", "stars": 4.3, "starsBreakdown": { "5star": 0.56, "4star": 0.28, "3star": 0.09, "2star": 0.04, "1star": 0.04 }, "reviewsCount": 61, "answeredQuestions": null, "categories": [ "Pet Supplies", "Dogs", "Collars, Harnesses & Leashes", "Harnesses", "Vest Harnesses" ], "images": [ "https://m.media-amazon.com/images/I/41eyNo1+QcL.jpg", "https://m.media-amazon.com/images/I/513eeIytxiL.jpg", "https://m.media-amazon.com/images/I/51HVaBo003L.jpg", "https://m.media-amazon.com/images/I/512TCT4DDDL.jpg", "https://m.media-amazon.com/images/I/51gDJ23dT2L.jpg", "https://m.media-amazon.com/images/I/51KhvTc12-L.jpg" ], "seller": { "name": "TSPRO OUTDOOR", "url": "https://www.amazon.com/gp/help/seller/at-a-glance.html/ref=dp_merchant_link?ie=UTF8&seller=A2TYHXPD5TQ99B&asin=B0BPSRP1ZR&ref_=dp_merchant_link&isAmazonFulfilled=1", "id": "A2TYHXPD5TQ99B" }, "variants": [ { "title": "S-(Neck:17\"-25\",Chest:21\"-26\")", "url": "/dp/B0BPSPGMK2/ref=twister_B0BPSSCC42?_encoding=UTF8&psc=1", "price": "" }, { "title": "M-(Neck:23.5\"-28\",Ches:23\"-31.5\")", "url": "/dp/B0BPSRCN8K/ref=twister_B0BPSSCC42?_encoding=UTF8&psc=1", "price": "" }, { "title": "L -(Neck:25.5\"-36\",Chest:27\"-35.5\")", "url": "", "price": "" } ], "features": [ { "key": "Size", "value": "L -(Neck:25.5\"-36\",Chest:27\"-35.5\")" }, { "key": "Color", "value": "Khaki" }, { "key": "Pattern", "value": "Solid" }, { "key": "Brand", "value": "TSPRO" }, { "key": "Material", "value": "Nylon" } ], "featureBullets": [ "Tactical Dog Vest Harnesses.Well made and high guality genuine nylon material,the nylon dog Harnesses is thick, tough yet comfortable,and the soft padded interior provides a comfortable wearing and prevents your dog from rubbing against the skin.Double-layered nylon webbing with multiple lines of stitching for toughness and durability to take on all types of adventures and weather.When you receive and feel the Harnesses you will know that it was made with quality and care.", "Premium dog harnesses with handle.This training dog Harnesses has a padded control handle which is very comfortable for grip and makes control of your tactical dog easier in tough situations.When used for leisure walking,there is 3 extra D rings to attach your favorite dog training clicker or garbage bag capsule,worth the money.", "Heavy duty dog Harnesses & Quick-release buckles. The dog Harnesses with 2 quick release buckles and slider is easy to adjust the comfortable fit and take on/off.quick-release buckle with a smooth locking mechanism.Equipped with 3 large D-Rings for quick and easy leash attachment.Please follow the size chart to measure your dog carefully before purchasing to ensure the Harnesseses is fit well to your dog.Please kindly find the size chart.", "Padded Thick Dog Harnesses avoids any sensitive areas such as the under arms and neck which may be prone to rubbing, does not restrict natural shoulder movement. Ideal for mastiff, German Shepherd,Pit Bull,Labrador Retriever,Australian Shepherd,Boxers, Pointers ,Puppy,American/English Bulldog,Siberian Husky,Doberman, Belgian Malinois,Hurley Dog etc. for Small or Medium to Extra Large dogs breeds,and great for dog training, patrol,hiking, hunting, camping, working, runing, traveling,etc.", "100% Quality Warranty: Your satisfaction is our first priority, we take care of all quality-related issues with a REPLACEMENT OR FULL REFUND with 90days; If you encounter any problem while using, never hesitate to send email to us and we will make it all right for you." ], "productAlert": "", "description": "", "specs": [], "delivery": "Friday, January 19", "returnPolicy": "Free returns are available for the shipping address you chose. You can return the item for any reason in new and unused condition: no shipping charges Learn more about free returns. Free returns are available for the shipping address you chose. You can return the item for any reason in new and unused condition: no shipping charges Learn more about free returns. Free returns are available for the shipping address you chose. You can return the item for any reason in new and unused condition: no shipping charges Learn more about free returns.", "relatedItems": [], "manufacturerHtml": "\n \n \n\n\n \n
\n
\n
\n
\n
\n
\n \"TSPRO
\n\n
\n
\n
\n
\n\n
Previous page
  2. \n
    \n
    \n \"TSPRO
    \n
    \n

    The world is coloful, let's make our dogs colorful too!

    Wish our products can convey your caring to your dogs. Henri Matisse, one of the recognition as a leading figure in modern art. The aesthetics of Fauvism are reflected in his work: bold colors, concise shapes, harmonious compositions and strong ornamentation. The founder of the TSPRO brand agrees with this concept. So the TSPRO brand has a dog collars & leashes in 10 colors!

    \n
    \n
    \n
    \n
  3. \n
    \n
    \n \"TSPRO
    \n\n
    \n

    Premium Dog Collars & leashes

    10 colors choice!

    \n
    \n
    \n
    \n
  4. \n
    \n
    \n
    \n \"TSPRO
    \n
    \n \"TSPRO
    \n
    \n\n
    \n
    \n \"TSPRO
    \n
    \n \"TSPRO
    \n
    \n\n
    \n

    Dog Collar & leash & harness

    Visit the Store

    \n
    \n
    \n
    \n
  5. \n
    \n
    \n
    \n

    Why Choose TSPRO?

    TSPRO specialize in providing fashionable and high-quality dog wearing products for large and medium-sized dogs.

    If you want a present for your dog, a good idea is to give him or her a TSPRO dog collar.

    \n
    \n

    Are our products of high quality?

    *Rugged materials & quality accessories of Premium durability and dirt/water/scratch resistance.

    *100% Highly Quality : Your satisfaction is our first priority.

    \n
    \n

    Can I offer my advice?

    Let's co-design & Custom product programs to create product that suits different needs and purposes.

    \n
    \n
    \n
    \n
    \n
Next page
\n
\n
\n
\n " } ``` ### How to use Amazon Scraper https://www.youtube.com/watch?v=Aa5SOI5EHNU\&ab\_channel=epctex ### FAQ **Is it legal to scrape from Amazon?**
It’s legal to extract public data from Amazon, however, personal information and sensitive data are not. βš–οΈ **Can I customize the data extracted by Amazon Scraper?**
Yes, Amazon Scraper allows for customization in the data extraction process. Users can specify what information they need, such as specific product details, making the tool versatile for different use cases. βš™οΈ **Can Amazon Scraper extract data from any Amazon region?**
Yes, Amazon Scraper supports multiple Amazon top-level domains (TLDs), enabling users to extract data from various international Amazon websites. 🌍 **Do I need technical skills to use Amazon Scraper?**
Amazon Scraper is designed to be user-friendly, with a straightforward interface that requires minimal technical knowledge. Users can easily input their search criteria to start scraping data. πŸ› οΈ **Is there a limit to the amount of data I can scrape with Amazon Scraper?**
While there is no fixed limit, users can set a maximum number of items to scrape to manage the scope of their data collection. This ensures that users can tailor the scraping process to their specific needs. πŸ“ ### Contact Please visit us through [epctex.com](https://epctex.com) to see all the products that are available for you. If you are looking for any custom integration or so, please reach out to us through the chat box in [epctex.com](https://epctex.com). In need of support? is at your service. # Actor input Schema ## `search` (type: `string`): The keyword that you can search on Amazon ## `amazonTld` (type: `string`): Select the Amazon domain corresponding to your desired country (e.g., choose 'Germany' for amazon.de). This domain affects search and postal code functionalities. Fill this correctly to be able to set location. ## `postalCode` (type: `string`): Enter the local postal code to enhance location specificity. This should be used along with 'Amazon Country Domain' setting. Note: Not all countries may support location setting by postal code. ## `maxItems` (type: `integer`): Maximum number of listing items that you want as output. Default is all ## `endPage` (type: `integer`): The page number that you want to end with. By default there is no end page. This is applies to all search request and startUrls individually. ## `startUrls` (type: `array`): URLs to start with. It should be list or detail URL ## `extendOutputFunction` (type: `string`): Function that takes a JQuery handle ($) as argument and returns data that will be merged with the default output ## `customMapFunction` (type: `string`): Function that takes each of the objects as argument and returns data that will be mapped by the function itself. ## `proxy` (type: `object`): Select proxies to be used by your crawler. ## Actor input object example ```json { "search": "iphone", "amazonTld": ".com", "maxItems": 20, "endPage": 1, "startUrls": [ "https://www.amazon.com/s?k=android&ref=nb_sb_noss", "https://www.amazon.com/EXCELLENT-ELITE-SPANKER-Tactical-Adjustable/dp/B0725FT5ZW" ], "extendOutputFunction": "($) => { return {} }", "customMapFunction": "(object) => { return {...object} }", "proxy": { "useApifyProxy": true } } ``` # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "search": "iphone", "maxItems": 20, "endPage": 1, "startUrls": [ "https://www.amazon.com/s?k=android&ref=nb_sb_noss", "https://www.amazon.com/EXCELLENT-ELITE-SPANKER-Tactical-Adjustable/dp/B0725FT5ZW" ], "extendOutputFunction": ($) => { return {} }, "customMapFunction": (object) => { return {...object} }, "proxy": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("epctex/amazon-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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "search": "iphone", "maxItems": 20, "endPage": 1, "startUrls": [ "https://www.amazon.com/s?k=android&ref=nb_sb_noss", "https://www.amazon.com/EXCELLENT-ELITE-SPANKER-Tactical-Adjustable/dp/B0725FT5ZW", ], "extendOutputFunction": "($) => { return {} }", "customMapFunction": "(object) => { return {...object} }", "proxy": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("epctex/amazon-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 '{ "search": "iphone", "maxItems": 20, "endPage": 1, "startUrls": [ "https://www.amazon.com/s?k=android&ref=nb_sb_noss", "https://www.amazon.com/EXCELLENT-ELITE-SPANKER-Tactical-Adjustable/dp/B0725FT5ZW" ], "extendOutputFunction": "($) => { return {} }", "customMapFunction": "(object) => { return {...object} }", "proxy": { "useApifyProxy": true } }' | apify call epctex/amazon-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=epctex/amazon-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Amazon Scraper", "description": "The fastest and most reliable Amazon scraper ever. Extract key data like reviews, prices, ASINs, without relying on Amazon's API. Tailor searches with specific URLs, keywords, and local postal codes for targeted insights. Download in various formats for easy analysis.", "version": "0.0", "x-build-id": "BIC3FciDMDTPHmaod" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/epctex~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-epctex-amazon-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/epctex~amazon-scraper/runs": { "post": { "operationId": "runs-sync-epctex-amazon-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/epctex~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-epctex-amazon-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": [ "proxy" ], "properties": { "search": { "title": "Search keyword", "type": "string", "description": "The keyword that you can search on Amazon" }, "amazonTld": { "title": "Amazon Country Domain", "enum": [ ".ae", ".ca", ".cn", ".co.uk", ".com", ".com.au", ".com.br", ".com.mx", ".com.tr", ".de", ".es", ".fr", ".in", ".it", ".co.jp", ".nl", ".pl", ".sa", ".se", ".sg" ], "type": "string", "description": "Select the Amazon domain corresponding to your desired country (e.g., choose 'Germany' for amazon.de). This domain affects search and postal code functionalities. Fill this correctly to be able to set location.", "default": ".com" }, "postalCode": { "title": "Postal Code", "type": "string", "description": "Enter the local postal code to enhance location specificity. This should be used along with 'Amazon Country Domain' setting. Note: Not all countries may support location setting by postal code." }, "maxItems": { "title": "Maximum number of listing items", "type": "integer", "description": "Maximum number of listing items that you want as output. Default is all" }, "endPage": { "title": "List end page", "type": "integer", "description": "The page number that you want to end with. By default there is no end page. This is applies to all search request and startUrls individually." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "URLs to start with. It should be list or detail URL", "items": { "type": "string" } }, "extendOutputFunction": { "title": "Extend output function", "type": "string", "description": "Function that takes a JQuery handle ($) as argument and returns data that will be merged with the default output" }, "customMapFunction": { "title": "Custom map function", "type": "string", "description": "Function that takes each of the objects as argument and returns data that will be mapped by the function itself." }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler." } } }, "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 } } } } } } } } } } ```