# Olx (Portugal) — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.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 monitor real estate listings and business advertisements from OLX Portugal with advanced filtering and pagination options. Get detailed information about specific listings including prices, descriptions, and seller details to find exactly what you're looking for.

**Category:** Marketplaces | **Website:** [olx.pt/](https://olx.pt/) | **Docs:** [parse.bot/marketplace/cc7e361d-a74b-4a30-8427-f64f02aade39/olx-pt-api](https://parse.bot/marketplace/cc7e361d-a74b-4a30-8427-f64f02aade39/olx-pt-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/olx-portugal/`
**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 categories

Fetch the list of all enabled category IDs on OLX.pt. Returns numeric category IDs that can be used as the category_id parameter in search_listings. The list includes all active categories across all verticals (automotive, real estate, goods, etc.).

**Estimated cost:** Metered

_No parameters required._

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

### Get listing details

Get detailed information for a specific listing by its ID. Returns full listing data including all parameters (price, year, model, fuel type, mileage, etc.), photos, seller information, location, and description. The listing_id can be obtained from search_listings results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | Yes | The unique numeric ID of the listing (from search_listings results[*].data[*].id). |

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

### Search listings

Search for listings on OLX.pt with various filters. Returns paginated results sorted by the specified order. Pagination is offset-based: advance by incrementing offset by limit. Each listing includes id, title, price params, location, photos, seller info, and category. When called without a query or filters, returns the most recent listings across all categories. The metadata object reports total_elements for the query.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_id` | string | No | Category ID for filtering. Use get_categories to discover valid IDs. |
| `city_id` | string | No | City ID for location filtering. |
| `limit` | integer | No | Maximum number of results to return per page. |
| `offset` | integer | No | Pagination offset (number of results to skip). |
| `price_max` | string | No | Maximum price filter in EUR. |
| `price_min` | string | No | Minimum price filter in EUR. |
| `query` | string | No | Search keyword (e.g. 'apartamento', 'iphone'). Omitting returns all listings. |
| `region_id` | string | No | Region ID for location filtering (e.g. '13' for Porto, '1' for Lisbon). |
| `sort_by` | string | No | Sorting order. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/olx-portugal/search-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category_id":"<string>","city_id":"<string>","limit":"<integer>","offset":"<integer>","price_max":"<string>","price_min":"<string>","query":"<string>","region_id":"<string>","sort_by":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.