# Ruby Lane — 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 antiques, collectibles, and jewelry listings on Ruby Lane, view detailed item information including prices and descriptions, and discover shop profiles and inventory. Find exactly what you're looking for across multiple shops or explore specific categories to compare items and sellers.

**Category:** Marketplaces | **Website:** [ruby-lane.com/](https://ruby-lane.com/) | **Docs:** [parse.bot/marketplace/ac9388f7-93d1-4262-bdcd-18c2eaa1de9a/ruby-lane-com-api](https://parse.bot/marketplace/ac9388f7-93d1-4262-bdcd-18c2eaa1de9a/ruby-lane-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/ruby-lane/`
**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

### Browse category

Browse item listings by category. Returns paginated results for the specified category with the same item structure as search. Each page returns up to 60 items.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | Yes | Category slug used in the URL path (e.g. jewelry, dolls, art, pottery-glass, furniture) |
| `page` | integer | No | Page number for pagination |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/ruby-lane/browse-category \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","page":"<integer>"}'
```

### Get item details

Retrieve full details for a single item listing by its URL. Returns structured data from the item's JSON-LD metadata including name, description, price, currency, seller, and item type/condition.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full item listing URL on rubylane.com (e.g. https://www.rubylane.com/item/1603951-05298/19-c-Rosewood-Inlaid-Mother-Pearl) |

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

### Get shop

Retrieve shop profile information including name, about description, item count, and location. The shop_slug is the hyphenated form used in shop URLs (e.g. antique-matchmaker).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `shop_slug` | string | Yes | Shop slug from the URL path (e.g. antique-matchmaker, assay-jewelers). Found in item listing shop links. |

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

### Search items

Full-text search across all Ruby Lane listings. Returns paginated item results with title, price, shop name, and image. Results default to 'Best Match' sorting. Each page returns up to 60 items.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `query` | string | Yes | Search keyword or phrase |
| `sort` | string | No | Sort order for results |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/ruby-lane/search-items \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","query":"<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.