# Property Finder Search API Documentation

Searches Property Finder property inventory across the UAE and the GCC hosts. category_id selects the vertical (1 buy, 2 rent, 3 and 4 commercial). Filter by area ids, bedroom count, property type ids, keywords and a price range, then sort and page. Each result carries the price, area, coordinates, images, agent and brokerage, reference, listing dates and the listing flags. A query that legitimately matches nothing returns an empty list as a successful response.

- **Documentation:** [https://scrappa.co/docs/propertyfinder-api/propertyfinder_search](https://scrappa.co/docs/propertyfinder-api/propertyfinder_search)
- **API group:** Property Finder API
- **Endpoint:** `GET https://scrappa.co/api/propertyfinder/search`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `category_id` | integer | No | 1 buy, 2 rent, 3 and 4 commercial. Defaults to 1. |
| `location_ids` | string | No | Comma-separated location ids from the locations endpoint, e.g. 3811. |
| `bedrooms` | integer | No | Exact number of bedrooms. |
| `property_type_ids` | string | No | Comma-separated property type ids. |
| `keywords` | string | No | Free-text keywords. |
| `price_type` | string | No | daily, weekly, monthly or yearly. Rent listings only. |
| `min_price` | integer | No | Minimum price in the listing currency. |
| `max_price` | integer | No | Maximum price in the listing currency. |
| `sort` | string | No | featured, newest, priceAsc, priceDesc or bedroomAsc. Defaults to featured. |
| `page` | integer | No | Page number, 1-based. Defaults to 1. |
| `limit` | integer | No | Results per page, 1 to 50. Defaults to 30. |
| `locale` | string | No | en or ar. Defaults to en. |
| `country` | string | No | ae, sa, qa, bh or eg. Defaults to ae. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/propertyfinder/search?category_id=1&location_ids=3811&page=1&limit=10"
```

## Example response

```json
{
    "success": true,
    "data": {
        "properties": [
            {
                "id": "154616682",
                "category_id": 1,
                "property_type": "Villa",
                "price": {
                    "value": 7649000,
                    "currency": "AED"
                }
            }
        ],
        "pagination": {
            "page": 1,
            "per_page": 10,
            "total_count": 56,
            "has_more": true
        }
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | Error | The upstream API rejected the request parameters. Not billed. |
|  | Error | Property Finder could not be reached. Not billed. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)