# Property Finder Locations API Documentation

Returns Property Finder locations, filtered by a name substring or a category. Each location carries its id, name, type, path, coordinates, child count and image set. The ids feed the search endpoint location_ids filter. An empty result is a successful response.

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

## 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 |
| --- | --- | --- | --- |
| `name` | string | No | Substring match on the location name, e.g. Arjan. |
| `category_id` | string | No | Location category id. Defaults to 1. |
| `types` | string | No | Location types to include. |
| `page` | integer | No | Page number, 1-based. Defaults to 1. |
| `limit` | integer | No | Locations per page, 1 to 50. Defaults to 20. |
| `sort` | string | No | Upstream sort key. |
| `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/locations?name=Arjan&limit=5"
```

## Example response

```json
{
    "success": true,
    "data": {
        "locations": [
            {
                "id": "126",
                "type": "location",
                "name": "Arjan"
            }
        ],
        "pagination": {
            "page": 1,
            "per_page": 5,
            "total_count": 1,
            "page_count": 1,
            "has_more": false
        }
    },
    "meta": {
        "endpoint_family": "locations",
        "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)