Top > GeoPlatformAPI > GeoPointAPIユーザーズガイド

GeoPoint API ユーザーズガイド

これは何 ?

GeoPoint APIは、日本国内の地名(住所もしくは駅名)、緯度経度、郵便番号を相互変換する API です。

緯度経度からの地名への変換などの場合に、流行度の高い場所もしくはランドマークの場所が結果の上位になります。
「恵比寿」で検索した場合、変換候補としては、その近辺の住所「東京都渋谷区恵比寿南」や、駅名の「恵比寿駅」などですが、「恵比寿駅」の方がより上位に位置付けられやすくなっています。 (そのため、その緯度経度がどこの住所に属すかを正確に知るための使用には適しません。)

URI 

  0

http://api.cirius.co.jp/v1/geopoint/{format}?area={area}&api_key={API_KEY}

リクエスト

必須パラメータ

パラメータデフォルト値指定可能な値例
formatxmlxml, json, tsv
area任意の文字列『35.661123,139.702631』,『1500002』, urlencode(渋谷区)
api_key管理画面から取得した API_KEY
format
レスポンスの形式を XML, JSON, TSV(タブ区切りテキスト) のうちいずれかを指定してください。各形式の解説は(TODO:アンカー)レスポンスを参照してください。
area
住所、駅名、緯度経度、郵便番号を指定してください。何を指定したかは自動判別されます。
地名は ';' で区切って複数指定すると AND 検索できます。デフォルトの文字コードは UTF-8 です。(次項 charset 参照)
緯度経度は、度表記、度分秒表記ともに対応しています。緯度、経度の順に指定してください。度分秒は、dd/mm/ss.sss, dd.mm.ss.sss のいずれかの形式で表記してください。
api_key
API キーを指定してください。APIキーを取得するには、ユーザ登録が必要です。既にユーザ登録をされている方は管理画面より追加APIキーの発行を行ってください。

オプションパラメータ

パラメータデフォルト値指定可能な値例
in_typeautodecimal, dms, zipcode, keyword, auto
out_typedecimaldecimal, dms
in_datumwgs84wgs84, tokyo
out_datumwgs84wgs84, tokyo
charsetUTF-8UTF-8, Shift_JIS, EUC-JP, JIS
num51〜20
category(全カテゴリ)1: 住所 2: 駅名
callback
in_type
{area} パラメータに指定した地域の表現形式を明示的に指定します。
out_type
レスポンス中の緯度経度の表現形式を decimal(度表記) か dms(度分秒表記) で指定します。
in_datum
{area} パラメータに指定した値が緯度経度の場合の測地系を指定できます。wgs84(世界測地系) もしくは tokyo(日本測地系) で指定してください。
out_datum
レスポンス中の緯度経度の測地系を wgs84(世界測地系) か tokyo(日本測地系) で指定します。
charset
入出力で使用する文字コードを指定します。UTF-8, Shift_JIS, EUC-JP, JIS のいずれかで指定してください。
num
{area} パラメータにマッチする地域が複数あった場合、何件まで取得するか指定してください。最大20件まで指定できます。
category
取得したいデータの種類を指定してください。(1: 住所 2: 駅名) 指定なしの場合は両方返します。
callback
JSON 形式で取得する場合のコールバック関数の設定です。

レスポンス

レスポンス項目

入力時に {format} パラメータで指定したフォーマットで結果を返します。
値が無い場合は、項目に空文字列が入ります。
各項目名は以下の通りです。

項目名意味例
areaQueryリクエストパラメータ {area} の文字列35.661123,139.702631
count変換結果の件数5
lat緯度35.515151
lon経度139.515151
pref都道府県名東京都
prefCode都道府県コード13
city市区町村渋谷区
cityCode市区町村コード131130
town町名渋谷
display住所, 駅名渋谷駅(山手線)
categoryデータの種類(1: 住所 2: 駅名)1


リクエストとレスポンスの例

XML フォーマットの場合

  • リクエスト例:
      0

    GET http://api.cirius.co.jp/v1/geopoint/xml?area=35.661123,139.702631&api_key={API_KEY}
  • レスポンス:
      0
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24

    <?xml version="1.0" encoding="utf-8"?>
<result>
  <count>1</count>
  <areaQuery>35.661123,139.702631</areaQuery>
  <areas>  
    <area>
      <pref>
        <code>13</code>
        <name>東京都</name>
      </pref>
      <city>
        <code>131130</code>
        <name>渋谷区</name>
      </city>
      <town>渋谷</town>
      <point>
        <lat>35.661123</lat>
        <lon>139.702631</lon>
      </point>
      <display>渋谷駅(山手線)</display>
      <category>2</category>
    </area>
  </areas>
</result>

JSON フォーマットの場合

  • リクエスト例: 
      0

    GET http://api.cirius.co.jp/v1/geopoint/json?area=35.661123,139.702631&callback={コールバック関数名}&api_key={API_KEY}
  • レスポンス: 
      0
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14

    callback({
             'count'      : 1
             'areaQuery'  :'35.661123, 139.702631',
             'areas'      :[
             {
                'pref'    : {'code':'13',       'name': '東京都'},               
                'city'    : {'code':'131130',   'name': '渋谷区'},
                'town'    : '渋谷'
                'point'   : {'lat' : 35.661123, 'lon':139.702631},
                'display' : '渋谷駅(山手線)'
                'category': '2'
             }
             ]
             });

TSV フォーマットの場合

  • リクエスト例:
      0

    GET http://api.cirius.co.jp/v1/geopoint/tsv?area=35.661123,139.702631&api_key={API_KEY}
    レスポンス:
    以下形式でタブ区切りで取得件数分返却します。
      0

    pref	prefCode	city	cityCode	town	lat	lon	display	category\n

利用制限について

現時点では明示的な利用制限は設けておりませんが、本 API は実験的なサ ービスとして提供しておりますので、あまりに負荷が高くなる場合にはアクセス制限を設けさせていただく可能性があります。ご了承ください。

Last-modified: (646d)