# Caratlane — 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 for jewelry products, browse category listings, and retrieve detailed product information from Caratlane's catalog along with featured homepage items. Access real-time jewelry data including pricing, specifications, and availability across their complete collection.

**Category:** E-commerce | **Website:** [caratlane.com/](https://caratlane.com/) | **Docs:** [parse.bot/marketplace/fdd630dc-816e-477f-b5d8-d3161795183a/caratlane-com-api](https://parse.bot/marketplace/fdd630dc-816e-477f-b5d8-d3161795183a/caratlane-com-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-caratlane-com-api-fdd630dc/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_category_listings

Retrieve product listings for a specific jewellery category. Returns the same paginated product-summary shape as search. Category slugs correspond to site navigation sections.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | Yes | Category slug (e.g. 'rings', 'earrings', 'necklaces-pendants', 'bangles-bracelets'). |
| `limit` | integer | No | Maximum number of products to return per page. |
| `offset` | integer | No | Results offset for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-caratlane-com-api-fdd630dc/get_category_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","limit":"<integer>","offset":"<integer>"}'
```

### get_homepage_featured

Retrieve featured collections, promotional banners, and editorial sections from the Caratlane homepage. Returns an array of section objects, each with a title, section type, and nested banner items containing images and destination links.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-caratlane-com-api-fdd630dc/get_homepage_featured \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_product_detail

Fetch full details for a single product including pricing, material composition, media gallery, and review summary. The product is identified by its relative URL path obtained from search or category listing results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `product_url` | string | Yes | Relative product URL path from search_products or get_category_listings results (e.g. '/jewellery/shimmering-quad-diamond-ring-jr07855-1ys300.html'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-caratlane-com-api-fdd630dc/get_product_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product_url":"<string>"}'
```

### search_products

Full-text search across Caratlane's jewellery catalogue. Returns paginated product summaries including pricing, media gallery URLs, and material/metal details. Pagination via offset; each page returns up to `limit` items.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of products to return per page. |
| `offset` | integer | No | Results offset for pagination. |
| `query` | string | Yes | Search keyword (e.g. 'diamond ring', 'earrings', 'gold necklace'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-caratlane-com-api-fdd630dc/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>","query":"<string>"}'
```