# Realtor.ca Autocomplete

Returns place suggestions for a partial city, neighbourhood or postal code.

- **Documentation:** [https://scrappa.co/docs/realtor-ca-api/realtor_ca_autocomplete](https://scrappa.co/docs/realtor-ca-api/realtor_ca_autocomplete)
- **API group:** Realtor.ca API
- **Endpoint:** `GET https://scrappa.co/api/realtor-ca/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 |
| --- | --- | --- | --- |
| `query` | string | Yes | Partial place name, at least 2 characters. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/realtor-ca/autocomplete?query=Toronto"
```

## Example response

```json
{
    "success": true,
    "data": {
        "suggestions": [
            {
                "Name": "Toronto, ON"
            }
        ],
        "count": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Listing Not Found | The requested listing reference number resolved to nothing on the origin. This response is not billable and is not retryable: a well-behaved client should not resend a reference number that does not exist. |
| 422 | Validation Error | A public parameter is invalid, including an unknown transaction type, property group or out-of-range price. This response is not billable. |
| 503 | Service Unavailable | The service could not obtain a complete result. 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)
