YOLP(地図)

Yahoo!リバースジオコーダAPI

リクエストURL
XML
http://reverse.search.olp.yahooapis.jp/OpenLocalPlatform/V1/reverseGeoCoder

目次




概要

Yahoo!リバースジオコーダAPI(以下、リバースジオコーダAPI)は、緯度・経度で指定された場所の住所検索結果を返します。




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

RESTリクエストの構築(GET)」をご参照ください。

パラメータ 説明
appid(必須) string アプリケーションID。詳細はこちらをご覧ください。
lat(必須) - 緯度。
lon(必須) - 経度。
datum string 緯度経度の測地系:
  • wgs - 世界測地系(デフォルト)
  • tky - 日本測地系
output string YDFの出力形式:
  • xml - XML形式(デフォルト)
  • json - JSON(JSONP)形式
callback string JSON(JSONP)として出力する際のコールバック関数名。

サンプルリクエスト

日本橋(東京)の住所検索(緯度:35.68381981、経度:139.77456498)
http://reverse.search.olp.yahooapis.jp/OpenLocalPlatform/V1/reverseGeoCoder?lat=35.68381981&lon=139.77456498&appid=<あなたのアプリケーションID>




レスポンスフィールド

リバースジオコーダ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国名。
Address1行であらわす住所。
AddressElement部分住所情報。
Level住所レベル:
  • prefecture - 都道府県
  • city - 市区町村
  • oaza - 大字
  • aza - 字
  • detail1 - 街区
Code行政コード。
Name部分住所。
Buildingビル情報。
IdビルID(ビル情報部分)
Nameビル名称(ビル情報部分)
Floorビル最上階数(ビル情報部分)
Area面積(ビル情報部分)
Road道路情報。
Name道路名(道路情報)
Kana道路名かな(道路情報)
PopularName 通称名(道路情報)
PopularKana 通称名かな(道路情報)
Geometry拠点の場所を表すGeometry要素です。
Type図形情報
Coordinates座標情報です。

※日本以外は、国情報のみ出力します。ただし、アメリカ・カナダ・オーストラリア・ブラジルは州まで、中国は省まで出力します。

※海上の住所は取得できません。




サンプルレスポンス

以下は、東京都港区赤坂9丁目7-1(緯度:35.666049811559205、経度:139.73134257366763)の住所検索のリクエストに対するレスポンスです。

<YDF xmlns="http://olp.yahooapis.jp/ydf/1.0" firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1">
  <ResultInfo>
    <Count>1</Count>
    <Total>1</Total>
    <Start>1</Start>
    <Latency>0.18004202842712</Latency>
    <Status>200</Status>
    <Description>指定の地点の住所情報を取得する機能を提供します。</Description>
    <Copyright>
      Copyright (C) 2013 Yahoo Japan Corporation. All Rights Reserved.
    </Copyright>
    <CompressType/>
  </ResultInfo>
  <Feature>
    <Property>
      <Country>
        <Code>JP</Code>
        <Name>日本</Name>
      </Country>
      <Address>東京都港区赤坂9丁目7-1</Address>
      <AddressElement>
        <Name>東京都</Name>
        <Kana>とうきょうと</Kana>
        <Level>prefecture</Level>
        <Code>13</Code>
      </AddressElement>
      <AddressElement>
        <Name>港区</Name>
        <Kana>みなとく</Kana>
        <Level>city</Level>
        <Code>13103</Code>
      </AddressElement>
      <AddressElement>
        <Name>赤坂</Name>
        <Kana>あかさか</Kana>
        <Level>oaza</Level>
      </AddressElement>
      <AddressElement>
        <Name>9丁目</Name>
        <Kana>9ちょうめ</Kana>
        <Level>aza</Level>
      </AddressElement>
      <AddressElement>
        <Name>7</Name>
        <Kana>7</Kana>
        <Level>detail1</Level>
      </AddressElement>
      <Building>
        <Id>B@iXzXO-G3A</Id>
        <Name>ミッドタウン・タワー</Name>
        <Floor>54</Floor>
        <Area>5147</Area>
      </Building>
    </Property>
    <Geometry>
      <Type>point</Type>
      <Coordinates>139.73134257366763,35.666049811559205</Coordinates>
    </Geometry>
  </Feature>
</YDF>



エラー

コード 説明
400 渡されたパラメータがWeb APIで期待されたものと一致しない場合に返されます。
204 指定された場所の住所情報が見つからない場合に返されます。
1004 緯度・経度の指定が正しくない場合に返されます。

<?xml version="1.0" encoding="UTF-8"?> 
<Error>
    <Message>0 Match From To parameter.</Message>
    <Code>204</Code>
</Error>