YOLP(地図)

住所ディレクトリAPI

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



目次




概要


  • 住所ディレクトリAPIでは、住所の階層データ構造を参照する機能を提供します。
  • 住所コードを指定して、その階層データ構造を出力します。



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

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

パラメーター 説明
appid(必須) string アプリケーションID。詳細はこちらをご覧ください。
ac(必須) string 住所コード(JIS X 0401)または国コード(ISO 3166-1 alpha-2)です。
住所コードは都道府県(2桁)と市区町村(5桁)を指定可能です。
住所コードの後ろに頭文字コードを追加すると、五十音で絞り込みが可能です。
ex) 北海道:01、青森県青森市あ行:02201aa
都道府県を返却したい場合は、国コード(JP)を指定してください。
mode string 郡名表示形式切り替え
1:町村名を返却、郡名はカッコ書き(デフォルト) ex) 甲良町(犬上郡)
2:郡名と町村名を返却、郡名はカッコ書きしない ex) 犬上郡甲良町
output string 出力形式:
  • xml - XML形式(デフォルト)
  • json - JSON形式
callback string
JSONPとして出力する際のコールバック関数名を入力するためのパラメーター。UTF-8でエンコードした文字列を入力します。



リクエストパラメーター 頭文字コード

コード 五十音
a あ行
k か行、が行
s さ行、ざ行
t た行、だ行
n な行
h は行、ば行、ぱ行
m ま行
y や行
r ら行
w わ行
aa
ai
au
ae
ao
ka
ki
ku
ke
ko
sa
si
su
se
so
ta
ti
tu
te
to
na
ni
nu
ne
no
ha
hi
hu
he
ho
ma
mi
mu
me
mo
ya
yu
yo
ra
ri
ru
re
ro
wa
wo
nn

API使用上の注意

URLの最大の長さは2048バイトです。
URLをエンコードして指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。




レスポンス

出力形式にXMLを指定(output=xml)の場合、XMLを返します。レスポンスフィールドをご参照ください。




レスポンスフィールド

フィールド 説明
YDF クエリーレスポンスのすべてを含みます。
ResultInfo レスポンスのまとめ情報です。
Count レスポンス情報に含まれる住所情報のデータ件数です。
Total 出力されている住所情報以外も含めた全データ件数です。
Start レスポンス情報に含まれる住所情報の、全データからの取得開始位置です。
Status リクエスト元に処理結果を伝えるためのコードです。正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。
Latency レスポンス情報を生成するのに要した時間です。
Feature 検索結果1件分のデータ群です。
Name 指定した住所文字列です。
Geometry 拠点の場所を表すGeometry要素です(世界測地系)。
Type 図形種別です。
Coordinates 座標情報です。
Property 各種データを格納します。
CassetteId カセットIDです。
※「b22fee69b0dcaf2c2fe2d6a27906dafc」固定。
Country 国情報です。
Code(Countryの子要素) 国コード(ISO 3166-1)です。
Name(Countryの子要素) 国名です。
Address 指定した住所文字列です。
GovernmentCode 住所コード(JIS X 0401 2,5桁)です。
AddressDirectory 住所のディレクトリ情報です。
AreaCode(AddressDirectoryの子要素) 住所コード(2,5桁)です。
Name(AddressDirectoryの子要素) 1階層下の住所です。
Kana(AddressDirectoryの子要素) 1階層下の住所のよみです。
Geometry(AddressDirectoryの子要素) 拠点の場所を表すGeometry要素です(世界測地系)。
Type(AddressDirectoryの子要素) 図形種別です。
Coordinates(AddressDirectoryの子要素) 座標情報です。



サンプルレスポンス

以下は、愛知県高浜市の住所ディレクトリのリクエストとレスポンスです。

http://search.olp.yahooapis.jp/OpenLocalPlatform/V1/addressDirectory?ac=23227&appid=<あなたのアプリケーションID>

結果を以下に示します。
<?xml version="1.0" encoding="UTF-8" ?>
<YDF xmlns="http://olp.yahooapis.jp/ydf/1.0" totalResultsReturned="20" totalResultsAvailable="20" firstResultPosition="1">
  <ResultInfo>
    <Count>20</Count>
    <Total>20</Total>
    <Start>1</Start>
    <Status>200</Status>
    <Latency>0.05</Latency>
  </ResultInfo>
  <Feature>
    <Name>愛知県高浜市</Name>
    <Geometry>
     <Type>point</Type>
     <Coordinates>136.98767654,34.92764343</Coordinates>
     <BoundingBox>136.97746194,34.90729815 137.02456946,34.95762824</BoundingBox>
    </Geometry>
    <Property>
      <CassetteId>b22fee69b0dcaf2c2fe2d6a27906dafc</CassetteId>
      <Country>
        <Code>JP</Code>
        <Name>日本</Name>
      </Country>
      <Address>愛知県高浜市</Address>
      <GovernmentCode>23227</GovernmentCode>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>青木町</Name>
       <Kana>あおきちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.98448643,34.92429237</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>碧海町</Name>
       <Kana>あおみちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.98308285,34.91906602</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>春日町</Name>
       <Kana>かすがちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.98652008,34.93129551</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>呉竹町</Name>
       <Kana>くれたけちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.99044938,34.94011379</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>小池町</Name>
       <Kana>こいけちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>137.00193195,34.94758889</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>沢渡町</Name>
       <Kana>さわたりちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.99199658,34.93255044</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>清水町</Name>
       <Kana>しみずちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>137.01512260,34.92888087</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>新田町</Name>
       <Kana>しんでんちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.98794003,34.94989761</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>神明町</Name>
       <Kana>しんめいちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>137.00267241,34.93803794</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>田戸町</Name>
       <Kana>たどちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.98524595,34.91175267</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>豊田町</Name>
       <Kana>とよだちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>137.00798297,34.94015763</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>八幡町</Name>
       <Kana>はちまんちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.99505939,34.95045479</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>稗田町</Name>
       <Kana>ひえだちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.99319292,34.92406840</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>二池町</Name>
       <Kana>ふたついけちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.99167223,34.91671331</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>本郷町</Name>
       <Kana>ほんごうちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>137.00368869,34.93047179</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>向山町</Name>
       <Kana>むかいやまちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>137.00226607,34.92289969</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>屋敷町</Name>
       <Kana>やしきちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.99292792,34.94356349</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>湯山町</Name>
       <Kana>ゆやまちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.99661413,34.93449639</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>芳川町</Name>
       <Kana>よしかわちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.98362605,34.93556697</Coordinates>
       </Geometry>
      </AddressDirectory>
      <AddressDirectory>
       <AreaCode>23227</AreaCode>
       <Name>論地町</Name>
       <Kana>ろんちちょう</Kana>
       <Geometry>
        <Type>point</Type>
        <Coordinates>136.99975532,34.91961696</Coordinates>
       </Geometry>
      </AddressDirectory>
    </Property>
  </Feature>
</YDF>



エラー

コード 説明
400 渡されたパラメーターがWeb APIで期待されたものと一致しない場合に返されます。
403 リソースへのアクセスを許されていないか、利用制限を超えている場合に適用されます。
503 内部的な問題によってデータを返すことができない場合に返されます。

以下は、リクエストに対するエラーレスポンスです。

<?xml version="1.0" encoding="UTF-8"?>
<Error>
  <Code>400</Code>
  <Message>Bad Request</Message>
</Error>