YOLP(地図)
Yahoo!リバースジオコーダAPI
Version 1
リクエストURL
XML
http://reverse.search.olp.yahooapis.jp/OpenLocalPlatform/V1/reverseGeoCoder
目次
- 概要
- リクエストパラメータ一覧
- レスポンス
- エラー
概要
Yahoo!リバースジオコーダAPI(以下、リバースジオコーダAPI)は、緯度・経度で指定された場所の住所検索結果を返します。
リクエストパラメータ一覧
「RESTリクエストの構築(GET)」をご参照ください。
| パラメータ | 値 | 説明 |
|---|---|---|
| appid(必須) | string | アプリケーションID。詳細はこちらをご覧ください。 |
| lat(必須) | - | 緯度。 |
| lon(必須) | - | 経度。 |
| datum | string | 緯度経度の測地系:
|
| output | string | YDFの出力形式:
|
| callback | string | JSON(JSONP)として出力する際のコールバック関数名。 |
サンプルリクエスト
日本橋(東京)の住所検索(緯度:35.68381981、経度:139.77456498)
http://reverse.search.olp.yahooapis.jp/OpenLocalPlatform/V1/reverseGeoCoder?lat=35.68381981&lon=139.77456498&
レスポンスフィールド
リバースジオコーダAPIのスキーマの記述は、以下のURLをご覧ください。
http://olp.yahooapis.jp/OpenLocalPlatform/V1/YDF.xsd
| フィールド | 説明 |
|---|---|
| YDF | クエリーレスポンスのすべてを含みます。 |
| ResultInfo | レスポンスのまとめ情報。 |
| Count | レスポンス情報に含まれる住所情報のデータ件数。 |
| Total | 出力されている住所情報以外も含めた全データ件数。 |
| Start | レスポンス情報に含まれる住所情報の、全データからの取得開始位置。 |
| Latency | レスポンス情報を生成するのに要した時間。 |
| Status | リクエスト元に処理結果を伝えるためのコード。 正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。 |
| Description | データの説明。詳細情報がある場合に表示されます。 |
| Copyright | コピーライト。 |
| Feature | 検索結果1件分のデータ群。 |
| Property | 各種データを格納。 |
| Country | 国情報。 |
| Code | 国(ISO)コード。 |
| Name | 国名。 |
| Address | 1行であらわす住所。 |
| AddressElement | 部分住所情報。 |
| Level | 住所レベル:
|
| Code | 行政コード。 |
| Name | 部分住所。 |
| Building | ビル情報。 |
| Id | ビルID(ビル情報部分) |
| Name | ビル名称(ビル情報部分) |
| Floor | ビル最上階数(ビル情報部分) |
| Area | 面積(ビル情報部分) |
| Road | 道路情報。 |
| Name | 道路名(道路情報) |
| Kana | 道路名かな(道路情報) |
| PopularName | 通称名(道路情報) |
| PopularKana | 通称名かな(道路情報) |
| Geometry | 拠点の場所を表すGeometry要素です。 |
| Type | 図形情報 |
| Coordinates | 座標情報です。 |
※日本以外は、国情報のみ出力します。ただし、アメリカ・カナダ・オーストラリア・ブラジルは州まで、中国は省まで出力します。
※海上の住所は取得できません。
サンプルレスポンス
以下は、東京都港区赤坂9丁目7-1(緯度:35.666049811559205、経度:139.73134257366763)の住所検索のリクエストに対するレスポンスです。
エラー
| コード | 説明 |
|---|---|
| 400 | 渡されたパラメータがWeb APIで期待されたものと一致しない場合に返されます。 |
| 204 | 指定された場所の住所情報が見つからない場合に返されます。 |
| 1004 | 緯度・経度の指定が正しくない場合に返されます。 |