Zigbang Location Autocomplete API Documentation 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.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
2 optional filters available.
string
Required
Korean place name, 1 to 60 characters. Example: 강남.
coffee shops
string
Optional
Narrow the matches to one service: oneroom, villa, officetel or apartment.
example
integer
Optional
Maximum results returned, 1 to 100. Defaults to 30.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"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
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
The query is missing or a parameter is invalid. No upstream request is made. This response is not billable.
{
"errors": {
"q": [
"The q field is required."
]
},
"message": "The request validation failed"
}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.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "search"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "The Zigbang API is temporarily unavailable. Please retry."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.