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

# Search listings

> Search listings.

Search listings.

**Credits:** 10 per successful request. Failed requests and empty result sets are not charged.

## Authentication

<ParamField header="X-API-Key" type="string" required>Your ScrapeBadger API key.</ParamField>

## Parameters

<ParamField query="query" type="string" required>
  Query. Minimum length: 1. Maximum length: 250.
</ParamField>

<ParamField query="page" type="integer" default="1">
  Page. Minimum: 1. Maximum: 250.
</ParamField>

<ParamField query="country" type="string" default="US">
  Country.
</ParamField>

<ParamField query="currency" type="string" default="USD">
  Currency.
</ParamField>

<ParamField query="language" type="string" default="en-US">
  Language.
</ParamField>

<ParamField query="sort" type="string" default="most_relevant">
  Sort. Allowed values: `most_relevant`, `date_desc`, `price_asc`, `price_desc`.
</ParamField>

<ParamField query="min_price" type="number">
  Min price. Minimum: 0.
</ParamField>

<ParamField query="max_price" type="number">
  Max price. Minimum: 0.
</ParamField>

## Response

```json theme={null}
{
  "items": [
    {
      "listing_id": "1510223855",
      "title": "The Libby Travel Mug hand thrown ceramic mug cup Pottery Travel Mug Cup with attached lid fits in cup holder",
      "url": "https://www.etsy.com/listing/1510223855/the-libby-travel-mug-hand-thrown-ceramic",
      "description": null,
      "price": 34.99,
      "original_price": null,
      "currency": "USD",
      "availability": "https://schema.org/InStock",
      "quantity": null,
      "category": null,
      "images": [
        "https://i.etsystatic.com/8740835/r/il/d4f720/7239142492/il_fullxfull.7239142492_oym6.jpg"
      ],
      "image_details": [],
      "shop_name": "StonehousePotteryOH",
      "shop_id": "8740835",
      "shop_url": "https://www.etsy.com/shop/StonehousePotteryOH",
      "rating": 4.9,
      "review_count": 169,
      "is_ad": false,
      "shipping": null,
      "variations": [],
      "breadcrumbs": [],
      "videos": []
    }
  ],
  "total_results": 1403318,
  "locale": {
    "language": {
      "code": "en-US",
      "id": 0,
      "name": "English (US)",
      "translation": "English (US)",
      "is_detected": false,
      "is_default": true
    },
    "currency": {
      "currency_id": 840,
      "code": "USD",
      "name": "United States Dollar",
      "number_precision": 2,
      "symbol": "$",
      "listing_enabled": true,
      "browsing_enabled": true,
      "buyer_location_restricted": false,
      "is_synthetic": true,
      "is_detected": false,
      "is_default": true,
      "append_currency_symbol": false
    },
    "region": {
      "code": "US",
      "country_id": 209,
      "name": "United States",
      "translation": "United States",
      "is_detected": false,
      "is_default": true,
      "is_EU_region": false
    },
    "subdir_code": ""
  },
  "next_page": 2,
  "query": "ceramic mug",
  "page": 1
}
```

## Example

```bash theme={null}
curl --get 'https://scrapebadger.com/v1/etsy/search' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --data-urlencode 'query=ceramic mug'
```

[Browse all Etsy endpoints](/etsy/overview).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.