YOLP(地図)

旧ローカルサーチ

リクエストURL
XML
http://map.yahooapis.jp/LocalSearchService/V1/LocalSearch
JSONP
http://map.yahooapis.jp/LocalSearchService/V1/LocalSearch

このWeb APIは古いバージョンのため、2014年8月31日をもって廃止いたします。新しいWeb APIへの移行をお願いいたします。新しいWeb APIはこちらです。

ローカルサーチAPIでは、キーワード検索、周辺検索の機能を提供します。キーワード検索は、住所・郵便番号・施設を指定して、その位置情報(緯度、経度)を出力します。周辺検索は、位置情報(緯度、経度)、範囲を指定すると、その範囲内に含まれる施設情報を出力します。

リクエストパラメータ

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

パラメータ 説明
appid(必須) string アプリケーションID。詳細はこちらをご覧ください。
p(必須) string (UTF-8エンコードされた)検索キーワード
lat(必須) float 緯度
lon(必須) float 経度
dist(必須) float 距離(単位km)
datum tky(デフォルト), wgs 指定した緯度経度の測地系:
  • tky - 日本測地系
  • wgs - 世界測地系
output xml(デフォルト), json 出力タイプ
callback string JSONPとして出力する際のコールバック関数名を指定するパラメータです。UTF-8でエンコードした文字列を指定します。
b integer: 1(デフォルト) 表示開始位置。最終位置(b + n - 1)は、100を超えられません。
n integer: 10(デフォルト), 100(最大) 表示件数
category address, zipcode, landmark, station, courpon 検索対象カテゴリ:
  • address - 住所を対象に検索
  • zipcode - 郵便番号を対象に検索
  • landmark - 施設(役所、学校、病院、郵便局など)を対象に検索
  • station - 駅を対象に検索

デフォルトは、address、zipcode、landmark、stationを対象に検索します。

ac string 住所コード(JIS X 0402)によ絞り込みを行います。
al 1, 2, 3 住所レベルの絞り込み:
  • 1 - 市区町村レベル
  • 2 - 町、大字レベル
  • 3 - 丁目、字レベル
住所を対象に検索した場合のみ有効です。
ac string 住所コード(JIS X 0402)による絞り込みを行います。
loco_mode boolean falseを指定すると、Yahoo!ロコと同等の検索機能を無効にします。
Yahoo!ロコと同等の検索機能とは以下の通りです。
  • 3文字以下のひらがなまたはカタカナでのクエリのロジックが変更になります。より絞り込まれた結果が返ってくるようになります。
  • 「ランチ」「飲み放題」「食べ放題」「女子会」「個室」で検索した場合、自動的にフラグ検索に切り替わります。
    1. 「ランチ」の場合は、LunchFlagがtrueのものが対象となります。
    2. 「飲み放題」の場合は、AllYouCanDrinkFlagがtrueのものが対象となります。
    3. 「食べ放題」の場合は、AllYouCanEatFlagがtrueのものが対象となります。
    4. 「女子会」の場合は、LadysPartyFlagがtrueのものが対象となります。
    5. 「個室」の場合は、PrivateDiningFlagがtrueのものが対象となります。
group string 「gid」を指定すると、名寄せされたPOI(同じgidが付与されている複数のPOI)の内、代表POIのみを返却します。

リクエストパラメータで、p(検索キーワード)か、lat(緯度)・lon(経度)・dist(距離)は、どちらか一方が必須となります。
ローカルサーチのソート順は検索方法で異なります。
キーワード検索時はキーワードとの一致度とランドマークの重要度から算出した評価順、周辺検索時(lat,lon,dist指定時)は指定場所から近い順となります。
緯度経度で使用できる書式は以下のとおりです。

  • 度.分.秒形式(35.39.26.180,139.43.56.868)
  • 度/分/秒形式(35/39/26.180,139/43/56.868)
  • 度形式(35.657272,139.732463)

サンプルリクエストURL

東京都港区六本木6-10-1を検索
http://map.yahooapis.jp/LocalSearchService/V1/LocalSearch?appid=<あなたのアプリケーションID>&p=%E6%9D%B1%E4%BA%AC%E9%83%BD%E6%B8%AF%E5%8C%BA%E5%85%AD%E6%9C%AC%E6%9C%A86-10-1


六本木ヒルズを検索
http://map.yahooapis.jp/LocalSearchService/V1/LocalSearch?appid=<あなたのアプリケーションID>&p=%E5%85%AD%E6%9C%AC%E6%9C%A8%E3%83%92%E3%83%AB%E3%82%BA


緯度:35.65678、経度:139.733555、半径1km以内の住所を検索
http://map.yahooapis.jp/LocalSearchService/V1/LocalSearch?appid=<あなたのアプリケーションID>&lat=35.65678&lon=139.733555&dist=1&category=address




レスポンスフィールド

旧ローカルサーチのスキーマの記述は、以下のURLをご覧ください。
http://map.yahooapis.jp/LocalSearchService/V1/LocalSearchResponse.xsd

フィールド 説明
Count 検索一致件数
ViewCount 検索出力件数
Query 検索キーワード
Category 検索カテゴリ:
  • Address - 住所
  • Zipcode - 郵便番号
  • Landmark - 施設
  • Station - 駅
Title 名称
Address 住所(施設は市区町村レベル)
AddressLevel 住所レベル:
  • 0 - 住所以外
  • 1 - 都道府県レベル
  • 2 - 市区町村レベル
  • 3 - 町、大字レベル
  • 4 - 丁目、字レベル
  • 5 - 番地レベル
  • 6 - 号レベル
  • 7 - その他1
  • 8 - その他2
DatumTky97 日本測地系緯度経度:
  • Lat - 緯度(10進形式)
  • Lon - 経度(10進形式)
DatumWgs84 世界測地系経度経度:
  • Lat - 緯度(10進形式)
  • Lon - 経度(10進形式)
Url 詳細ページへのURL




サンプルレスポンス

以下は、六本木6-10-1 のクエリーの結果です。

<?xml version="1.0" encoding="UTF-8" ?>
 <LocalSearchResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:yahoo:jp:maps: http://map.yahooapis.jp/LocalSearchService/V1/LocalSearchResponse.xsd">
 <Count>1</Count> 
 <ViewCount>1</ViewCount> 
 <Query>六本木6-10-1</Query> 
 <Item>
  <Category>address</Category> 
  <Title>東京都港区六本木6丁目10-1</Title> 
  <Address>東京都港区六本木6丁目10-1</Address> 
  <AddressLevel>6</AddressLevel> 
  <DatumTky97>
   <Lat>35.65716694</Lat> 
   <Lon>139.73245194</Lon> 
  </DatumTky97>
  <DatumWgs84>
   <lat>35.660405629004</lat> 
   <lon>139.72922221769</lon> 
  </DatumWgs84>
  <Url /> 
 </Item>
</LocalSearchResult>
<!--  map.yahooapis.jp uncompressed/chunked Wed Feb 14 20:52:50 JST 2007 
  -->



エラー

旧ローカルサーチはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。




利用制限

ローカルサーチAPIは、24時間中1IPアドレスにつき50000件のリクエストが上限となっています。