eBay Autocomplete API Documentation

GET   /api/v1/search?engine=ebay_autocomplete

The eBay Autocomplete API returns the suggestions eBay's search box shows while a keyword is being typed, in the order eBay shows them, on any of 16 eBay sites. Pass a query or product row's value as the q of the eBay Search API to run that search. For store, shortcut and help rows, open the row's link.

API Parameters

Search Query

  • Name
    q
    Required
    Required
    Description

    The partial or full keyword to autocomplete (e.g. nike). Returns the suggestions eBay's search box shows for that text, in the order eBay shows them. Up to 200 characters, with at least one letter or number. eBay refuses some text that reads like code, such as SQL or script fragments, and such a query answers with an error that names it instead of suggestions. Pass any suggestion's value as the q of the eBay Search API to run that search.

Localization

  • Name
    ebay_domain
    Required
    Optional
    Description

    The eBay site whose search box the suggestions come from. Check the full list of supported eBay domains, except ebay.com.hk, ebay.com.my, ebay.com.sg, where eBay offers no search suggestions. Default: ebay.com.

Engine

  • Name
    engine
    Required
    Required
    Description

    Parameter defines an engine that will be used to retrieve real-time data. It must be set to ebay_autocomplete.

API key

  • Name
    api_key
    Required
    Required
    Description

    The api_key authenticates your requests. Use it as a query parameter (https://www.searchapi.io/api/v1/search?api_key=YOUR_API_KEY) or in the Authorization header (Bearer YOUR_API_KEY).

Zero Data Retention

  • Name
    zero_retention
    Enterprise Only
    Enterprise Only
    Required
    Optional
    Description

    Set this parameter to true to disable all logging and persistent storage. No request parameters, HTML, or JSON responses are stored or logged. Suitable for high-compliance use cases. Debugging and support may be limited while enabled.

API Examples

Suggestions

Suggestions

Each suggestion carries its position in the search box, its type, its value and the link eBay opens for it. Most are query suggestions, and the first one usually carries the categories eBay offers to search it in, each with the category_id of the eBay Search API. For some keywords eBay also suggests catalog products: a product carries, when available, its catalog product_id (ePID), its category_id and a thumbnail, and its link searches the listings of that product. A shortcut opens an eBay page, such as a brand's page, with a title when eBay shows one.

GET
https://www.searchapi.io/api/v1/search?engine=ebay_autocomplete&q=nike
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "ebay_autocomplete",
  "q": "nike"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "search_metadata": {
    "id": "search_262eE7mbKJIVmVpHSnBAUXVs",
    "status": "Success",
    "created_at": "2026-11-12T13:26:12Z",
    "request_time_taken": 1.13,
    "parsing_time_taken": 0.0,
    "total_time_taken": 1.14,
    "request_url": "https://www.ebay.com/sch/i.html?_nkw=nike",
    "html_url": "https://www.searchapi.io/api/v1/searches/search_262eE7mbKJIVmVpHSnBAUXVs.html",
    "json_url": "https://www.searchapi.io/api/v1/searches/search_262eE7mbKJIVmVpHSnBAUXVs"
  },
  "search_parameters": {
    "engine": "ebay_autocomplete",
    "q": "nike",
    "ebay_domain": "ebay.com"
  },
  "search_information": {
    "query_displayed": "nike"
  },
  "suggestions": [
    {
      "position": 1,
      "type": "query",
      "value": "nike air force 1",
      "link": "https://www.ebay.com/sch/i.html?_nkw=nike+air+force+1",
      "categories": [
        {
          "name": "Men's Shoes",
          "category_id": "93427",
          "link": "https://www.ebay.com/sch/93427/i.html?_nkw=nike+air+force+1"
        },
        {
          "name": "Women's Shoes",
          "category_id": "3034",
          "link": "https://www.ebay.com/sch/3034/i.html?_nkw=nike+air+force+1"
        }
      ]
    },
    {
      "position": 2,
      "type": "query",
      "value": "nike air max",
      "link": "https://www.ebay.com/sch/i.html?_nkw=nike+air+max"
    },
    {
      "position": 6,
      "type": "product",
      "value": "Nike Air Force 1 '07 Low Triple White",
      "product_id": "28053397901",
      "category_id": "15709",
      "link": "https://www.ebay.com/sch/i.html?_nkw=Nike+Air+Force+1+%2707+Low+Triple+White&_productIdType=ms&_prod...",
      "thumbnail": "https://i.ebayimg.com/00/s/MzQ3WDc1MA==/z/pC0AAOSw8o9nZ~-~/$_32.JPG"
    },
    {
      "position": 10,
      "type": "shortcut",
      "value": "Nike",
      "title": "Explore Nike",
      "link": "https://www.ebay.com/b/Nike/bn_21831651",
      "thumbnail": "https://i.ebayimg.com/images/g/nsoAAeSwu6hn6uXe/s-l200.png"
    },
    "..."
  ]
}

Help, Shortcut and Store Suggestions

Help, Shortcut and Store Suggestions

Below the queries and products, eBay's search box can add a help suggestion that opens eBay's customer service search, a shortcut to an eBay page such as eBay Gift Cards or eBay Live, and up to two eBay Stores. A store carries the link to its store page and, when available, its store_id. eBay shows the customer service search for a help link opened from one of its own pages, and its Customer Service home for one opened anywhere else.

