# Catalog Onliner — 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 products from Onliner.by's catalog with access to real-time prices, detailed product information, customer reviews, and historical price trends. Browse categories, get autocomplete suggestions, and view all available offers for any product to make informed purchasing decisions.

**Category:** E-commerce | **Website:** [catalog.onliner.by/](https://catalog.onliner.by/) | **Docs:** [parse.bot/marketplace/b3919ac2-9fe3-46ee-9328-e4e687212c12/catalog-onliner-by-api](https://parse.bot/marketplace/b3919ac2-9fe3-46ee-9328-e4e687212c12/catalog-onliner-by-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-catalog-onliner-by-api-b3919ac2/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_category_products

List products in a specific catalog category. Returns paginated product listings sorted by popularity within the category. Categories are identified by their slug key (e.g. 'mobile', 'notebook', 'tv', 'videocard').

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_key` | string | Yes | Category identifier key (e.g. 'mobile', 'notebook', 'tv', 'videocard'). |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-catalog-onliner-by-api-b3919ac2/get_category_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_key":"<string>","page":"<integer>"}'
```

### get_product

Fetch full details for a single product by its unique key. Returns specifications summary, pricing range, review stats, manufacturer legal info, and forum links. The key is obtained from search_products or get_category_products results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `product_key` | string | Yes | Unique product identifier key (e.g. 'iphone17256bk'). Obtain from search_products results[*].key. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-catalog-onliner-by-api-b3919ac2/get_product \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product_key":"<string>"}'
```

### get_product_offers

Get current shop offers (positions) for a product. Returns a list of primary offers sorted by price, each with shop_id, price, warranty, delivery info, and stock status. Also includes a shops map keyed by shop_id with shop metadata (title, rating, addresses, work hours).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `product_key` | string | Yes | Unique product identifier key (e.g. 'iphone17256bk'). Obtain from search_products results[*].key. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-catalog-onliner-by-api-b3919ac2/get_product_offers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product_key":"<string>"}'
```

### get_product_price_history

Get historical minimum price data for a product over a specified period. Returns daily price points (date + minimum price across all shops that day, null when no offers were tracked), plus current/min/max price summary for the period.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `period` | string | No | Time period for price history. |
| `product_key` | string | Yes | Unique product identifier key (e.g. 'iphone17256bk'). Obtain from search_products results[*].key. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-catalog-onliner-by-api-b3919ac2/get_product_price_history \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"period":"<string>","product_key":"<string>"}'
```

### get_product_reviews

Get user reviews for a product. Returns paginated reviews with rating (1-5), summary, full text, pros, cons, author info, and creation date. Reviews are shared across color/storage variants of the same product model.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |
| `product_key` | string | Yes | Unique product identifier key (e.g. 'iphone17256bk'). Obtain from search_products results[*].key. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-catalog-onliner-by-api-b3919ac2/get_product_reviews \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","product_key":"<string>"}'
```

### search_autocomplete

Get search autocomplete/suggestion results for a partial or full query string. Returns matching products ranked by relevance without pagination metadata. Useful for building type-ahead search UIs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search query string for autocomplete suggestions (e.g. 'sam', 'iphone'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-catalog-onliner-by-api-b3919ac2/search_autocomplete \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### search_products

Full-text search over the Onliner.by catalog. Returns paginated product listings sorted by relevance. Each product includes pricing range, review summary, and category info. Pagination via integer page counter; max 100 pages returned regardless of total matches.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |
| `query` | string | Yes | Search query string (e.g. 'iphone', 'samsung galaxy'). |

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