# Scan — 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 compare computer hardware and tech products from Scan.co.uk. Access detailed product specifications, pricing in GBP, stock availability, customer reviews, and daily special offers across all categories including GPUs, CPUs, storage, peripherals, and more.

**Category:** E-commerce | **Website:** [scan.co.uk/](https://scan.co.uk/) | **Docs:** [parse.bot/marketplace/c4393807-001b-4221-953d-2d9a21bad0e5/scan-co-uk-api](https://parse.bot/marketplace/c4393807-001b-4221-953d-2d9a21bad0e5/scan-co-uk-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/scan/`
**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 category listings

Retrieve product listings for a specific category and subcategory. Both are required. Category paths follow the site's URL structure. Returns all products in the subcategory with name, price, manufacturer, stock status, and LN code.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | Yes | Top-level category slug (e.g. 'computer-hardware', 'gaming-and-sims') |
| `subcategory` | string | Yes | Subcategory slug (e.g. 'gpu-nvidia-gaming', 'gpu-amd-gaming') |

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

### Get product details

Retrieve comprehensive details for a product including full specifications and pricing. Resolves LN codes via search, then parses the product page. Returns title, formatted price, specifications map, stock status, and URL.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `product_id` | string | Yes | LN code (e.g. '155343') or product URL slug |

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

### Get product reviews

Retrieve customer reviews and ratings for a specific product via Bazaarvoice. Returns product_info (array of product metadata with aggregate ReviewStatistics) and reviews (array of individual reviews with Rating, Title, ReviewText, and UserNickname).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ln_code` | string | Yes | Product LN code (e.g. '155343') |

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

### Get today only offers

Retrieve the daily limited-time 'Today Only' offers from Scan.co.uk. Returns current day's special deals with product name, price, LN code, and URL. The offers rotate daily; an empty list is valid when no offers are active.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/scan/get-today-only-offers \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Search products

Full-text search over Scan.co.uk product catalog. Returns products ranked by relevance with name, price, stock status, and URL. Queries match product titles and LN codes. Results are capped by `limit`; the `total` field reports the full match count upstream.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of product results to return. |
| `query` | string | Yes | Search keyword or LN code (e.g. 'RTX 4070', 'gaming mouse', 'SSD') |

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