郵便番号/住所/緯度経度データサービス HeartRails GeoAPI

お問い合わせ

API(XML/JSON)

API は商用、非商用を問わず、無料でご利用になれます。
ご利用条件の詳細に関しましては、位置参照情報利用約款、HeartRails の利用規約をご覧ください。

無料でご利用になられる際には、アプリケーション内に以下のクレジットを記載してください。

出典:「位置参照情報」(国土交通省)の加工情報・「HeartRails Geo API」(HeartRails Inc.)

大規模サイトでご利用になられる際には、有料プランもご検討ください。

API の一覧

「HeartRails Geo API」 の API は、全て GET 形式のリクエスト、UTF-8 形式の入力、出力に対応しております。

エリア情報取得 API

エリア名の一覧を取得する API です。

リクエスト URL

フォーマット URL
XML 形式 https://geoapi.heartrails.com/api/xml?method=getAreas
JSON(P) 形式 https://geoapi.heartrails.com/api/json?method=getAreas

リクエストパラメータ

パラメータ 説明
method getAreas (固定) メソッド名
jsonp string (オプション) JSON 形式のデータを受け取るためのコールバック関数名
JSON 形式のリクエスト URL にのみ対応

レスポンスフィールド

フィールド 説明
response エリア名の一覧
area エリア名

サンプルレスポンス

https://geoapi.heartrails.com/api/xml?method=getAreas

都道府県情報取得 API

都道府県名の一覧を取得する API です。

リクエスト URL

フォーマット URL
XML 形式 https://geoapi.heartrails.com/api/xml?method=getPrefectures
JSON(P) 形式 https://geoapi.heartrails.com/api/json?method=getPrefectures

リクエストパラメータ

パラメータ 説明
method getPrefectures (固定) メソッド名
area string (オプション) URL エンコード (UTF-8) されたエリア名
jsonp string (オプション) JSON 形式のデータを受け取るためのコールバック関数名
JSON 形式のリクエスト URL にのみ対応

レスポンスフィールド

フィールド 説明
response 都道府県名の一覧
prefecture 都道府県名

サンプルレスポンス

https://geoapi.heartrails.com/api/xml?method=getPrefectures

市区町村情報取得 API

ご指定のエリア、またはご指定の都道府県に存在する市区町村名の一覧を取得する API です。

リクエスト URL

フォーマット URL
XML 形式 https://geoapi.heartrails.com/api/xml?method=getCities
JSON(P) 形式 https://geoapi.heartrails.com/api/json?method=getCities

リクエストパラメータ

パラメータ 説明
method getCities (固定) メソッド名
area string URL エンコード (UTF-8) されたエリア名
エリア名、または都道府県名のいずれかのパラメータは必須
prefecture string URL エンコード (UTF-8) された都道府県名
エリア名、または都道府県名のいずれかのパラメータは必須
jsonp string (オプション) JSON 形式のデータを受け取るためのコールバック関数名
JSON 形式のリクエスト URL にのみ対応

レスポンスフィールド

フィールド 説明
response 市区町村名の一覧
city 市区町村名
city-kana 市区町村名の読み仮名 (平仮名)

サンプルレスポンス

「関東」 に存在する市区町村名の一覧
https://geoapi.heartrails.com/api/xml?method=getCities&area=%E9%96%A2%E6%9D%B1

「東京都」 に存在する市区町村名の一覧
https://geoapi.heartrails.com/api/xml?method=getCities&prefecture=%E6%9D%B1%E4%BA%AC%E9%83%BD

町域情報取得 API

ご指定の都道府県、またはご指定の市区町村に存在する町域の情報の一覧を取得する API です。

リクエスト URL

フォーマット URL
XML 形式 https://geoapi.heartrails.com/api/xml?method=getTowns
JSON(P) 形式 https://geoapi.heartrails.com/api/json?method=getTowns

リクエストパラメータ

パラメータ 説明
method getTowns (固定) メソッド名
prefecture string URL エンコード (UTF-8) された都道府県名
都道府県名、または市区町村名のいずれかのパラメータは必須
city string URL エンコード (UTF-8) された市区町村名
都道府県名、または市区町村名のいずれかのパラメータは必須
jsonp string (オプション) JSON 形式のデータを受け取るためのコールバック関数名
JSON 形式のリクエスト URL にのみ対応

レスポンスフィールド

