> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scrapebadger.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Keyword Suggestions

> eBay keyword autocomplete suggestions for a partial query.

## Query Parameters

<ParamField query="query" type="string" required>
  Partial query prefix to autocomplete (e.g. `ninten`).
</ParamField>

<ParamField query="domain" type="string" default="com">
  eBay marketplace domain to source suggestions from.

  Examples: `com`, `co.uk`, `de`, `fr`
</ParamField>

## Response

<ResponseField name="query" type="string">The query prefix that was autocompleted.</ResponseField>
<ResponseField name="domain" type="string">Marketplace domain the suggestions came from.</ResponseField>

<ResponseField name="suggestions" type="array">
  Array of suggestion objects.

  <Expandable title="AutocompleteSuggestion object">
    <ResponseField name="value" type="string">A suggested search term.</ResponseField>
  </Expandable>
</ResponseField>

### Example Response

```json theme={null}
{
  "query": "ninten",
  "domain": "com",
  "suggestions": [
    { "value": "nintendo switch" },
    { "value": "nintendo switch oled" },
    { "value": "nintendo ds" },
    { "value": "nintendo 64" }
  ]
}
```

<Note>
  Each autocomplete request costs **1 credit**. Failed requests are not charged.
</Note>


## OpenAPI

````yaml GET /v1/ebay/autocomplete
openapi: 3.1.0
info:
  title: ScrapeBadger eBay API
  version: 1.0.0
  description: >-
    eBay marketplace scraping API for searching active and completed (sold)
    listings, fetching item details, reviews, sellers, seller listings and
    feedback, category browsing, autocomplete, and reference data across 18
    marketplaces.
servers:
  - url: https://scrapebadger.com
    description: Production
security:
  - apiKeyAuth: []
paths:
  /v1/ebay/autocomplete:
    get:
      tags:
        - eBay Search
      summary: Keyword Suggestions
      description: Return eBay keyword autocomplete suggestions.
      operationId: ebayAutocomplete
      parameters:
        - name: query
          in: query
          required: true
          schema:
            type: string
          description: Partial query prefix.
        - name: domain
          in: query
          schema:
            type: string
            default: com
          description: eBay marketplace domain TLD or alias (com, co.uk, de, fr, ...).
      responses:
        '200':
          description: Suggestions
          content:
            application/json:
              schema:
                type: object
                properties:
                  query:
                    type: string
                  domain:
                    type: string
                  suggestions:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````