# Zigbang Location Autocomplete API Documentation

<p><strong>Zigbang Location Autocomplete API Documentation</strong> Look up places by a Korean name such as 강남. Each result returns the type (subway, address, apartment, school or university), the Korean name, hint and description, latitude, longitude and the province, city and district. Subway results also return subway_id for the search endpoint. Use latitude and longitude of a result as lat and lng in the search endpoint. Zigbang sends all matches at once, so limit only shortens the list and total_count shows how many matched. A query without matches is a successful, empty response.</p>

- **Documentation:** [https://scrappa.co/docs/zigbang-api/zigbang_autocomplete](https://scrappa.co/docs/zigbang-api/zigbang_autocomplete)
- **API group:** Zigbang API
- **Endpoint:** `GET https://scrappa.co/api/zigbang/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 | Korean place name, 1 to 60 characters. Example: 강남. |
| `service` | string | No | Narrow the matches to one service: oneroom, villa, officetel or apartment. |
| `limit` | integer | No | Maximum results returned, 1 to 100. Defaults to 30. |

## Example response

```json
{
    "data": {
        "meta": {
            "total_count": 61
        },
        "results": [
            {
                "id": 1168000000,
                "city": "\uac15\ub0a8\uad6c",
                "name": "\uac15\ub0a8\uad6c",
                "type": "address",
                "latitude": 37.4996469,
                "province": "\uc11c\uc6b8\uc2dc",
                "longitude": 127.0547881,
                "description": "\uc11c\uc6b8\ud2b9\ubcc4\uc2dc \uac15\ub0a8\uad6c"
            },
            {
                "id": 4817010300,
                "city": "\uc9c4\uc8fc\uc2dc",
                "name": "\uac15\ub0a8\ub3d9",
                "type": "address",
                "district": "\uac15\ub0a8\ub3d9",
                "latitude": 35.1842394,
                "province": "\uacbd\uc0c1\ub0a8\ub3c4",
                "longitude": 128.0873449,
                "description": "\uacbd\uc0c1\ub0a8\ub3c4 \uc9c4\uc8fc\uc2dc \uac15\ub0a8\ub3d9"
            },
            {
                "id": 5279033026,
                "city": "\uace0\ucc3d\uad70",
                "name": "\uac15\ub0a8\ub9ac",
                "type": "address",
                "district": "\ubb34\uc7a5\uba74",
                "latitude": 35.4182982,
                "province": "\uc804\ub77c\ubd81\ub3c4",
                "longitude": 126.5951199,
                "description": "\uc804\ubd81\ud2b9\ubcc4\uc790\uce58\ub3c4 \uace0\ucc3d\uad70 \ubb34\uc7a5\uba74 \uac15\ub0a8\ub9ac",
                "neighborhood": "\uac15\ub0a8\ub9ac"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | The query is missing or a parameter is invalid. No upstream request is made. This response is not billable. |
| 503 | Service Unavailable | Zigbang could not be reached, blocked every attempt, or answered with a shape that no longer matches the documented contract (error code PARSER_DRIFT). 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)