# eBay Keyword Suggestions (`w3crawler/ebay-keyword-suggest-scraper`) Actor

Retrieves live eBay autocomplete keyword suggestions from the public autosuggest endpoint.

- **URL**: https://apify.com/w3crawler/ebay-keyword-suggest-scraper.md
- **Developed by:** [w3crawler](https://apify.com/w3crawler) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.99 / 1,000 keyword suggestions

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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

### eBay Keyword Suggestions

This Actor requests live public eBay autocomplete suggestions from the official `autosug.ebaystatic.com` endpoint. It normalizes duplicate suggestions, assigns a one-based rank, and records the query prefix and eBay site ID used for the request. It does not log in, call private APIs, or infer search terms that the public endpoint did not return.

### Input

`query` is a required-in-practice non-empty seed term with a maximum length of 200 characters; it defaults to `phone`. `siteId` is the public eBay site identifier and defaults to `0` (US). `maxItems` bounds suggestions, `timeoutMs` bounds each request, and `maxRetries` permits bounded retries only for transient/network failures. Unknown fields and malformed types fail before the request.

```json
{
  "query": "phone",
  "siteId": "0",
  "maxItems": 10,
  "timeoutMs": 60000,
  "maxRetries": 1
}
```

### Output

Normal rows contain `url`, `searchUrl`, `scrapedAt`, `prefix`, `suggestion`, `rank`, and `siteId`. Empty or duplicate suggestions are omitted. An empty successful response leaves the dataset empty and reports `NO_SUGGESTIONS`; request failures leave it empty, store bounded diagnostics in `OUTPUT`, and fail the run. You can download the dataset in various formats such as JSON, HTML, CSV, or Excel.

### Limitations

Autocomplete results are dynamic and can vary by site ID, locale, request time, and eBay availability. A successful HTTP response with no suggestion list is not converted into fabricated data. Respect eBay's terms, rate limits, and applicable law.

### Local validation

```text
npm ci
npm run check
npm test
npx --yes apify validate-schema
APIFY_LOCAL_STORAGE_DIR=qa-storage npx --yes apify run --no-purge --entrypoint src/main.js --input-file test/inputs/default.json
```

The dataset sanitizer and schema validator scope output to suggestion business fields only. Existing Actor-local storage is not purged by these commands.

# Actor input Schema

## `query` (type: `string`):

Partial eBay search term for autocomplete suggestions.

## `siteId` (type: `string`):

Public autosuggest site identifier. The default 0 is eBay US.

## `maxItems` (type: `integer`):

Maximum suggestions to emit.

## `timeoutMs` (type: `integer`):

Maximum time for the public autocomplete request in milliseconds.

## `maxRetries` (type: `integer`):

Bounded retries for transient autocomplete failures.

## Actor input object example

```json
{
  "query": "phone",
  "siteId": "0",
  "maxItems": 10,
  "timeoutMs": 60000,
  "maxRetries": 1
}
```

# Actor output Schema

## `dataset` (type: `string`):

No description

## `runSummary` (type: `string`):

No description

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("w3crawler/ebay-keyword-suggest-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("w3crawler/ebay-keyword-suggest-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call w3crawler/ebay-keyword-suggest-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,w3crawler/ebay-keyword-suggest-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/hFewL1aonAnc3dDCY/builds/tgrdwaVa4XEvcagtY/openapi.json