# πŸ›’βœ¨ eBay Search Scraper (`scraper-engine/ebay-search-scraper`) Actor πŸ›’βœ¨ eBay Search Scraper pulls real-time marketplace data from eBay search results β€” titles, prices, images, sellers, ratings, shipping, condition & item specifics. πŸ“ˆ Ideal for price tracking, market research, SEO, and product monitoring. πŸ”Ž Supports keywords, filters & pagination. - **URL**: https://apify.com/scraper-engine/ebay-search-scraper.md - **Developed by:** [Scraper Engine](https://apify.com/scraper-engine) (community) - **Categories:** E-commerce, Developer tools, Automation - **Stats:** 3 total users, 2 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $4.99 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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 ### πŸ›’βœ¨ eBay Search Scraper The πŸ›’βœ¨ eBay Search Scraper is an Apify actor that turns eBay search results into clean, structured product data β€” including titles, prices, images, shipping, returns, seller feedback, and item specifics β€” at scale. It solves the pain of manually collecting eBay marketplace data by automating keyword-based discovery and deep product-page parsing. Built for marketers, developers, data analysts, and researchers, this eBay search scraper delivers a reliable eBay search API alternative for price tracking, market research, SEO insights, and product monitoring β€” ready to export and integrate into your stack. With support for regional sites and filters like location, sort, β€œShow only,” and buying format, you can focus your eBay listings scraper on the exact results you need and run it at scale across multiple pages with live results streaming into your dataset. ### What data / output can you get? Below are the top-level fields saved for each item. Each field is structured to help you analyze, enrich, and export your data easily (CSV, JSON, or Excel via Apify dataset exports). | Data type | Description | Example value | | --- | --- | --- | | source_url | Canonical eBay listing URL that was scraped | https://www.ebay.com/itm/123456789012 | | listing_card | Compact summary for quick scanning: title, price, condition, shipping/returns, seller stats | { "title": "Apple iPhone 12 64GB", "price": "$299.99", "seller_username": "best_seller_123", ... } | | images | Normalized image set with thumbnail/original/zoom URLs and sizes | [ { "original": { "url": "https://i.ebayimg.com/images/g/.../s-l400.jpg" }, "mediaType": "IMAGE" } ] | | shipping_section_module | Shipping details module with structured rows | { "title": "Shipping", "sections": { "shipping": { "dataItems": { "shippingRate": { "label": "Shipping Rate", "value": "Free" } } } } } | | returns_section_module | Returns policy module with structured items | { "title": "Returns", "sections": { "returns": { "dataItems": [ { "label": "Return Policy Category", "value": "Domestic" } ] } } } | | payments_section_module | Payments module with accepted methods | { "title": "Payments", "sections": { "paymentMethods": { "dataItems": [ "PayPal", "Visa" ] } } } | | condition_description | Short/long condition descriptors extracted from DOM | { "title": "New", "sections": [ { "dataItems": [ { "label": "Condition (detail)", "value": "New with tags" } ] } ] } | | title | Main title extracted from the page/JSON-LD | { "mainTitle": "Apple iPhone 12 64GB - Black" } | | buy_box | Buy box details: price, financing messages, delivery messages, and seller info | { "binModel": { "price": "299.99" }, "deliveryInfo": { "deliveryMessage": [ "Free 3-day delivery" ] } } | | quantity | Quantity/availability data from the buy box | { "displayLabel": "Quantity", "maxQuantity": "5", "outOfStock": false } | | buy_box_cta | CTAs visible in the buy box (localized when available) | { "buttons": [ "Buy It Now", "Add to cart", "View in cart", "Add to Watchlist", "Added to Watchlist" ] } | | about_this_item_min_view | Item specifics (brand, item number, attributes) | { "title": "About this item", "sections": { "itemSpecificsSection": { "dataItems": { "itemNumber": "123456789012", "brand": "Apple", "color": "Black", "quantity": [ ... ] } } } } | | item_desc_seller | Item description preview and iframe URL (if exposed) | { "title": "Item description from the seller", "sections": { "itemDescriptionSection": { "dataItems": { "iframeUrl": "https://.../desc_ifr", "preview": "Condition: New..." } } } } | | shipping_returns_payment_section_module | Consolidated shipping/returns/payments snippet | { "title": "Shipping, returns, and payments", "sections": { "spr": { "dataItems": { ... } } } } | | about_this_seller_section_module | Seller card summary: username, trust signals, feedback | { "title": "About the seller", "sections": [ { "username": "best_seller_123", "trustSignals": [ "99.8% positive feedback" ] } ] } | Note: Images and metadata are normalized for analysis. Apify lets you export to CSV, JSON, Excel, and more directly from the dataset. ### Key features - πŸš€ Real-time dataset streaming β€” Each product row is saved to your Output as soon as it’s collected, so you can start analyzing immediately. - 🌍 Regional eBay support β€” Target 17 eBay sites (US, UK, DE, AU, and more) using the domain input for localized pricing and inventory. - 🎯 Granular filters β€” Combine query + location + sort + β€œShow only” (e.g., sold items, completed listings, free shipping) + buying format (Auction Β· Buy It Now Β· Accepts Offers). - πŸ”Ž Deep product parsing β€” Extracts listing details, images, shipping, returns, payments, seller feedback, item specifics, and description previews for structured analysis. - πŸ›‘οΈ Smart proxy escalation β€” Direct by default; if blocked, escalate to datacenter β†’ residential with up to 3 residential retries, then enable sticky residential for stability (when Apify Proxy is enabled). - πŸ“ Optional long description β€” Toggle fetch_description_iframe to retrieve richer seller descriptions when available. - πŸ’» Developer-friendly β€” Works as an eBay data extraction tool in your pipelines; integrate with the Apify API or connect to your eBay scraper Python workflows. - πŸ“ˆ Built for scale β€” Control max pages and max listings; internal batching and delays balance throughput and reliability for eBay web scraping bot use cases. ### How to use πŸ›’βœ¨ eBay Search Scraper β€” step by step 1. Create or log into your Apify account. 2. Open the πŸ›’βœ¨ eBay Search Scraper actor. 3. Enter your search configuration: - Set query (e.g., β€œcoffee grinder”) and choose the domain (e.g., β€œebay.com”). - Optionally adjust location (ship-to), sort, β€œShow only,” and buying_format. - Set max_pages and maxItems to control depth and volume. - Optional: enable Use Apify Proxy and configure proxyConfiguration. - Optional: enable fetch_description_iframe for richer item descriptions. 4. Start the run. 5. Watch the run log. The scraper first searches eBay (Step 1) to collect candidate listings, then opens each listing (Step 2) and saves rows live. 6. Open the Output tab to browse results as they arrive. 7. Export your dataset to CSV, JSON, or Excel for downstream analysis or automation. 8. Pro Tip: Use show_only with sold_items or completed_items to focus on eBay sold items scraper and eBay completed listings scraper scenarios. ### Use cases | Use case name | Description | | --- | --- | | Price tracking for retail | Monitor pricing trends and shipping costs across regions, using the eBay price scraper outputs to benchmark and optimize margins. | | Market research for brands | Analyze competitors and product variants by extracting eBay product data scraper fields (condition, brand, item specifics) at scale. | | SEO & content strategy | Identify titles, keywords, and listing attributes from the eBay search results scraper to improve marketplace visibility. | | Resale & arbitrage | Track eBay listings for profitable flips using filters like sold/completed to estimate demand and achievable prices. | | Catalog enrichment | Enrich internal catalogs with images, item specifics, and seller metadata from the eBay marketplace data scraper. | | Academic & trend analysis | Study category dynamics and consumer behavior with structured, export-ready data for reproducible research. | | Automation pipelines (API) | Trigger runs via API and pipe eBay search results to CSV into ETL/data warehouses for analytics and dashboards. | ### Why choose πŸ›’βœ¨ eBay Search Scraper? Built for precision, automation, and reliability, this eBay scraping tool focuses on structured, high-signal marketplace data without manual overhead. - 🎯 Accurate, structured output: Extracts rich product details from individual listing pages for consistent analysis. - 🌐 Localization-ready: Target 17 eBay country sites for currency- and inventory-accurate datasets. - ⚑ Scalable & fast: Pagination and maxItems controls, plus internal batching for larger runs. - πŸ§‘β€πŸ’» Developer access: Works seamlessly with the Apify API and your eBay scraper Python workflows for automation. - πŸ›‘οΈ Robustness built-in: Smart proxy escalation with sticky residential mode for consistent throughput (when enabled). - πŸ”’ No login required: Scrapes public listing pages without cookies or authentication. - πŸ’° Cost-effective alternative: A dependable eBay search API alternative for high-quality eBay data extraction workflows. In short: a production-ready eBay web scraping bot that outperforms browser extensions and brittle scripts by delivering structured, repeatable results. ### Is it legal / ethical to use πŸ›’βœ¨ eBay Search Scraper? Yes β€” when done responsibly. This actor collects publicly available information from eBay product pages and search results. It does not access private or authenticated data. Guidelines for responsible use: - Only extract public listing information and respect platform policies. - Ensure compliance with applicable laws and regulations (e.g., GDPR, CCPA) for your use case and geography. - Avoid collecting personal data or using the data for spam. - Consult your legal team for edge cases and jurisdiction-specific constraints. ### Input parameters & output format #### Example JSON input ```json { "query": "coffee grinder", "domain": "ebay.com", "location": "1", "sort": "12", "show_only": ["sold_items"], "buying_format": "BIN", "max_pages": 2, "maxItems": 50, "useProxy": true, "fetch_description_iframe": false, "proxyConfiguration": { "useApifyProxy": true } } ```` #### Parameter details - query (string) β€” Type what you want to find; drives the search together with Country & filters. Default: "coffee". Required: No. - domain (string) β€” Which eBay site to search (17 regional options). Default: "ebay.com". Required: No. - location (string) β€” Ship-to location code to align results with buyer/delivery context. Default: "1". Required: No. - sort (string) β€” Sort order (Best Match, ending soonest, newly listed, price high/low, distance). Default: "12". Required: No. - show\_only (array of strings) β€” Optional quick filters (e.g., "sold\_items", "completed\_items", "free\_shipping"). Default: \[]. Required: No. - buying\_format (string) β€” Listing format: "Auction", "BIN" (Buy It Now), or "BO" (Accepts Offers). Default: "BIN". Required: No. - max\_pages (integer) β€” How many search result pages to walk. Default: 1. Required: No. - maxItems (integer) β€” Cap on total rows in the dataset for this run. Default: 20. Required: No. - useProxy (boolean) β€” Enable Apify Proxy routing. Default: true. Required: No. - fetch\_description\_iframe (boolean) β€” Fetch richer seller description text when available (slower). Default: false. Required: No. - proxyConfiguration (object) β€” Apify Proxy configuration (used when useProxy is enabled). Prefill: { "useApifyProxy": true }. Required: No. #### Example JSON output ```json { "source_url": "https://www.ebay.com/itm/123456789012", "listing_card": { "title": "Apple iPhone 12 64GB - Black", "sponsored": false, "link": "https://www.ebay.com/itm/123456789012", "condition": "New", "thumbnail": "https://i.ebayimg.com/images/g/abc123/s-l1600.jpg", "price": "$299.99", "shipping": "Free shipping Β· United States", "returns": "30-day returns Β· Free returns", "seller_username": "best_seller_123", "seller_reviews": 15234, "seller_positive_feedback_in_percentage": 99.8 }, "images": [ { "thumbnails": [ { "url": "https://i.ebayimg.com/images/g/abc123/s-l64.jpg", "title": "1 of 3", "type": "thumbnail" } ], "original": { "url": "https://i.ebayimg.com/images/g/abc123/s-l400.jpg", "title": "1 of 3", "type": "original" }, "zoom": { "url": "https://i.ebayimg.com/images/g/abc123/s-l1600.jpg", "title": "1 of 3", "type": "zoom" }, "title": "1 of 3", "uploadedSize": { "height": 1600, "width": 1600 }, "mediaType": "IMAGE" } ], "shipping_section_module": { "title": "Shipping", "sections": { "shipping": { "dataItems": { "shippingRate": { "label": "Shipping Rate", "value": "Free USD" }, "shippingDestination": { "label": "Shipping Destination", "value": "US" } } }, "title": { "title": "Delivery" } } }, "returns_section_module": { "title": "Returns", "sections": { "returns": { "dataItems": [ { "label": "Return Policy Category", "value": "Domestic" } ] } } }, "payments_section_module": { "title": "Payments", "sections": { "paymentMethods": { "dataItems": ["PayPal", "Visa", "Mastercard"] } } }, "condition_description": { "sections": [ { "dataItems": [ { "label": "Condition (detail)", "value": "New with tags" }, { "label": "Condition (summary)", "value": "New with tags" } ] } ], "title": "New" }, "title": { "mainTitle": "Apple iPhone 12 64GB - Black" }, "buy_box": { "binModel": { "price": "299.99", "isAddedToCart": false, "priceTransparencyAction": "Price details" }, "financingDetails": { "financingMessages": ["Special financing available"] }, "repositionCoupon": false, "deliveryInfo": { "deliveryMessage": ["Free 3-day delivery"] }, "sellerInfo": { "profileLogo": { "title": "best_seller_123" }, "dataItems": ["best_seller_123", "99.8% positive feedback"] } }, "quantity": { "displayLabel": "Quantity", "maxQuantityReached": "", "maxQuantity": "5", "outOfStock": false }, "buy_box_cta": { "buttons": ["Buy It Now", "Add to cart", "View in cart", "Add to Watchlist", "Added to Watchlist"] }, "about_this_item_min_view": { "title": "About this item", "sections": { "itemSpecificsSection": { "dataItems": { "quantity": [ { "label": "available", "value": "5 available" }, { "label": "sold", "value": "120 sold" } ], "itemNumber": "123456789012", "brand": "Apple", "condition": "New with tags", "color": "Black" } } } }, "item_desc_seller": { "title": "Item description from the seller", "sections": { "itemDescriptionSection": { "dataItems": { "iframeUrl": "https://desc.ebay.com/desc_ifr?...", "preview": "Condition: New. Ships fast from US.", "plainText": "Condition: New. Includes charger and cable..." } } } }, "shipping_returns_payment_section_module": { "title": "Shipping, returns, and payments", "sections": { "spr": { "dataItems": { "shippingRate": { "label": "Shipping Rate", "value": "Free USD" }, "shippingDestination": { "label": "Shipping Destination", "value": "US" } } } } }, "about_this_seller_section_module": { "sections": [ { "profileLogo": { "title": "best_seller_123" }, "username": "best_seller_123", "trustSignals": ["99.8% positive feedback"], "dataItems": ["best_seller_123", "99.8% positive feedback"] } ], "title": "About the seller" } } ``` Note: Some fields (e.g., long descriptions, shipping/returns details, financing messages) may be missing or simplified when not exposed on a given listing. ### FAQ #### Do I need to log in or provide cookies to use this eBay scraping tool? No. The actor works without login and does not require cookies. It collects publicly available listing and search result data. #### Can I target specific eBay countries or currencies? Yes. Use the domain parameter to choose among 17 regional eBay sites (e.g., ebay.com, ebay.co.uk, ebay.de). Prices and inventory align with the site you select. #### How do I scrape sold items or completed listings? Use the show\_only array. Set \["sold\_items"] to focus on sold results or \["completed\_items"] for completed listings. You can combine it with sort and buying\_format for precise targeting. #### How many results can I scrape in one run? Control volume with max\_pages (how deep to go) and maxItems (hard cap on rows). Results stream to your Output as they’re collected. #### How does the proxy work if I hit blocks or rate limits? When useProxy is enabled, the actor escalates automatically: starts direct, then datacenter, then residential with up to 3 residential retries, and switches to sticky residential after a successful fetch for stability. #### Can I get the full item description? Yes. Enable fetch\_description\_iframe to fetch and parse the seller’s long description when eBay exposes it via an iframe. This adds richness but can slow runs. #### Can I integrate this with my API/Python workflows? Yes. It’s an Apify actor, so you can trigger runs via the Apify API and export results. Many teams use it as an eBay data extraction tool integrated into Python ETLs and dashboards. #### What formats can I export to? Use the Apify dataset to download results as JSON, CSV, or Excel. This makes it easy to move eBay search results to CSV for analytics or to feed other systems. ### Closing CTA / Final thoughts The πŸ›’βœ¨ eBay Search Scraper is built for structured, scalable eBay marketplace data collection. With regional targeting, precise filters, deep product parsing, and smart proxy handling, it’s a dependable eBay search results scraper for marketers, developers, analysts, and researchers. Run it as your eBay search API alternative, export results to CSV/JSON/Excel, and connect it to existing automation or eBay scraper Python pipelines. Start extracting smarter eBay insights today β€” from keyword to clean dataset, at scale. # Actor input Schema ## `query` (type: `string`): Type what you want to find β€” products, brands, categories. This drives your search together with Country & filters below. β˜• Example: coffee, vintage camera, running shoes. ## `domain` (type: `string`): Which eBay storefront to search β€” prices, currency, and inventory follow the site you pick. 🌐 ## `location` (type: `string`): Roughly where items should ship β€” helps align search results with buyer / delivery context. ✈️ ## `sort` (type: `string`): How listings are ranked β€” best match, ending soon, newest, price high/low, distance, and more. πŸ“Š ## `show_only` (type: `array`): Optional shortcuts: sold βœ”οΈ, free shipping 🚚, returns ↩️, deals 🏷️, authenticity βœ“, charity ❀️, and more β€” pick what matters to you. ## `buying_format` (type: `string`): Auction πŸ”” Β· Buy It Now πŸ›οΈ Β· Accepts offers πŸ’¬ β€” focus on how the listing is sold. ## `max_pages` (type: `integer`): How many search result pages to walk β€” more pages = more candidate listings (then capped by Max listings). πŸ“š ## `maxItems` (type: `integer`): Hard cap on rows in your dataset this run β€” great for samples (small) or big sweeps (up to limit). πŸ“₯ ## `useProxy` (type: `boolean`): When on, the Actor can route traffic through Apify Proxy (configure groups below). πŸ” ## `fetch_description_iframe` (type: `boolean`): Slower ⏱️ but richer: pulls more seller description text when eBay exposes it. Great for detail-heavy listings. ## `proxyConfiguration` (type: `object`): Fine-tune Apify Proxy (groups, sessions) for your workspace β€” used when πŸ›‘οΈ Use Apify Proxy is enabled. ## Actor input object example ```json { "query": "coffee", "domain": "ebay.com", "location": "1", "sort": "12", "show_only": [], "buying_format": "BIN", "max_pages": 1, "maxItems": 20, "useProxy": true, "fetch_description_iframe": false, "proxyConfiguration": { "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 = { "query": "coffee", "show_only": [], "proxyConfiguration": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("scraper-engine/ebay-search-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 = { "query": "coffee", "show_only": [], "proxyConfiguration": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("scraper-engine/ebay-search-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 '{ "query": "coffee", "show_only": [], "proxyConfiguration": { "useApifyProxy": true } }' | apify call scraper-engine/ebay-search-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=scraper-engine/ebay-search-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "πŸ›’βœ¨ eBay Search Scraper", "description": "πŸ›’βœ¨ eBay Search Scraper pulls real-time marketplace data from eBay search results β€” titles, prices, images, sellers, ratings, shipping, condition & item specifics. πŸ“ˆ Ideal for price tracking, market research, SEO, and product monitoring. πŸ”Ž Supports keywords, filters & pagination.", "version": "0.1", "x-build-id": "ULKCDj6Jj5yq64cev" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~ebay-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-ebay-search-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/scraper-engine~ebay-search-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-ebay-search-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/scraper-engine~ebay-search-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-ebay-search-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": { "query": { "title": "πŸ”Ž Search query", "type": "string", "description": "Type what you want to find β€” products, brands, categories. This drives your search together with Country & filters below. β˜• Example: coffee, vintage camera, running shoes.", "default": "coffee" }, "domain": { "title": "🌍 Country (eBay site)", "enum": [ "ebay.com.au", "ebay.at", "ebay.ca", "ebay.fr", "ebay.de", "ebay.com.hk", "ebay.ie", "ebay.it", "ebay.com.my", "ebay.nl", "ebay.ph", "ebay.pl", "ebay.com.sg", "ebay.es", "ebay.ch", "ebay.co.uk", "ebay.com" ], "type": "string", "description": "Which eBay storefront to search β€” prices, currency, and inventory follow the site you pick. 🌐", "default": "ebay.com" }, "location": { "title": "πŸ“ Ship-to location", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "51", "52", "53", "55", "56", "57", "58", "59", "60", "61", "62", "63", "64", "65", "66", "67", "68", "69", "70", "71", "72", "73", "74", "75", "76", "77", "78", "79", "80", "81", "82", "83", "84", "85", "86", "87", "88", "89", "90", "91", "92", "93", "94", "95", "96", "99", "100", "101", "102", "104", "105", "106", "107", "108", "109", "111", "112", "113", "114", "115", "116", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166", "167", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "189", "191", "192", "193", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "207", "208", "209", "210", "211", "212", "213", "214", "215", "216", "217", "218", "219", "220", "221", "226", "227", "228", "229" ], "type": "string", "description": "Roughly where items should ship β€” helps align search results with buyer / delivery context. ✈️", "default": "1" }, "sort": { "title": "⬆️ Sort order", "enum": [ "12", "1", "10", "15", "16", "7", "3", "2" ], "type": "string", "description": "How listings are ranked β€” best match, ending soon, newest, price high/low, distance, and more. πŸ“Š", "default": "12" }, "show_only": { "title": "🏷️ Show only", "type": "array", "description": "Optional shortcuts: sold βœ”οΈ, free shipping 🚚, returns ↩️, deals 🏷️, authenticity βœ“, charity ❀️, and more β€” pick what matters to you.", "items": { "type": "string", "enum": [ "completed_items", "sold_items", "free_returns", "returns_accepted", "authorized_seller", "deals_and_savings", "sale_items", "listed_as_lots", "benefits_charity", "authenticity_guarantee", "free_shipping", "local_pickup" ], "enumTitles": [ "βœ… Completed items", "🏷️ Sold items", "↩️ Free returns", "πŸ“‹ Returns accepted", "⭐ Authorized seller", "🏷️ Deals & savings", "πŸ’Έ Sale items", "πŸ“¦ Listed as lots", "❀️ Benefits charity", "βœ“ Authenticity Guarantee", "🚚 Free shipping", "πŸ“ Local pickup" ] } }, "buying_format": { "title": "πŸ›’ Buying format", "enum": [ "Auction", "BIN", "BO" ], "type": "string", "description": "Auction πŸ”” Β· Buy It Now πŸ›οΈ Β· Accepts offers πŸ’¬ β€” focus on how the listing is sold.", "default": "BIN" }, "max_pages": { "title": "πŸ“„ Max pages to scrape", "minimum": 1, "type": "integer", "description": "How many search result pages to walk β€” more pages = more candidate listings (then capped by Max listings). πŸ“š", "default": 1 }, "maxItems": { "title": "🎯 Max listings to scrape", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on rows in your dataset this run β€” great for samples (small) or big sweeps (up to limit). πŸ“₯", "default": 20 }, "useProxy": { "title": "πŸ›‘οΈ Use Apify Proxy", "type": "boolean", "description": "When on, the Actor can route traffic through Apify Proxy (configure groups below). πŸ”", "default": true }, "fetch_description_iframe": { "title": "πŸ“œ Fetch full item description", "type": "boolean", "description": "Slower ⏱️ but richer: pulls more seller description text when eBay exposes it. Great for detail-heavy listings.", "default": false }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "Fine-tune Apify Proxy (groups, sessions) for your workspace β€” used when πŸ›‘οΈ Use Apify Proxy is enabled." } } }, "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 } } } } } } } } } } ```