API （XML／JSON） |
API （XML／JSON）
API は商用、非商用を問わず、無料でご利用になれます。
ご利用条件の詳細に関しましては HeartRails の利用規約、および免責事項をご覧ください。
- 無料でご利用になられる際には、アプリケーション内に 「HeartRails Express」 のクレジットを記載してください。
- 大規模サイトでご利用になられる際には、有料プランもご検討ください。
API の一覧
- エリア情報取得 API
- 都道府県情報取得 API
- 路線情報取得 API
- 駅情報取得 API
- 最寄駅情報取得 API
- 「エリア名」 「路線名」 「駅名」 の連結コンボボックス
- 「都道府県名」 「路線名」 「駅名」 の連結コンボボックス
「HeartRails Express」 の API は、全て GET 形式のリクエスト、UTF-8 形式の入力、出力に対応しております。
エリア情報取得 API
エリア名の一覧を取得する API です。
リクエスト URL
| フォーマット | URL |
|---|---|
| XML 形式 | http://express.heartrails.com/api/xml?method=getAreas |
| JSON(P) 形式 | http://express.heartrails.com/api/json?method=getAreas |
リクエストパラメータ
| パラメータ | 値 | 説明 |
|---|---|---|
| method | getAreas （固定） | メソッド名 |
| jsonp | string （オプション） |
|
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| response | エリア名の一覧 |
| area | エリア名 |
サンプルレスポンス
http://express.heartrails.com/api/json?method=getAreas
都道府県情報取得 API
都道府県名の一覧を取得する API です。
リクエスト URL
| フォーマット | URL |
|---|---|
| XML 形式 | http://express.heartrails.com/api/xml?method=getPrefectures |
| JSON(P) 形式 | http://express.heartrails.com/api/json?method=getPrefectures |
リクエストパラメータ
| パラメータ | 値 | 説明 |
|---|---|---|
| method | getPrefectures （固定） | メソッド名 |
| area | string （オプション） | URL エンコード （UTF-8） されたエリア名 |
| jsonp | string （オプション） |
|
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| response | 都道府県名の一覧 |
| prefecture | 都道府県名 |
サンプルレスポンス
http://express.heartrails.com/api/json?method=getPrefectures
路線情報取得 API
ご指定のエリア、またはご指定の都道府県に存在する路線名の一覧を取得する API です。
リクエスト URL
| フォーマット | URL |
|---|---|
| XML 形式 | http://express.heartrails.com/api/xml?method=getLines |
| JSON(P) 形式 | http://express.heartrails.com/api/json?method=getLines |
リクエストパラメータ
| パラメータ | 値 | 説明 |
|---|---|---|
| method | getLines （固定） | メソッド名 |
| area | string | URL エンコード （UTF-8） されたエリア名 エリア名、または都道府県名のいずれかのパラメータは必須 |
| prefecture | string | URL エンコード （UTF-8） された都道府県名 エリア名、または都道府県名のいずれかのパラメータは必須 |
| jsonp | string （オプション） |
|
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| response | 路線名の一覧 |
| line | 路線名 |
サンプルレスポンス
-
「関東」 に存在する路線名の一覧
http://express.heartrails.com/api/json?method=getLines&area=%E9%96%A2%E6%9D%B1 -
「東京都」 に存在する路線名の一覧
http://express.heartrails.com/api/json?method=getLines&prefecture=%E6%9D%B1%E4%BA%AC%E9%83%BD
駅情報取得 API
ご指定の路線に存在する駅、またはご指定の駅名に合致する駅の情報の一覧を取得する API です。
リクエスト URL
| フォーマット | URL |
|---|---|
| XML 形式 | http://express.heartrails.com/api/xml?method=getStations |
| JSON(P) 形式 | http://express.heartrails.com/api/json?method=getStations |
リクエストパラメータ
| パラメータ | 値 | 説明 |
|---|---|---|
| method | getStations （固定） | メソッド名 |
| line | string | URL エンコード （UTF-8） された路線名 路線名、または駅名のいずれかのパラメータは必須 |
| name | string | URL エンコード （UTF-8） された駅名 路線名、または駅名のいずれかのパラメータは必須 |
| prefecture | string （オプション） | URL エンコード （UTF-8） された都道府県名 駅の情報の一覧を都道府県で絞り込むことが可能 |
| jsonp | string （オプション） |
|
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| response | 駅の情報の一覧 |
| station | 駅の情報 |
| name | 駅名 |
| prev | 前の駅名 （始発駅の場合は null） |
| next | 次の駅名 （終着駅の場合は null） |
| x | 駅の経度 （世界測地系） |
| y | 駅の緯度 （世界測地系） |
| postal | 駅の郵便番号 |
| prefecture | 駅の存在する都道府県名 |
| line | 駅の存在する路線名 |
サンプルレスポンス
-
「JR 山手線」 に存在する駅の情報の一覧
http://express.heartrails.com/api/json?method=getStations&line=JR%E5%B1%B1%E6%89%8B%E7%B7%9A -
「新宿」 に合致する駅の情報の一覧
http://express.heartrails.com/api/json?method=getStations&name=%E6%96%B0%E5%AE%BF
最寄駅情報取得 API
ご指定の場所 （緯度、経度） の最寄駅の情報の一覧を取得する API です。
リクエスト URL
| フォーマット | URL |
|---|---|
| XML 形式 | http://express.heartrails.com/api/xml?method=getStations |
| JSON(P) 形式 | http://express.heartrails.com/api/json?method=getStations |
リクエストパラメータ
| パラメータ | 値 | 説明 |
|---|---|---|
| method | getStations （固定） | メソッド名 |
| x | double （必須） | 最寄駅の情報を取得したい場所の経度 （世界測地系） |
| y | double （必須） | 最寄駅の情報を取得したい場所の緯度 （世界測地系） |
| jsonp | string （オプション） |
|
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| response | 最寄駅の情報の一覧 |
| station | 最寄駅の情報 |
| name | 最寄駅名 |
| prev | 前の駅名 （始発駅の場合は null） |
| next | 次の駅名 （終着駅の場合は null） |
| x | 最寄駅の経度 （世界測地系） |
| y | 最寄駅の緯度 （世界測地系） |
| distance | 指定の場所から最寄駅までの距離 （精度は 10 ｍ） |
| postal | 最寄駅の郵便番号 |
| prefecture | 最寄駅の存在する都道府県名 |
| line | 最寄駅の存在する路線名 |
サンプルレスポンス
http://express.heartrails.com/api/json?method=getStations&x=135.0&y=35.0
「エリア名」 「路線名」 「駅名」 の連結コンボボックス
青字部分のタグをウェブページに挿入することで、「エリア名」 「路線名」 「駅名」 の連結コンボボックスを設置することができます。
...
<head>
...
<script type="text/javascript" src="http://express.heartrails.com/api/express.js"></script>
...
</head>
<body onload="HRELoadArea('area', 'line', 'station');">
...
<select id="area" name="area" onchange="HREOnChangeArea();">
<option value="エリアを選択してください">エリアを選択してください</option>
</select>
<select id="line" name="line" onchange="HREOnChangeLine();">
<option value="路線を選択してください">路線を選択してください</option>
</select>
<select id="station" name="station">
<option value="駅を選択してください">駅を選択してください</option>
</select>
...
</body>
...
「都道府県名」 「路線名」 「駅名」 の連結コンボボックス
青字部分のタグをウェブページに挿入することで、「都道府県名」 「路線名」 「駅名」 の連結コンボボックスを設置することができます。
...
<head>
...
<script type="text/javascript" src="http://express.heartrails.com/api/express.js"></script>
...
</head>
<body onload="HRELoadPrefecture('prefecture', 'line', 'station');">
...
<select id="prefecture" name="prefecture" onchange="HREOnChangePrefecture();">
<option value="都道府県を選択してください">都道府県を選択してください</option>
</select>
<select id="line" name="line" onchange="HREOnChangeLine();">
<option value="路線を選択してください">路線を選択してください</option>
</select>
<select id="station" name="station">
<option value="駅を選択してください">駅を選択してください</option>
</select>
...
</body>
...
