# Clean Origin — 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 Clean Origin's diamonds, engagement rings, and jewelry collections while viewing detailed product information and customer reviews. Find exactly what you're looking for by exploring specific subcategories and comparing diamonds and rings based on their detailed specs.

**Category:** E-commerce | **Website:** [cleanorigin.com/](https://cleanorigin.com/) | **Docs:** [parse.bot/marketplace/3d7fec0b-8f55-432c-a9a6-0ec3bb0923d4/cleanorigin-com-api](https://parse.bot/marketplace/3d7fec0b-8f55-432c-a9a6-0ec3bb0923d4/cleanorigin-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-cleanorigin-com-api-3d7fec0b/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_diamond_detail

Retrieve full details of a single diamond by its URL slug, including specifications, images, and pricing. The slug is the path segment after /diamonds/ in the diamond URL, or the full diamond URL.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Diamond URL slug (e.g. emerald-lab-grown-diamond-6baf1df6a645) or full diamond URL |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cleanorigin-com-api-3d7fec0b/get_diamond_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>"}'
```

### get_engagement_ring_subcategories

List available engagement ring subcategories with their names and URL paths. Returns a static list of category options for navigating the engagement ring catalog.

**Estimated cost:** Metered

_No parameters required._

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

### get_jewelry_subcategories

List available jewelry subcategories with their names and URL paths. Returns a static list of category options for navigating the jewelry catalog.

**Estimated cost:** Metered

_No parameters required._

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

### get_product_detail

Retrieve full details for an engagement ring, wedding ring, or jewelry item by URL slug, including specifications, images, and pricing. The slug is the category and product path segment.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | Product URL slug including category path (e.g. engagement/kendall-ring-ajr04662-e) |

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

### get_product_reviews

Retrieve customer reviews from Yotpo for the site or a specific product. Returns paginated reviews with ratings, user information, and review content. Omitting the SKU returns site-wide reviews.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of reviews per page |
| `page` | integer | No | Page number for pagination |
| `sku` | string | No | Product SKU for product-specific reviews. Omitting returns site-wide reviews. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cleanorigin-com-api-3d7fec0b/get_product_reviews \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","page":"<integer>","sku":"<string>"}'
```

### search_diamonds

Search and filter lab-grown diamonds with support for shape, carat, price, color, clarity, and pagination. Returns up to 40 results per page. Server-side filtering covers shape, carat range, price range, color, clarity, cut grade, and creation method. Results are paginated; each DiamondSummary exposes a navigation op to fetch full Diamond details.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `clarity` | string | No | Clarity grade filter, comma-separated for multiple values (e.g. VS1,VS2,SI1) |
| `color` | string | No | Color grade filter, comma-separated for multiple values (e.g. D,E,F) |
| `creation_method` | string | No | Filter by creation method: Lab or Natural. Omitting defaults to Lab. |
| `cut` | string | No | Cut grade filter, comma-separated for multiple values |
| `max_carat` | number | No | Maximum carat weight |
| `max_price` | number | No | Maximum price in USD |
| `min_carat` | number | No | Minimum carat weight |
| `min_price` | number | No | Minimum price in USD |
| `page` | integer | No | Page number for pagination |
| `shape` | string | No | Diamond shape filter |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cleanorigin-com-api-3d7fec0b/search_diamonds \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"clarity":"<string>","color":"<string>","creation_method":"<string>","cut":"<string>","max_carat":"<number>","max_price":"<number>","min_carat":"<number>","min_price":"<number>","page":"<integer>","shape":"<string>"}'
```

### search_engagement_rings

Search and filter engagement ring settings. Returns up to 40 results per page with product summaries including name, price, image, and tags. Server-side filtering covers metal type, style, and price range.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `max_price` | number | No | Maximum price in USD |
| `metal` | string | No | Metal type filter, comma-separated for multiple values. Accepted values: 14K White Gold, 14K Rose Gold, 14K Yellow Gold, 18K White Gold, 18K Rose Gold, 18K Yellow Gold, Platinum. |
| `min_price` | number | No | Minimum price in USD |
| `page` | integer | No | Page number for pagination |
| `sort` | string | No | Sort order for results |
| `style` | string | No | Ring style filter, comma-separated for multiple values |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-cleanorigin-com-api-3d7fec0b/search_engagement_rings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"max_price":"<number>","metal":"<string>","min_price":"<number>","page":"<integer>","sort":"<string>","style":"<string>"}'
```