フィールド 説明
response 町域の情報の一覧
prefecture 町域の存在する都道府県名
city 町域の存在する市区町村名
city-kana 町域の存在する市区町村名の読み仮名 (平仮名)
town 町域名
town-kana 町域名の読み仮名 (平仮名)
x 町域の経度 (世界測地系)
y 町域の緯度 (世界測地系)
postal 町域の郵便番号

サンプルレスポンス

「東京都」 に存在する町域の情報の一覧
https://geoapi.heartrails.com/api/xml?method=getTowns&prefecture=%E6%9D%B1%E4%BA%AC%E9%83%BD

「新宿区」 に存在する町域の情報の一覧
https://geoapi.heartrails.com/api/xml?method=getTowns&city=%E6%96%B0%E5%AE%BF%E5%8C%BA

最寄駅情報取得 API

ご指定の郵便番号に合致する最寄駅の情報の一覧を取得する API です。

リクエスト URL

フォーマット URL
XML 形式 https://geoapi.heartrails.com/api/xml?method=getStations
JSON(P) 形式 https://geoapi.heartrails.com/api/json?method=getStations

リクエストパラメータ

パラメータ 説明
method getStations (固定) メソッド名
postal string (必須) URL エンコード (UTF-8) された郵便番号
7 桁の半角数字を入力してください
jsonp string (オプション) JSON 形式のデータを受け取るためのコールバック関数名
JSON 形式のリクエスト URL にのみ対応

レスポンスフィールド

フィールド 説明
response 最寄駅の情報の一覧
station 最寄駅の情報
name 最寄駅名
kana 最寄駅名の読み仮名 (平仮名)
prev 前の駅名 (始発駅の場合は null)
next 次の駅名 (終着駅の場合は null)
x 最寄駅の経度 (世界測地系)
y 最寄駅の緯度 (世界測地系)
distance ご指定の場所から最寄駅までの距離 (精度は 10 m)
postal 最寄駅の郵便番号
prefecture 最寄駅の存在する都道府県名
line 最寄駅の存在する路線名

サンプルレスポンス

https://geoapi.heartrails.com/api/xml?method=getStations&postal=0010010

郵便番号による住所検索 API

ご指定の郵便番号に合致する町域の情報の一覧を取得する API です。

リクエスト URL

フォーマット URL
XML 形式 https://geoapi.heartrails.com/api/xml?method=searchByPostal
JSON(P) 形式 https://geoapi.heartrails.com/api/json?method=searchByPostal

リクエストパラメータ

パラメータ 説明
method searchByPostal (固定) メソッド名
postal string (必須) URL エンコード (UTF-8) された郵便番号
7 桁の半角数字を入力してください
jsonp string (オプション) JSON 形式のデータを受け取るためのコールバック関数名
JSON 形式のリクエスト URL にのみ対応

レスポンスフィールド

フィールド 説明
response 町域の情報の一覧
prefecture 町域の存在する都道府県名
city 町域の存在する市区町村名
city-kana 町域の存在する市区町村名の読み仮名 (平仮名)
town 町域名
town-kana 町域名の読み仮名 (平仮名)
x 町域の経度 (世界測地系)
y 町域の緯度 (世界測地系)
postal 町域の郵便番号

サンプルレスポンス

郵便番号 「001-0010」 に合致する町域の情報の一覧
https://geoapi.heartrails.com/api/xml?method=searchByPostal&postal=0010010

緯度経度による住所検索 API

ご指定の場所 (経度、緯度) 付近の町域の情報の一覧を取得する API です。

リクエスト URL

フォーマット URL
XML 形式 https://geoapi.heartrails.com/api/xml?method=searchByGeoLocation
JSON(P) 形式 https://geoapi.heartrails.com/api/json?method=searchByGeoLocation

リクエストパラメータ

パラメータ 説明
method searchByGeolocation (固定) メソッド名
x double (必須) 付近の町域の情報を取得したい場所の経度 (世界測地系)
y double (必須) 付近の町域の情報を取得したい場所の緯度 (世界測地系)
jsonp string (オプション) 形式のデータを受け取るためのコールバック関数名
形式のリクエスト URL にのみ対応

レスポンスフィールド

フィールド 説明
response 町域の情報の一覧
prefecture 町域の存在する都道府県名
city 町域の存在する市区町村名
city-kana 町域の存在する市区町村名の読み仮名 (平仮名)
town 町域名
town-kana 町域名の読み仮名 (平仮名)
x 町域の経度 (世界測地系)
y 町域の緯度 (世界測地系)
postal 町域の郵便番号

サンプルレスポンス

