# Property Finder Project API Documentation

Returns one Property Finder new project by its developer/project slug: title, starting price, description with a plain-text twin, construction phase and progress, delivery and completion dates, developer, location, gallery, amenities, payment plans, property types and contact options. An unknown slug answers a non-billed 404.

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

## 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 |
| --- | --- | --- | --- |
| `slug` | string | Yes | Project slug in the form developer/project, e.g. emaar-properties/montiva. |
| `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/project?slug=emaar-properties%2Fmontiva"
```

## Example response

```json
{
    "success": true,
    "data": {
        "project": {
            "id": "98694034-14f1-40ca-b3f3-99d779b293fd",
            "slug": "emaar-properties/montiva",
            "title": "Montiva at Emaar Green Gate",
            "starting_price": 1916888
        }
    },
    "meta": {
        "endpoint_family": "project",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | Error | No project carries that slug. 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)