# eBay Product Search API (`tropical_neighborhood/ebay`) Actor A professional-grade API tool to search for products on eBay. It fetches real-time data including price, condition, and seller info. Includes built-in affiliate link generation to maximize your earnings. Fast, stable, and official. - **URL**: https://apify.com/tropical\_neighborhood/ebay.md - **Developed by:** [tan tran](https://apify.com/tropical_neighborhood) (community) - **Categories:** E-commerce, Developer tools, Automation - **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing $1.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 ## eBay Product Search API An efficient, lightweight, and reliable tool to search for products on eBay using their **official Browse API**. Unlike web scrapers, this Actor interacts directly with eBay's backend, ensuring data accuracy and high performance. ### Features - **Official API Integration:** Direct communication with eBay's Browse API for stable data retrieval. - **Affiliate Link Generation:** Automatically injects your Campaign ID into product links, ready for affiliate tracking. - **Deep Link Support:** Generates links that can automatically trigger the eBay app on mobile devices. - **Lightweight:** No heavy browser automation (Puppeteer/Playwright) needed; extremely fast and low cost. ### How it works 1. You provide a search keyword and a result limit. 2. The Actor fetches live product data (Title, Price, Condition, Seller, Images) from eBay. 3. It generates an affiliate-ready deep link for each product found. 4. Data is stored in an Apify Dataset, ready for download (JSON, CSV, Excel). ### Input Parameters | Field | Type | Description | | :--- | :--- | :--- | | `keyword` | String | The product or term you want to search for on eBay. | | `limit` | Integer | Maximum number of products to fetch (1–200). Default: 20. | ### Required Configuration Before running this Actor, you must set the following **Environment Variables** in the Actor's **Settings -> Environment variables** tab: - `EBAY_CLIENT_ID`: Your eBay Application ID (App ID). - `EBAY_CLIENT_SECRET`: Your eBay Cert ID. - `EBAY_CAMPAIGN_ID`: Your eBay Partner Network Campaign ID. ### Output Example The Actor outputs a JSON object containing search metadata and a list of product listings: ```json { "metadata": { "keyword": "pokemon cards", "total_found": 1500, "average_price": "24.99" }, "listings": [ { "title": "Example Pokemon Card", "price": 19.99, "currency": "USD", "link": "[https://www.ebay.com/itm/...&campid=](https://www.ebay.com/itm/...&campid=)...", "image": "[https://i.ebayimg.com/](https://i.ebayimg.com/)...", "condition": "New", "seller": "top_seller_123", "item_id": "1234567890", "shipping_cost": 2.50 } ] } # Actor input Schema ## `keyword` (type: `string`): What are you looking for? ## `limit` (type: `integer`): Number of results to fetch (1-200) ## Actor input object example ```json { "keyword": "pokemon cards", "limit": 20 } ```` # 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 = { "keyword": "pokemon cards" }; // Run the Actor and wait for it to finish const run = await client.actor("tropical_neighborhood/ebay").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 = { "keyword": "pokemon cards" } # Run the Actor and wait for it to finish run = client.actor("tropical_neighborhood/ebay").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 '{ "keyword": "pokemon cards" }' | apify call tropical_neighborhood/ebay --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=tropical_neighborhood/ebay", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "eBay Product Search API", "description": "A professional-grade API tool to search for products on eBay. It fetches real-time data including price, condition, and seller info. Includes built-in affiliate link generation to maximize your earnings. Fast, stable, and official.", "version": "0.0", "x-build-id": "PA34ww5vu9jeV2ci0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tropical_neighborhood~ebay/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tropical_neighborhood-ebay", "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/tropical_neighborhood~ebay/runs": { "post": { "operationId": "runs-sync-tropical_neighborhood-ebay", "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/tropical_neighborhood~ebay/run-sync": { "post": { "operationId": "run-sync-tropical_neighborhood-ebay", "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": [ "keyword" ], "properties": { "keyword": { "title": "Keyword", "type": "string", "description": "What are you looking for?" }, "limit": { "title": "Max Items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Number of results to fetch (1-200)", "default": 20 } } }, "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 } } } } } } } } } } ```