# Etsy API by APISH (`apish/etsy-api`) Actor

Etsy data as clean JSON via APISH: Etsy listing, Etsy search, Etsy shop and 1 more endpoints. Pay per credit; failed calls are free.

- **URL**: https://apify.com/apish/etsy-api.md
- **Developed by:** [APISH](https://apify.com/apish) (community)
- **Categories:** E-commerce
- **Security:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$4.00 / 1,000 credits

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

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

## Etsy API by APISH

Get public Etsy data as clean, consistent JSON: etsy listing, etsy search, etsy shop, etsy shop reviews. 4 endpoints, one response shape, numbers parsed, absolute URLs.

### How to use

1. Pick an **Endpoint**. Each option shows what it returns and its price in credits.
2. Enter its **Parameters** as JSON, for example `{"q":"ceramic mug"}`. All parameters are listed below.
3. Run. Each call becomes one row in the dataset. Use **Batch** to run the same endpoint for many inputs and **Pages per input** to follow pagination.

### Pricing

Pay per event: you pay per APISH credit the call used. The price of each endpoint is in the table below. Calls that fail on our side (server errors, timeouts, blocks) are free.

### Endpoints

| Endpoint | Returns | Required parameters | Credits |
|---|---|---|---|
| `/etsy/v1/listing` | Etsy listing | — | 1 |
| `/etsy/v1/search` | Etsy search | `q` | 1 |
| `/etsy/v1/shop` | Etsy shop | — | 1 |
| `/etsy/v1/shop_reviews` | Etsy shop reviews | — | 1 |

### Output

Each dataset row has `endpoint`, `params`, `status`, `credits_used` and the endpoint's data. Add `"raw": 1` to the parameters to also get the site's original record, or `"fields": "a,b.c"` to return only the fields you need.

### Endpoint details

#### Etsy listing

Endpoint `/etsy/v1/listing` · 1 credit per successful call.

One listing: price, availability and quantity, rating and reviews, shop, description, category path, favorites, ships-from, shipping rate, returns, variations with their options and all images.

Parameters:

- `url`: The listing URL (https://www.etsy.com/listing/...).
- `id`: The listing id instead of `url`.

#### Etsy search

Endpoint `/etsy/v1/search` · 1 credit per successful call.

Listings for a query on etsy.com with sort, price range, free shipping, on sale, Star Seller, customizable, ship-to country and shop location filters. Etsy renders the first dozen cards of a page with full details (`listings`); `listing_ids` lists every result on the page (48) in rank order, and any of them can be passed to /etsy/v1/listing. Pass `next_page` back as `page`.

Parameters:

- `q` (required): Search terms.
- `page`: Page number. Pass `next_page` from the previous response.
- `sort` — one of `relevance`, `price_asc`, `price_desc`, `newest`, `reviews`: relevance (default), price_asc, price_desc, newest, reviews.
- `min_price`: Minimum price, USD.
- `max_price`: Maximum price, USD.
- `free_shipping`: 1 for free shipping only.
- `on_sale`: 1 for discounted listings only.
- `star_seller`: 1 for Star Seller shops only.
- `customizable`: 1 for customizable listings only.
- `ship_to`: Ship-to country code.
- `location`: Shop location (city, state or country).

Example parameters: `{"q":"ceramic mug"}`

#### Etsy shop

Endpoint `/etsy/v1/shop` · 1 credit per successful call.

A shop's profile: title, description, location, rating and review count, sales, admirers, year joined, Star Seller status, item count, announcement, and one page of its listings (about 36 per page). Pass `next_page` back as `page` for the next page; it is null on the last page.

Parameters:

- `name`: The shop name.
- `url`: The shop URL instead of `name`.
- `page`: Listings page (1 = first). Pass `next_page` back here.
- `sort` — one of `custom`, `newest`, `price_asc`, `price_desc`: Listing order: `custom` (the shop's own order, default), `newest`, `price_asc` or `price_desc`.

#### Etsy shop reviews

Endpoint `/etsy/v1/shop_reviews` · 1 credit per successful call.

A shop's buyer reviews, newest first, one page at a time: reviewer, date, stars, review text, buyer photos, the reviewed listing and the seller's reply, plus the shop's total review count. Pass `next_page` back as `page` for the next page; it is null on the last page.

Parameters:

- `name`: The shop name.
- `url`: The shop URL instead of `name`.
- `page`: Reviews page (1 = newest). Pass `next_page` back here.

### Support

Questions, bugs or a missing field? Open an issue in this Actor's Issues tab and we will reply there.

Public data only: nothing behind a login. You are responsible for how you use the data you collect.

# Actor input Schema

## `endpoint` (type: `string`):

Which Etsy endpoint to call. Each option shows what it returns and its price in credits.

## `params` (type: `object`):

Query parameters for the endpoint, as JSON. See the README for every endpoint's parameters. Example: {"q":"ceramic mug"}

## `batch` (type: `array`):

Run the same endpoint for many inputs: a list of parameter objects. Each item is one call. Leave empty to use Parameters.

## `maxPages` (type: `integer`):

For paginated endpoints: follow next_cursor up to this many pages per input. 1 = first page only.

## Actor input object example

```json
{
  "endpoint": "/etsy/v1/search",
  "params": {
    "q": "ceramic mug"
  },
  "batch": [],
  "maxPages": 1
}
```

# Actor output Schema

## `results` (type: `string`):

One row per call: endpoint, params, status, credits_used and the data.

# 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 = {
    "endpoint": "/etsy/v1/search",
    "params": {
        "q": "ceramic mug"
    },
    "batch": []
};

// Run the Actor and wait for it to finish
const run = await client.actor("apish/etsy-api").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 = {
    "endpoint": "/etsy/v1/search",
    "params": { "q": "ceramic mug" },
    "batch": [],
}

# Run the Actor and wait for it to finish
run = client.actor("apish/etsy-api").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 '{
  "endpoint": "/etsy/v1/search",
  "params": {
    "q": "ceramic mug"
  },
  "batch": []
}' |
apify call apish/etsy-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,apish/etsy-api"
        }
    }
}
```

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/CUgPlcxYMzzswJIhN/builds/YWrUvrc9zvB00ZKJX/openapi.json