POST/Address_code

Request URL

curl -X POST "https://rest-api.argoskyc.com/v3/address_code"
-H "x-api-key: {yourAPIKey}" \
  • 주소지 수집을 위해서는 compound code, global code 또는 formatted address가 필요합니다.

  • 해당 값들을 추출하기 위해서 해당 POST /address_code를 사용합니다.

  • address 입력 데이터에 주소, global코드, compound코드, 위도와 경도 중 하나를 입력하여 호출하면 compound code, global code formatted address 값이 리턴됩니다.

Input Data

*이 붙은 것은 필수 파라미터 입니다.

파라미터타입설명

*address

string

다음 항목 중 하나를 입력하여 조회가능

  • 주소

  • global code

  • compound code

  • 위도 및 경도 (콤마 구분으로 입력, ex. “37.557,126.973”)

language

string

결과 리턴값에 대한 언어 선택 (ex. “ko”) (ISO 3166-2 코드)

Output Data

응답 파라미터설명

formatted_address

상세 코드를 변환한 주소

compound_code

국가 및 도시와 상세주소 코드 값 (Ex. HXPG+MP Seoul, South Korea)

global_code

전체 주소에 대한 상세코드 값 (Ex. 8Q98HXPG+MP)

Sample

Sample Request 1

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://rest-api.argoskyc.com/v3/address_code',
  'headers': {
    'x-api-key': 'yourAPIkey',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  form: {
    'address': '20 W 34th St, New York, NY 10001'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Sample Request 2

curl --location --request POST 'https://rest-api.argoskyc.com/v3/address_code' \
--header 'x-api-key: yourAPIkey' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'language=en' \
--data-urlencode 'address=20 W 34th St, New York, NY 10118, USA'

Sample Response

{
    "formatted_address": "20 W 34th St, New York, NY 10118, USA",
    "compound_code": "P2X7+GP New York, NY",
    "global_code": "87G8P2X7+GP"
}

Last updated