> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/etsy/shop/listings/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/etsy/shop/listings/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 1112 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# List Etsy shop listings (https://www.socialfetch.dev/docs/api/v1/etsy/shop/listings/get)

## Summary

List an Etsy shop's active listings, 36 a page in the order you choose, with the shop's rating, sales, location and owners.

**Tags:** `Etsy`

## HTTP

- **Method:** GET
- **Path:** `/v1/etsy/shop/listings`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.etsy.listShopListings({ shop: "PlanetJune", sort: "newest" })`
- **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore`
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- 1 credit
- Failed requests are free
- A not-found answer is still charged

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `shop` (query)

- **Required:** yes
- **Constraints:** type `string`
- **Description:** Etsy shop name, e.g. `PlanetJune`: the last part of the shop's address. A shop URL such as https://www.etsy.com/shop/PlanetJune is also accepted. Not case-sensitive.

### `sort` (query)

- **Required:** no
- **Constraints:** type `string`; enum: custom, newest, price_asc, price_desc
- **Description:** Order: `custom` (the shop's own order), `newest`, `price_asc` or `price_desc`. Omit for the shop's default order.

### `cursor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 256; pattern: `^[A-Za-z0-9_-]+$`
- **Description:** Pass `page.nextCursor` from the previous response to get the next page. Omit it for the first page.

## Pagination

This endpoint uses **cursor-based pagination** via the `cursor` query parameter.

- Read **hasMore** from `data.page.hasMore`.
- When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string).
- Omit `cursor` on the **first** request.
- Stop when **hasMore** is `false` or **nextCursor** is null (end of list).

## Responses (status codes)

- **200**: The shop and one page of its listings, or `not_found`.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

