# 행정구역 경계·면적 분석 시도·시군구·읍면동·리의 경계로 면적·둘레·중심점·경계 상자를 계산하고 단순화한 GeoJSON 을 돌려줍니다. 행정구역 단위 분석·지도 표시용 경계를 만들 때 씁니다. 인증: Authorization: Bearer $APICK_API_KEY 본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다. 인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다. ## POST /rest/geo_district_boundary 응답 필드 - `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다. - `data.district` (object): 'district' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.district.code` (string): 행정구역 코드입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.district.name` (string): 행정구역 이름입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.district.level` (string): 찾은 단계(L1~L4)입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. - `data.district.center` (object): 행정구역 대표 지점 좌표입니다. 하위 필드에 코드·이름·상태 같은 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.district.center.x` (number): 'x' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.district.center.y` (number): 'y' 수치 값입니다. 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.district.center.crs` (string): 'crs' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.area` (object): 'area' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.area.m2` (integer): 면적(m²)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.area.km2` (number): 면적(km²)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.area.pyeong` (number): 면적(평)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.perimeterM` (number): 경계 둘레(m)입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.centroid` (object): 'centroid' 관련 값을 묶은 객체입니다. 하위 필드에 세부 값이 들어 있으며, 자료가 없으면 빈 객체이거나 생략됩니다. - `data.centroid.x` (number): 면적 중심 경도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.centroid.y` (number): 면적 중심 위도입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.bbox` (array): 경계 상자입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. 항목 수와 순서를 함께 확인하세요. - `data.vertexCount` (integer): 원본 정점 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.simplifiedVertexCount` (integer): 단순화 뒤 정점 수입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. - `data.simplifyToleranceM` (integer): 적용한 단순화 오차(m)입니다. 단순화하지 않았으면 null 입니다. 숫자로 오며, 단위·범위는 같은 응답의 다른 필드나 이 문서의 설명을 확인하세요. null 허용. - `data.autoSimplified` (boolean): 자동으로 단순화했으면 true 입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. - `data.geometry` (object): 경계 GeoJSON(GeometryCollection)입니다. includeGeometry=false 면 없습니다. - `data.geometry.type` (string): 'type' 문자열 값입니다. 값이 없으면 빈 문자열이거나 필드가 생략됩니다. - `data.geometry.geometries` (array): 'geometries' 목록입니다. 각 항목의 구성은 서비스에 따라 다르며, 값이 없으면 빈 배열입니다. - `data.error` (string): 오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다. - `api` (object): API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다. - `api.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다. - `api.success` (boolean): API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다. - `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다. ## API 요청: POST /rest/geo_district_boundary ### 입력 - `query` (string, 필수): 행정구역 이름 또는 코드 (예: 강남구, 11680) 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. - `level` (string, 선택): 행정구역 단계. 생략하면 이름으로 추정합니다. 문자열로 보내며, 생략하면 서버 기본값이 적용되거나 해당 조건이 해제됩니다. 가능한 값은 4가지입니다. L1 = L1 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요. L2 = L2 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요. L3 = L3 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요. L4 = L4 값을 뜻하며, 같은 응답의 다른 필드와 함께 해석하세요. 허용값: L1, L2, L3, L4 - `simplify` (number, 선택): 단순화 허용 오차(m) 숫자로 보내며, 허용 범위를 벗어나면 요청이 거부됩니다. - `includeGeometry` (boolean, 선택): 단순화한 경계 포함 여부 (기본 true) true/false로 보내며, 생략하면 서버 기본값이 적용됩니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. ### 응답 명세 ```json { "type": "object", "properties": { "data": { "type": "object", "properties": { "district": { "type": "object", "properties": { "code": { "type": "string", "description": "행정구역 코드입니다." }, "name": { "type": "string", "description": "행정구역 이름입니다." }, "level": { "type": "string", "description": "찾은 단계(L1~L4)입니다." }, "center": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" }, "crs": { "type": "string" } }, "description": "행정구역 대표 지점 좌표입니다." } } }, "area": { "type": "object", "properties": { "m2": { "type": "integer", "description": "면적(m²)입니다." }, "km2": { "type": "number", "description": "면적(km²)입니다." }, "pyeong": { "type": "number", "description": "면적(평)입니다." } } }, "perimeterM": { "type": "number", "description": "경계 둘레(m)입니다." }, "centroid": { "type": "object", "properties": { "x": { "type": "number", "description": "면적 중심 경도입니다." }, "y": { "type": "number", "description": "면적 중심 위도입니다." } } }, "bbox": { "type": "array", "items": { "type": "number" }, "description": "경계 상자입니다." }, "vertexCount": { "type": "integer", "description": "원본 정점 수입니다." }, "simplifiedVertexCount": { "type": "integer", "description": "단순화 뒤 정점 수입니다." }, "simplifyToleranceM": { "type": "integer", "description": "적용한 단순화 오차(m)입니다. 단순화하지 않았으면 null 입니다.", "nullable": true }, "autoSimplified": { "type": "boolean", "description": "자동으로 단순화했으면 true 입니다." }, "geometry": { "type": "object", "properties": { "type": { "type": "string" }, "geometries": { "type": "array", "items": {} } }, "description": "경계 GeoJSON(GeometryCollection)입니다. includeGeometry=false 면 없습니다." }, "error": { "type": "string", "description": "실패 사유입니다. 이 필드가 있으면 과금되지 않습니다." } } }, "api": { "type": "object", "properties": { "cost": { "type": "integer", "description": "차감된 포인트입니다. 실패한 응답은 0입니다." }, "success": { "type": "boolean" }, "ms": { "type": "integer", "description": "처리 시간(밀리초)입니다." } } } } } ``` ### 정적 응답 예시 ```json { "data": { "district": { "code": "11680", "name": "서울특별시 강남구", "level": "L2", "center": { "x": 127.0474864, "y": 37.51756978, "crs": "EPSG:4326" } }, "area": { "m2": 39670000, "km2": 39.67, "pyeong": 12000175.5 }, "perimeterM": 41250.5, "centroid": { "x": 127.0482, "y": 37.5169 }, "bbox": [ 127.0085, 37.4561, 127.1242, 37.5358 ], "vertexCount": 1512, "simplifiedVertexCount": 420, "simplifyToleranceM": 20, "autoSimplified": false, "geometry": { "type": "GeometryCollection", "geometries": [] } }, "api": { "cost": 20, "success": true, "ms": 180 } } ``` ### curl ```curl curl --fail-with-body --request POST 'https://apick.app/rest/geo_district_boundary' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'query=강남구' \ --form-string 'level=L2' \ --form-string 'simplify=20' ``` ### Node.js (서버 ESM) ```javascript const form = new FormData(); form.append("query", "강남구"); form.append("level", "L2"); form.append("simplify", "20"); const response = await fetch("https://apick.app/rest/geo_district_boundary", { method: "POST", headers: { Authorization: "Bearer " + process.env.APICK_API_KEY }, body: form, signal: AbortSignal.timeout(120_000), }); if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`); const result = await response.json(); console.log(result); ``` ### python ```python import os import requests parts = [ ("query", (None, "강남구")), ("level", (None, "L2")), ("simplify", (None, "20")), ] response = requests.request("POST", "https://apick.app/rest/geo_district_boundary", headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, files=parts, timeout=(10, 120)) response.raise_for_status() result = response.json() print(result) ``` ### php ```php '강남구', 'level' => 'L2', 'simplify' => '20', ]; $curl = curl_init('https://apick.app/rest/geo_district_boundary'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => $headers, CURLOPT_POSTFIELDS => $form, CURLOPT_RETURNTRANSFER => true, CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120, ]); $body = curl_exec($curl); if ($body === false) { throw new RuntimeException(curl_error($curl)); } $status = curl_getinfo($curl, CURLINFO_HTTP_CODE); curl_close($curl); if ($status >= 400) { throw new RuntimeException($body); } $result = json_decode($body, true, 512, JSON_THROW_ON_ERROR); print_r($result); ``` ## 사용 예시 1. 시군구 경계와 면적 지도에 시군구 경계를 그리고 면적을 함께 표시합니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_district_boundary' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'query=강남구' \ --form-string 'level=L2' \ --form-string 'simplify=20' ``` - `data.area.km2`가 면적이고 `data.geometry`를 지도에 그립니다. ## 사용 예시 2. 코드로 정확히 지정 같은 이름이 여러 곳에 있는 행정구역(예: 중구)은 코드로 보내 정확히 고릅니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/geo_district_boundary' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'query=11140' \ --form-string 'includeGeometry=false' ``` - `data.district.name`으로 의도한 지역이 맞는지 확인합니다. 면적만 필요하면 `includeGeometry=false`로 응답을 줄입니다. ## 코드·오류 ### 업무 실패 응답 입력 오류·대상 없음·일시 실패는 data.error(사유)와 data.success=0으로 오며 api.cost는 0(과금 없음)입니다. HTTP 상태는 400·404·408·424 중 하나입니다. 입력 오류는 값을 고쳐 다시 요청하고, 408·424는 잠시 후 한 번 다시 시도하세요. ```json { "data": { "error": "입력값을 확인해 주세요.", "success": 0 }, "api": { "success": true, "cost": 0, "ms": 5 } } ``` ## 상세 기능·요금 이용 전 확인 성공한 요청 한 건당 20P가 차감됩니다. 입력이 잘못됐거나 결과를 찾지 못하면 data.error로 응답하며 api.cost는 0입니다. level은 L1(시도)·L2(시군구)·L3(읍면동)·L4(리)입니다. 생략하면 이름 끝 글자(시·도→L1, 구·군→L2, 읍·면·동→L3, 리→L4)나 코드 자릿수(2자리→L1, 5자리→L2, 8자리→L3)로 판단합니다.같은 이름이 여러 곳에 있으면(예: 중구) 첫 결과를 씁니다. 정확히 고르려면 서울특별시 중구처럼 상위 지역명을 함께 넣거나 코드를 보내세요.정점이 3000개를 넘는 경계를 simplify 없이 요청하면 15m 오차로 자동 단순화하고 autoSimplified가 true 입니다. 좌표는 WGS84 경위도(EPSG:4326)이며 x가 경도, y가 위도입니다. 거리·면적은 근사값이며 필지·행정구역 규모에서는 오차가 작습니다. ## 상세 요청 항목설정 메서드·주소POST https://apick.app/rest/geo_district_boundary 인증 헤더Authorization: Bearer — 내 계정의 API 인증키 본문 형식multipart/form-data 요청 예시 form-data 전체 예제 보기 ## 상세 응답 필드타입설명 data.district.codestring행정구역 코드입니다.data.district.namestring행정구역 이름입니다.data.district.levelstring찾은 단계(L1~L4)입니다.data.district.centerobject행정구역 대표 지점 좌표입니다.data.area.m2number면적(m²)입니다.data.area.km2number면적(km²)입니다.data.area.pyeongnumber면적(평)입니다.data.perimeterMnumber경계 둘레(m)입니다.data.centroid.xnumber면적 중심 경도입니다.data.centroid.ynumber면적 중심 위도입니다.data.bbox[]array경계 상자입니다.data.vertexCountinteger원본 정점 수입니다.data.simplifiedVertexCountinteger단순화 뒤 정점 수입니다.data.simplifyToleranceMnumber적용한 단순화 오차(m)입니다. 단순화하지 않았으면 null 입니다.data.autoSimplifiedboolean자동으로 단순화했으면 true 입니다.data.geometryobject경계 GeoJSON(GeometryCollection)입니다. includeGeometry=false 면 없습니다. data.errorstring실패 사유입니다. 이 필드가 있으면 과금되지 않습니다. api.costinteger차감된 포인트입니다. 실패한 응답은 0입니다. api.msinteger처리 시간(밀리초)입니다. { "data": { "district": { "code": "11680", "name": "서울특별시 강남구", "level": "L2", "center": { "x": 127.0474864, "y": 37.51756978, "crs": "EPSG:4326" } }, "area": { "m2": 39670000, "km2": 39.67, "pyeong": 12000175.5 }, "perimeterM": 41250.5, "centroid": { "x": 127.0482, "y": 37.5169 }, "bbox": [ 127.0085, 37.4561, 127.1242, 37.5358 ], "vertexCount": 1512, "simplifiedVertexCount": 420, "simplifyToleranceM": 20, "autoSimplified": false, "geometry": { "type": "GeometryCollection", "geometries": [] } }, "api": { "cost": 20, "success": true, "ms": 180 } } ## 상세 코드·정책 오류 코드 상황data.error 예대처 입력 누락·형식 오류검색어가 필요합니다. / 주소 유형이 잘못됐습니다. / 좌표가 올바르지 않습니다. …문구가 가리키는 입력을 고쳐 다시 요청합니다. 조회 전에 끝나며 과금되지 않습니다. 개수·길이 초과주소가 너무 깁니다. / 한 요청에 주소를 50개까지 보낼 수 있습니다. …표의 최대값 안으로 줄이거나 나눠서 요청합니다. 위치를 찾지 못함입력한 위치를 찾지 못했습니다.주소 표기(시도·시군구 포함 여부, 오탈자)를 확인합니다. 과금되지 않습니다. 처리 시간 초과처리 시간이 초과됐습니다. 범위를 줄여 다시 시도해 주세요.목록 건수·반경·분류 수를 줄여 다시 요청합니다. 과금되지 않습니다. 일시적 실패공간정보를 일시적으로 가져오지 못했습니다. 잠시 후 다시 시도해 주세요.잠시 뒤 같은 요청을 다시 보냅니다. 과금되지 않습니다.