住まい情報取得API

移住、暮らしなどの住環境に関する情報を取得できます。

リクエストURL

リクエストパラメータ

パラメータ	値	説明
appid（必須）	string	アプリケーションID。詳細はこちらをご覧ください。
localGovernmentCode	number	総務省 全国地方公共団体コードです。6桁の市区町村単位で指定できます。 ex) 木更津市:122068
start	number	表示開始位置（デフォルト: 1）です。
results	number	表示件数（デフォルト: 10、最大：100）です。
yTownInfoId	string	住まい情報の管理番号です。住まい情報ごとに一意です。

サンプルリクエストURL

https://job.yahooapis.jp/v1/furusato/towninfo/?appid=<あなたのアプリケーションID>

レスポンスフィールド

フィールド	説明
total	全データ件数です。
start	レスポンス情報に含まれる、全データからの取得開始位置です。
count	レスポンス情報に含まれる、データ件数です。
results	取得結果です。
yTownInfoId	住まい情報の管理番号です。住まい情報ごとに一意です。
localGovernmentCode	市区町村の全国地方公共団体コードです。6桁の市区町村単位です。
addressPrefecture	市区町村の都道府県名です。
addressCity	市区町村名です。
recruitingSitePrefecture	都道府県の求人サイトの名称です。
recruitingUrlPrefecture	都道府県の求人サイトのURLです。
cityPrSitePrefecture	都道府県の移住、暮らしなどの住環境全般にまつわるコンテンツ（移住支援金等助成情報を含む。）を掲載しているサイトの名称です。
cityPrUrlPrefecture	都道府県の移住、暮らしなどの住環境全般にまつわるコンテンツ（移住支援金等助成情報を含む。）を掲載しているサイトのURLです。
cityPrSiteLocal	市町村・広域連合・一部事業組合等の移住、暮らしなどの住環境全般にまつわるコンテンツ（移住支援金等助成情報を含む。）を掲載しているサイトの名称です。
cityPrUrlLocal	市町村・広域連合・一部事業組合等の移住、暮らしなどの住環境全般にまつわるコンテンツ（移住支援金等助成情報を含む。）を掲載しているサイトのURLです。
cpName	情報提供元の名称です。

サンプルレスポンス

以下は、テスト用データのレスポンスです。

{
    "total": 1,
    "start": 1,
    "count": 1,
    "results": [
        {
            "localGovernmentCode": 123456,
            "addressPrefecture": "東京都",
            "addressCity": "千代田区",
            "recruitingSitePrefecture": "都道府県の求人サイトの名称",
            "recruitingUrlPrefecture": "https://job.yahoo.co.jp/",
            "cityPrSitePrefecture": "都道府県の移住、暮らしなどの住環境全般にまつわるコンテンツ（移住支援金等助成情報を含む。）を掲載しているサイトの名称。",
            "cityPrUrlPrefecture": "https://job.yahoo.co.jp/contents/local/kobe/",
            "cityPrSiteLocal": "市町村・広域連合・一部事業組合等の移住、暮らしなどの住環境全般にまつわるコンテンツ（移住支援金等助成情報を含む。）を掲載しているサイトの名称。",
            "cityPrUrlLocal": "https://job.yahoo.co.jp/contents/lawguide/",
            "cpName": "情報提供元の名前",
            "yTownInfoId": 1111
        }
    ]
}

エラー

求人情報取得APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。