# Prom — 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 explore products from Prom.ua's Ukrainian marketplace, view detailed product information, browse category hierarchies, and retrieve seller profiles complete with reviews and contact details.

**Category:** Marketplaces | **Website:** [prom.ua/](https://prom.ua/) | **Docs:** [parse.bot/marketplace/af8053cf-75e4-4bc1-92b8-5f1e7be31eb1/prom-ua-api](https://parse.bot/marketplace/af8053cf-75e4-4bc1-92b8-5f1e7be31eb1/prom-ua-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-prom-ua-api-af8053cf/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_category_products

Retrieve products from a prom.ua category page. The category_url must be a valid prom.ua category URL or path. Use get_category_tree to discover valid category URLs. Returns paginated product listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_url` | string | Yes | Full category URL (e.g. 'https://prom.ua/ua/Krasota-i-zdorove') or path slug (e.g. '/ua/Krasota-i-zdorove'). |
| `page` | integer | No | Page number for pagination. |

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

### get_category_tree

Get the full category hierarchy from prom.ua. Returns a list of categories with names and URLs usable as input to get_category_products.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-prom-ua-api-af8053cf/get_category_tree \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_product_details

Fetch comprehensive details for a single product by its URL, including price, description, characteristics, images, and seller info. Combines JSON-LD structured data with GraphQL for availability and seller details. Product URLs are obtained from search_products or get_category_products.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `product_url` | string | Yes | Product URL or path (e.g. 'https://prom.ua/ua/p41985467-nevrolaksin-tabletki-120.html'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-prom-ua-api-af8053cf/get_product_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product_url":"<string>"}'
```

### get_seller_contacts

Get seller contact information via GraphQL including phones, email, address, website, and review statistics. Company ID is obtained from get_seller_profile.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `company_id` | integer | Yes | Seller company ID (from get_seller_profile). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-prom-ua-api-af8053cf/get_seller_contacts \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_id":"<integer>"}'
```

### get_seller_profile

Fetch seller profile basic info including name, company ID, and review statistics. The company ID returned can be used with get_seller_reviews and get_seller_contacts. Seller URLs are obtained from search_products results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `seller_url` | string | Yes | Seller URL or path (e.g. 'https://prom.ua/ua/c2807900-style-club.html'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-prom-ua-api-af8053cf/get_seller_profile \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"seller_url":"<string>"}'
```

### get_seller_reviews

Retrieve paginated reviews for a seller by company ID via GraphQL. Returns 10 reviews per page with author, rating, comment, date, and ordered products. Company ID is obtained from get_seller_profile or get_seller_contacts.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `company_id` | integer | Yes | Seller company ID (from get_seller_profile or get_seller_contacts). |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-prom-ua-api-af8053cf/get_seller_reviews \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_id":"<integer>","page":"<integer>"}'
```

### search_products

Full-text search over prom.ua products. Returns paginated results with price, seller, and availability info. Sorting options include rating and price (ascending/descending). Each product includes a URL suitable for get_product_details and a seller_url suitable for get_seller_profile.

**Estimated cost:** Metered

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

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-prom-ua-api-af8053cf/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","search_term":"<string>","sort":"<string>"}'
```