# 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. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-scan-co-uk-api-c4393807/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## 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/parse-scan-co-uk-api-c4393807/get_category_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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/parse-scan-co-uk-api-c4393807/get_product_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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/parse-scan-co-uk-api-c4393807/get_product_reviews \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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/parse-scan-co-uk-api-c4393807/get_today_only_offers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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/parse-scan-co-uk-api-c4393807/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","query":"<string>"}'
```