# Property Finder New Projects API Documentation

Returns the Property Finder new-projects light list, filtered by query, area ids, developer ids, property type, price range, construction phase or project slug. Each project carries its uuid, slug, title, starting price, construction phase, developer, location and a lead image, plus aggregation links for area facets. The upstream list is a fixed snapshot and is not paginated.

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

## 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 |
| --- | --- | --- | --- |
| `query` | string | No | Free-text project query. |
| `location_ids` | string | No | Comma-separated location ids, e.g. 1 for Dubai. |
| `developer_ids` | string | No | Comma-separated developer ids. |
| `property_type` | string | No | Upstream property type key. |
| `min_price` | integer | No | Minimum starting price. |
| `max_price` | integer | No | Maximum starting price. |
| `construction_phase` | string | No | Upstream construction phase key. |
| `slug` | string | No | Project slug, developer/project. |
| `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/projects?location_ids=1"
```

## Example response

```json
{
    "success": true,
    "data": {
        "projects": [
            {
                "id": "d1294890-1250-48b7-99e3-4f34a371b967",
                "slug": "emaar-properties/valia-tower",
                "title": "Valia Tower",
                "starting_price": 2060000
            }
        ],
        "aggregation_links": [
            {
                "id": 73,
                "name": "Jumeirah Village Circle",
                "slug": "jumeirah-village-circle",
                "count": 239
            }
        ],
        "pagination": {
            "total_count": 2429,
            "has_more": false
        }
    },
    "meta": {
        "endpoint_family": "projects",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | 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)