geoLocation

Classic/VPC環境で利用できます。

IPアドレスを指定して、地理的位置情報を検索します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/geoLocation

リクエストヘッダ

GeoLocation APIで共通して使用されるヘッダの詳細は、GeoLocationのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`ip`	String	Required	地域情報を知りたいユーザー IPアドレス IPアドレス形式の詳細は、IPv4のウィキペディアを参考
`ext`	String	Optional	追加情報を含むかどうか `t` \| `f` (デフォルト) `t`: 含む `f`: 含まない
`enc`	String	Optional	レスポンス結果のエンコード方式 `utf8`(デフォルト) \| `euckr`
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://geolocation.apigw.ntruss.com/geolocation/v2/geoLocation?ip=**.**.**.**&ext=t&enc=utf8&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`returnCode`	String	-	正常なコードは0、それ以外はエラーコード
`requestId`	String	-	APIリクエスト ID
`country`	String	-	IPアドレスに当てはまる国コード ISO 3166標準に準拠 EU(ヨーロッパ)、AP(アジア、オーストラリア)、A1(Anonymous Proxy)、A2(Satellite Provider)、O1(Other Country)を含む
`code`	String	-	韓国行政安全部で定義した行政区域コード
`r1`	String	-	都、広域市、州
`r2`	String	-	市、郡、区
`r3`	String	-	洞、面、邑
`lat`	Number	-	緯度
`long`	Number	-	経度
`net`	String	-	通信キャリア名

レスポンスステータスコード

GeoLocation APIで共通して使用されるレスポンスステータスコードの詳細は、GeoLocationのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

韓国内、ext=f、responseFormatType=xmlの場合

<?xml version="1.0" encoding="utf-8"?>
<getLocationResponse>
    <returnCode>0</returnCode>
    <requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
    <geoLocation>
        <country>KR</country>
        <code>41135*****</code>
        <r1>京畿道</r1>
        <r2>城南市盆唐区</r2>
    </geoLocation>
</getLocationResponse>

韓国内、ext=f、responseFormatType=jsonの場合

{
    "returnCode": 0,
    "requestId": "c4e52003-****-****-****-66c93acfd0d2",
    "geoLocation": {
        "country": "KR",
        "code": "41135*****",
        "r1": "京畿道",
        "r2": "城南市盆唐区",
    }
}

海外、ext=f、responseFormatType=xmlの場合

<?xml version="1.0" encoding="utf-8"?>
<getLocationResponse>
    <returnCode>0</returnCode>
    <requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
    <geoLocation>
        <country>US</country>
        <code></code>
        <r1>California</r1>
        <r2>San Francisco</r2>
    </geoLocation>
</getLocationResponse>

海外、ext=f、responseFormatType=jsonの場合

{
    "returnCode": 0,
    "requestId": "c4e52003-****-****-****-66c93acfd0d2",
    "geoLocation": {
        "country": "US",
        "code": "",
        "r1": "California",
        "r2": "San Francisco",
    }
}

韓国内、ext=t、responseFormatType=xmlの場合

<?xml version="1.0" encoding="utf-8"?>
<getLocationResponse>
    <returnCode>0</returnCode>
    <requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>
    <geoLocation>
        <country>KR</country>
        <code>41135*****</code>
        <r1>京畿道</r1>
        <r2>城南市盆唐区</r2>
        <r3>亭子洞</r3>
        <lat>**.268***</lat>
        <long>**.030***</long>
        <net>Korea Telecom</net>
    </geoLocation>
</getLocationResponse>

韓国内、ext=t、responseFormatType=jsonの場合

{
    "returnCode": 0,
    "requestId": "c4e52003-****-****-****-66c93acfd0d2",
    "geoLocation": {
        "country": "KR",
        "code": "41135*****",
        "r1": "京畿道",
        "r2": "城南市盆唐区",
        "r3": "亭子洞",
        "lat": **.268***,
        "long": **.030***,
        "net": "Korea Telecom"
    }
}

海外、ext=t、responseFormatType=xmlの場合

<?xml version="1.0" encoding="utf-8"?>
<getLocationResponse>
    <returnCode>0</returnCode>
    <requestId>c4e52003-****-****-****-66c93acfd0d2</requestId>    
    <geoLocation>
        <country>US</country>
        <code></code>
        <r1>California</r1>
        <r2>San Francisco</r2>
        <r3></r3>
        <lat>**.769***</lat>
        <long>-***.393***</long>
        <net>Fastly</net>
    </geoLocation>
</getLocationResponse>

海外、ext=t、responseFormatType=xmlの場合

{
    "returnCode": 0,
    "requestId": "c4e52003-****-****-****-66c93acfd0d2",
    "geoLocation": {
        "country": "US",
        "code": "",
        "r1": "California",
        "r2": "San Francisco",
        "r3": "",
        "lat": **.769***,
        "long": -***.393***,
        "net": "Fastly"
    }
}

例

GeoLocationのサンプルファイルをダウンロードして、GeoLocation APIをテストしたり、例として活用することができます。