The shop and one page of its listings, or `not_found`.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the item was found. `not_found` covers an id or name that doesn't exist and a listing or shop that was removed or closed (Etsy doesn't tell those apart).
  - **shopName** (required) — type `string`. The shop asked for.
  - **shop** (required) — type `object`; nullable. The shop when found; otherwise null.
    - **shopId** (required) — type `string`; nullable. Numeric shop id, e.g. `5158258`.
    - **name** (required) — type `string`. Shop name, e.g. `PlanetJune`.
    - **url** (required) — type `string`. The shop's Etsy address.
    - **headline** (required) — type `string`; nullable. The shop's one-line headline, as its page shows it.
    - **location** (required) — type `string`; nullable. Where the shop is, e.g. `Waterloo, Canada`.
    - **logoUrl** (required) — type `string`; nullable. The shop's icon.
    - **bannerUrl** (required) — type `string`; nullable. The shop's banner picture.
    - **owners** (required) — type `array`. Names of the people the shop lists as running it.
      - _items:_
        - type `string`
    - **rating** (required) — type `number`; minimum: 0; maximum: 5; nullable. Average review rating across the shop, 0 to 5.
    - **reviewCount** (required) — type `integer`; minimum: 0; nullable. How many reviews the shop has.
    - **salesCount** (required) — type `integer`; minimum: 0; nullable. How many sales the shop page shows, when it shows them.
  - **listings** (required) — type `array`. The shop's active listings on this page, in the order asked for; empty past the last page or for a shop with none.
    - _items:_
      - **listingId** (required) — type `string`. Listing id: pass it to the listing endpoints.
      - **title** (required) — type `string`. Listing title.
      - **url** (required) — type `string`. The listing's Etsy address, without tracking parameters, e.g. `https://www.etsy.com/listing/1136507412/opal-inlay-huggie-earrings-set-by`.
      - **imageUrl** (required) — type `string`; nullable. Main picture, full size.
      - **price** (required) — type `number`; minimum: 0; nullable. Price as shown, in `currency`, e.g. `26.25`: the sale price when the listing is on sale.
      - **originalPrice** (required) — type `number`; minimum: 0; nullable. Price before the sale, when the listing is on sale; otherwise null.
      - **currency** (required) — type `string`; nullable. ISO 4217 currency code of the prices, e.g. `USD`.
      - **shopId** (required) — type `string`; nullable. Numeric id of the shop selling it, e.g. `10204022`.
      - **shopName** (required) — type `string`; nullable. Name of the shop selling it, e.g. `CaitlynMinimalist`; null where the list doesn't show it (similar listings).
      - **isAd** (required) — type `boolean`. Whether Etsy shows the listing as an ad (a seller paid for the spot). Always false in a shop's own listings.
      - **freeShipping** (required) — type `boolean`. Whether the list shows free shipping to the US for it.
  - **page** (required) — type `object`. Pagination state for the current page.
    - **page** (required) — type `integer`; minimum: 0. This page's number, from 1.
    - **hasMore** (required) — type `boolean`. Whether another page is available.
    - **nextCursor** (required) — type `string`; nullable. Pass as `cursor` to get the next page; null on the last page.
    - **totalListings** (required) — type `integer`; minimum: 0; nullable. How many listings the whole list has, as Etsy counts them.
  - **truncated** (required) — type `boolean`. Whether the list stops before the shop's last listing: true on page 100 of a longer catalogue (`page.totalListings` has the full count).
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **stale** (optional) — type `boolean`; enum: true. Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.
  - **fetchedAt** (optional) — type `string`. When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "shopName": "PlanetJune",
    "shop": {
      "shopId": "5158258",
      "name": "PlanetJune",
      "url": "https://www.etsy.com/shop/PlanetJune",
      "headline": "Amigurumi crochet patterns: cute, realistic, beautiful!",
      "location": "Waterloo, Canada",
      "logoUrl": "https://i.etsystatic.com/5158258/r/isla/4e9113/16380085/isla_500x500.16380085_hrybcvoa.jpg",
      "bannerUrl": "https://i.etsystatic.com/5158258/r/isbl/2da79d/18559748/isbl_fullxfull.18559748_5crkmfmf.jpg",
      "owners": [
        "June Gilbank"
      ],
      "rating": 4.9,
      "reviewCount": 5775,
      "salesCount": 35135
    },
    "listings": [
      {
        "listingId": "1808543786",
        "title": "Lip Balm Holder CROCHET PATTERN digital PDF file download",
        "url": "https://www.etsy.com/listing/1808543786/lip-balm-holder-crochet-pattern-digital",
        "imageUrl": "https://i.etsystatic.com/5158258/r/il/9fbaca/6414028208/il_800x800.6414028208_ib9r.jpg",
        "price": 3.66,
        "originalPrice": null,
        "currency": "USD",
        "shopId": "5158258",
        "shopName": "PlanetJune",
        "isAd": false,
        "freeShipping": true
      }
    ],
    "page": {
      "page": 1,
      "hasMore": true,
      "nextCursor": "eyJ2IjoxLCJwYWdlIjoyLCJzb3J0IjpudWxsfQ",
      "totalListings": 262
    },
    "truncated": false
  },
  "meta": {
    "requestId": "req_01example_v1_etsy_shop_listings",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.etsy.listShopListings({
  shop: "PlanetJune",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/etsy/shop/listings?shop=PlanetJune",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/etsy/shop/listings?shop=PlanetJune" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/etsy/shop/listings?shop=PlanetJune",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```

### Example: next page (pagination)

After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string):

```javascript
const previous = await response.json();
const nextCursor = previous?.data?.page?.nextCursor;
const hasMore = previous?.data?.page?.hasMore;
if (!hasMore || nextCursor == null) {
  // no more pages
} else {
  const nextUrl = new URL("https://api.socialfetch.dev/v1/etsy/shop/listings");
  nextUrl.searchParams.set("cursor", nextCursor);
  // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest");
  const nextResponse = await fetch(nextUrl.toString(), {
    headers: { "x-api-key": "YOUR_API_KEY" },
  });
  const nextData = await nextResponse.json();
}
```