経度 「135.0」、緯度 「35.0」 の場所付近の町域の情報の一覧
https://geoapi.heartrails.com/api/xml?method=searchByGeoLocation&x=135.0&y=35.0

キーワードによる住所検索 API

ご指定のキーワードに合致する住所の情報の一覧を取得する API です。

リクエスト URL

フォーマット URL
XML 形式 https://geoapi.heartrails.com/api/xml?method=suggest
JSON(P) 形式 https://geoapi.heartrails.com/api/json?method=suggest

リクエストパラメータ

パラメータ 説明
method suggest (固定) メソッド名
keyword string (必須) URL エンコード (UTF-8) されたキーワード
matching prefix、like、suffix のいずれか
(必須)
prefix ⇒ 前方一致
like ⇒ 部分一致
suffix ⇒ 後方一致
jsonp string (オプション) 形式のデータを受け取るためのコールバック関数名
形式のリクエスト URL にのみ対応

レスポンスフィールド

フィールド 説明
response 町域の情報の一覧
prefecture 町域の存在する都道府県名
city 町域の存在する市区町村名
city-kana 町域の存在する市区町村名の読み仮名 (平仮名)
town 町域名
town-kana 町域名の読み仮名 (平仮名)
x 町域の経度 (世界測地系)
y 町域の緯度 (世界測地系)
postal 町域の郵便番号

サンプルレスポンス

「新宿区」 に合致する町域の情報の一覧 (部分一致)
https://geoapi.heartrails.com/api/xml?method=suggest&matching=like&keyword=%E6%96%B0%E5%AE%BF%E5%8C%BA

「新宿一丁目」 に合致する町域の情報の一覧 (部分一致)
https://geoapi.heartrails.com/api/xml?method=suggest&matching=like&keyword=%E6%96%B0%E5%AE%BF%E4%B8%80%E4%B8%81%E7%9B%AE

「エリア名」 「市区町村名」 「町域名」 の連結コンボボックス

青字部分のタグをウェブページに挿入することで、「エリア名」 「市区町村名」 「町域名」 の連結コンボボックスを設置することができます。

...
<head>
...
<script type="text/javascript"
  src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
<script type="text/javascript" src="https://geoapi.heartrails.com/api/geoapi.js"></script>
...
</head>
<body>
...
<select id="geoapi-areas" name="geoapi-areas">
  <option value="エリアを選択してください">エリアを選択してください</option>
</select>
<select id="geoapi-cities" name="geoapi-cities">
  <option value="市区町村名を選択してください">市区町村名を選択してください</option>
</select>
<select id="geoapi-towns" name="geoapi-towns">
  <option value="町域を選択してください">町域を選択してください</option>
</select>
...
</body>
...

「都道府県名」 「市区町村名」 「町域名」 の連結コンボボックス

青字部分のタグをウェブページに挿入することで、「都道府県名」 「市区町村名」 「町域名」 の連結コンボボックスを設置することができます。

...
<head>
...
<script type="text/javascript"
  src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
<script type="text/javascript" src="https://geoapi.heartrails.com/api/geoapi.js"></script>
...
</head>
<body>
...
<select id="geoapi-prefectures" name="geoapi-prefectures">
  <option value="都道府県を選択してください">都道府県を選択してください</option>
</select>
<select id="geoapi-cities" name="geoapi-cities">
  <option value="市区町村名を選択してください">市区町村名を選択してください</option>
</select>
<select id="geoapi-towns" name="geoapi-towns">
  <option value="町域を選択してください">町域を選択してください</option>
</select>
...
</body>
...

「郵便番号」 による住所検索フォーム

青字部分のタグをウェブページに挿入することで、「郵便番号」 を入力すると住所を検索して補完するフォームを設置することができます。

...
<head>
...
<script type="text/javascript"
  src="https://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
<script type="text/javascript" src="https://geoapi.heartrails.com/api/geoapi.js"></script>
...
</head>
<body>
...
<input id="geoapi-postal-3" name="geoapi-postal-3" type="text" maxlength="3" />
<input id="geoapi-postal-4" name="geoapi-postal-4" type="text" maxlength="4" />
<input id="search-by-postal" name="search-by-postal" type="submit" value="検索する" />
<input id="geoapi-address" name="geoapi-address" type="text" />
...
</body>
...

郵便番号/住所/緯度経度データの作成には、日本郵便様の 「住所の郵便番号」 、および、
国土交通省様の 「大字・町丁目レベル位置参照情報」 を利用させていただいております。