# Properati Autocomplete API Documentation

<p><strong>Properati Autocomplete API</strong> turns a place name into the location ids that the search route takes. Each result has an <code>id</code>, the place name, its kind and the parent area (the department for a city).</p><p>Good to know:</p><ul><li>Colombia only. The text must have 3 to 100 characters. Shorter text returns a validation error.</li><li>A text with no match returns an empty list and is billed as a normal answer.</li><li>Answers are kept for one hour.</li><li>Failures are never billed.</li></ul>

- **Documentation:** [https://scrappa.co/docs/properati-api/properati_autocomplete](https://scrappa.co/docs/properati-api/properati_autocomplete)
- **API group:** Properati API
- **Endpoint:** `GET https://scrappa.co/api/properati/autocomplete`

## 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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Place name to look up, 3 to 100 characters. Example: Medellin. |
| `limit` | integer | No | Number of results, 1 to 25 (default 10). |

## Example response

```json
{
    "data": {
        "query": "Medellin",
        "returned": 1,
        "locations": [
            {
                "id": "3674954",
                "kind": "geo",
                "text": "Medell\u00edn",
                "group": "Areas",
                "parent": "Antioquia"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | The text is shorter than 3 characters or the limit is out of range. This response is not billable. |
| 503 | Upstream Unavailable | Properati could not be reached, or returned a page that does not match the expected shape. Retry shortly. 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)