GET
https://www.searchapi.io/api/v1/search?engine=ebay_autocomplete&q=gift+card
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "ebay_autocomplete",
  "q": "gift card"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "search_metadata": {
    "id": "search_X1g6Kjbtbfn2aHZXZBBNYfi4",
    "status": "Success",
    "created_at": "2026-11-12T13:26:15Z",
    "request_time_taken": 1.18,
    "parsing_time_taken": 0.01,
    "total_time_taken": 1.19,
    "request_url": "https://www.ebay.com/sch/i.html?_nkw=gift+card",
    "html_url": "https://www.searchapi.io/api/v1/searches/search_X1g6Kjbtbfn2aHZXZBBNYfi4.html",
    "json_url": "https://www.searchapi.io/api/v1/searches/search_X1g6Kjbtbfn2aHZXZBBNYfi4"
  },
  "search_parameters": {
    "engine": "ebay_autocomplete",
    "q": "gift card",
    "ebay_domain": "ebay.com"
  },
  "search_information": {
    "query_displayed": "gift card"
  },
  "suggestions": [
    {
      "position": 1,
      "type": "query",
      "value": "gift card ebay",
      "link": "https://www.ebay.com/sch/i.html?_nkw=gift+card+ebay",
      "categories": [
        {
          "name": "Collectible Advertising",
          "category_id": "34",
          "link": "https://www.ebay.com/sch/34/i.html?_nkw=gift+card+ebay"
        },
        {
          "name": "Prepaid Gaming Cards",
          "category_id": "156597",
          "link": "https://www.ebay.com/sch/156597/i.html?_nkw=gift+card+ebay"
        }
      ]
    },
    {
      "position": 11,
      "type": "help",
      "value": "gift card balance",
      "link": "https://www.ebay.com/help/sr?query=gift+card+balance"
    },
    {
      "position": 12,
      "type": "shortcut",
      "value": "eBay Gift Card",
      "link": "https://www.ebay.com/giftcards",
      "thumbnail": "https://i.ebayimg.com/images/g/Va0AAOSwfVxld1qq/s-l200.png"
    },
    {
      "position": 13,
      "type": "store",
      "value": "Gift Card Bonanza",
      "store_id": "38902611",
      "link": "https://www.ebay.com/str/giftcardbonanza",
      "thumbnail": "https://i.ebayimg.com/images/g/1tIAAOSweM5kSqsu/s-l200.jpg"
    },
    "..."
  ]
}

Localization

Localization

With ebay_domain set, the suggestions are the ones that site's search box shows, in its language and with its own categories and stores, and every link opens on that site.

GET
https://www.searchapi.io/api/v1/search?ebay_domain=ebay.de&engine=ebay_autocomplete&q=fahrrad
Request
import requests

url = "https://www.searchapi.io/api/v1/search"
params = {
  "engine": "ebay_autocomplete",
  "q": "fahrrad",
  "ebay_domain": "ebay.de"
}

response = requests.get(url, params=params)
print(response.text)
Response
{
  "search_metadata": {
    "id": "search_LMgIak6Os3N0iBfHcZFhEIGY",
    "status": "Success",
    "created_at": "2026-11-12T13:26:18Z",
    "request_time_taken": 1.1,
    "parsing_time_taken": 0.0,
    "total_time_taken": 1.1,
    "request_url": "https://www.ebay.de/sch/i.html?_nkw=fahrrad",
    "html_url": "https://www.searchapi.io/api/v1/searches/search_LMgIak6Os3N0iBfHcZFhEIGY.html",
    "json_url": "https://www.searchapi.io/api/v1/searches/search_LMgIak6Os3N0iBfHcZFhEIGY"
  },
  "search_parameters": {
    "engine": "ebay_autocomplete",
    "q": "fahrrad",
    "ebay_domain": "ebay.de"
  },
  "search_information": {
    "query_displayed": "fahrrad"
  },
  "suggestions": [
    {
      "position": 1,
      "type": "query",
      "value": "fahrradlicht",
      "link": "https://www.ebay.de/sch/i.html?_nkw=fahrradlicht",
      "categories": [
        {
          "name": "Radsport-Artikel",
          "category_id": "7294",
          "link": "https://www.ebay.de/sch/7294/i.html?_nkw=fahrradlicht"
        },
        {
          "name": "Funsport-Artikel",
          "category_id": "13368",
          "link": "https://www.ebay.de/sch/13368/i.html?_nkw=fahrradlicht"
        }
      ]
    },
    {
      "position": 2,
      "type": "query",
      "value": "fahrradträger anhängerkupplung",
      "link": "https://www.ebay.de/sch/i.html?_nkw=fahrradtr%C3%A4ger+anh%C3%A4ngerkupplung"
    },
    {
      "position": 12,
      "type": "store",
      "value": "Fahrradhaus-Berger",
      "store_id": "14787617",
      "link": "https://www.ebay.de/str/fahrradhausberger",
      "thumbnail": "https://i.ebayimg.com/images/g/1tIAAOSweM5kSqsu/s-l200.jpg"
    },
    "..."
  ]
}