# Lyst — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and browse fashion items across multiple retailers on Lyst.co.uk by brand, price, size, and gender, then view detailed product information including pricing, available sizes, and which retailers stock each item. Find exactly what you're looking for with powerful filtering and get all the details you need to make a purchase decision.

**Category:** E-commerce | **Website:** [lyst.com/](https://lyst.com/) | **Docs:** [parse.bot/marketplace/d9b2ccfb-80a2-40c0-a20d-dbc817ff0606/lyst-com-api](https://parse.bot/marketplace/d9b2ccfb-80a2-40c0-a20d-dbc817ff0606/lyst-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/lyst/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get product

Get detailed information for a specific product by its URL path. Returns full product details including description, color, available sizes with stock status, pricing from retailers, and high-resolution image URLs. The product_path is obtained from search_products results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `product_path` | string | Yes | Product URL path from search results (e.g. '/clothing/alexander-mcqueen-shirt-1872/'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/lyst/get-product \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"product_path":"<string>"}'
```

### Search products

Search for fashion products on Lyst with optional filters for price range, gender, brand, size, and sorting. Returns paginated results with product cards including pricing, designer, retailer, and availability information. Results are auto-iterated across pages. Prices are in GBP (British Pounds).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `designer_slug` | string | No | Filter by designer/brand slug (e.g. 'mcqueen-designer', 'maison-margiela', 'dries-van-noten'). Obtain slugs from search results or auto_suggest. |
| `gender` | string | No | Filter by gender. |
| `max_price` | string | No | Maximum price filter in GBP (e.g. '250' for items up to £250). |
| `min_price` | string | No | Minimum price filter in GBP (e.g. '50' for items from £50). |
| `page` | integer | No | Page number for pagination, starting at 1. |
| `query` | string | Yes | Free-text search query for products (e.g. 'Alexander McQueen shirt', 'Dries Van Noten jacket'). |
| `size` | string | No | Size filter (e.g. '17', 'XL', '15.5'). Format varies by product category. |
| `sort` | string | No | Sort order for results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/lyst/search-products \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"designer_slug":"<string>","gender":"<string>","max_price":"<string>","min_price":"<string>","page":"<integer>","query":"<string>","size":"<string>","sort":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.