# Sreality Location Suggest API

Suggest matching Czech localities for a place name or partial search phrase.

## Suggestions

Each result provides the public locality identity and display information used to select a location. The default category is `municipality_cz`; the default result limit is 10.

## Scope

Suggestions help identify locality values for search and resolve. They do not return listings or geographic boundaries.

- **Documentation:** [https://scrappa.co/docs/sreality-api/sreality_suggest](https://scrappa.co/docs/sreality-api/sreality_suggest)
- **API group:** Sreality API
- **Endpoint:** `GET https://scrappa.co/api/sreality/suggest`

## 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 |
| --- | --- | --- | --- |
| `phrase` | string | Yes | Place-name phrase to match, up to 200 characters. |
| `limit` | integer | No | Maximum number of suggestions, from 1 to 50; defaults to 10. |
| `category` | string | No | Suggestion category; defaults to municipality_cz. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/sreality/suggest?phrase=Brno&limit=10&category=municipality_cz"
```

## Example response

```json
{
    "success": true,
    "data": {
        "results": [
            {
                "category": "municipality_cz",
                "sentence": "Brno",
                "userData": {
                    "municipality_id": 5740,
                    "municipality_seo_name": "brno",
                    "latitude": 49.1951,
                    "longitude": 16.6068
                }
            }
        ]
    },
    "meta": {
        "endpoint_family": "locations",
        "billable": true,
        "retryable": false
    }
}
```

## 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)