# Centris Locations

Returns suggestions for a city, district, neighbourhood, postal code, address or listing number. For a suggestion that works as a search scope, search holds the location_id and location_type to pass to the search route. Address and listing suggestions have no search scope; listing suggestions carry the MLS number.

- **Documentation:** [https://scrappa.co/docs/centris-api/centris_locations](https://scrappa.co/docs/centris-api/centris_locations)
- **API group:** Centris API
- **Endpoint:** `GET https://scrappa.co/api/centris/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 |
| --- | --- | --- | --- |
| `query` | string | Yes | Partial place name, postal code or address, 2 to 80 characters. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/centris/locations?query=Laval"
```

## Example response

```json
{
    "success": true,
    "data": {
        "locations": [
            {
                "label": "Laval",
                "type": "GeographicArea",
                "id": "GSGS4622",
                "level": 1,
                "search": {
                    "location_id": "GSGS4622",
                    "location_type": "GeographicArea"
                },
                "mls": null
            }
        ],
        "count": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The listing number or broker code does not exist. This response is not billable and not retryable. |
| 422 | Validation Error | A public parameter is invalid, for example a page above 250, an unknown property type or a location_id without its location_type. This response is not billable. |
| 503 | Service Unavailable | The data could not be loaded right now. Retry the request. 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)