# Booli For Sale Search API

<p>Search Booli's `GET /api/booli/search` endpoint for homes for sale (till salu) in Swedish areas. Every card carries price, rooms, living area, floor, monthly fee, address, coordinates, agent, amenities and image URLs, so no second call is needed to render a result list. Filters are validated: an unknown filter name or value returns 422 instead of being ignored. Pages are disjoint and `total` is the full result count; `page * limit` may not exceed 35000. Booli's search also lists homes announced as soon for sale (`status.key` is `upcomingSale`), some without a price; send `upcoming_sale=0` to keep only active listings. Find area ids with `GET /api/booli/areas`.</p>

- **Documentation:** [https://scrappa.co/docs/booli-api/booli_search](https://scrappa.co/docs/booli-api/booli_search)
- **API group:** Booli API
- **Endpoint:** `GET https://scrappa.co/api/booli/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 |
| --- | --- | --- | --- |
| `area_ids` | string | Yes | Comma-separated Booli area ids, for example 1 for Stockholm kommun. Find ids with /api/booli/areas |
| `sort` | string | No | Sort key, one of published, listPrice, rooms, livingArea, rent, listSqmPrice, plotArea, postAddress. Defaults to published |
| `ascending` | boolean | No | true or false. Each sort key is published in specific directions only; an unpublished combination returns 422 |
| `page` | integer | No | Page number, default 1. page * limit may not exceed 35000 |
| `limit` | integer | No | Results per page, default 35, maximum 100 |
| `object_type` | string | No | Comma-separated list of: Lägenhet, Villa, Kedjehus-Parhus-Radhus, Fritidshus, Gård, Tomt/Mark |
| `amenities` | string | No | Comma-separated list of: hasBalconyOrPatio, hasFireplace, buildingHasElevator |
| `extend_areas` | string | No | One of: 1, 2, 3, 4, 5, 10, 15, 20, 25, 30, 50, 100 |
| `floor` | string | No | One of: bottomFloor, aboveBottomFloor, topFloor |
| `days_active` | string | No | One of: 1, 3, 7, 30 |
| `showing_start_relative` | string | No | One of: todayOnwards, thisWeekend, nextSevenDays |
| `max_rent` | string | No | One of: 500, 1000, 1500, 2000, 2500, 3000, 3500, 4000, 4500, 5000, 6000, 8000, 10000, 12000, 14000, 16000, 18000, 20000 |
| `max_distance_to_water` | string | No | One of: 100, 250, 500, 750, 1000 |
| `show_only` | string | No | Comma-separated list of: priceDecrease, tenureOwnership |
| `is_new_construction` | boolean | No | 1, 0, true or false |
| `upcoming_sale` | boolean | No | 1, 0, true or false |
| `min_rooms` | string | No | Number, for example 2.5 |
| `max_rooms` | string | No | Number, for example 2.5 |
| `min_living_area` | integer | No | Whole number |
| `max_living_area` | integer | No | Whole number |
| `min_plot_area` | integer | No | Whole number |
| `max_plot_area` | integer | No | Whole number |
| `min_construction_year` | integer | No | Whole number |
| `max_construction_year` | integer | No | Whole number |
| `min_list_price` | integer | No | Whole number |
| `max_list_price` | integer | No | Whole number |
| `min_list_sqm_price` | integer | No | Whole number |
| `max_list_sqm_price` | integer | No | Whole number |

## Example response

```json
{
    "data": {
        "page": 1,
        "cards": [],
        "count": 10,
        "limit": 10,
        "total": 7943
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | The id, area or home does not exist. This response is not billable. |  |
|  | A parameter or filter is missing or invalid. This response is not billable. |  |
|  | Booli is temporarily unavailable. Retry the request. This response is not billable. |  |

## 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)