利用方法

地域経済分析システム（RESAS：リーサス）のデータ提供API（以下「本API」と称する。）は、 内閣府 地方創生推進室またはその代理人が運営しています。

ご利用の際は、利用規約・プライバシーポリシーにご承認いただく必要があります。

APIキーの設定について

本APIへアクセスするには、APIキーをリクエストヘッダーX-API-KEYを設定する必要があります。

リクエストヘッダーにAPIキーが設定されていないと、 リクエストしたデータは返却されず、403 Forbiddenのエラーとなります。

• ※ APIキーは利用申請していただくことで、発行されます。

レスポンスヘッダーのContent-Typeについて

レスポンスヘッダーContent-Typeはapplication/json;charset=UTF-8になります。

• ※ エラー発生時も同様です。

リクエストパラメータのURLエンコードについて

リクエストパラメータにはUTF-8でURLエンコード(パーセントエンコード)した文字列をご利用ください。

例：パラメータstringに「内閣府」を指定

/api/v1/japanese/charactor?string=%93%E0%8At%95%7B

同名パラメータを複数指定する場合

本APIには、同名パラメータを複数指定可能なAPIがあります。

該当APIに、同名パラメータを複数指定するときは、カンマ(,)区切りの文字列を指定してください。

例：パラメータaddAreaに「12:千葉県」と「13:東京都」を指定

/api/v1/multiple/parameter?prefCode=11&addArea=12_,13_

• ※ 複数指定可能な数には上限があります。上限はパラメータごとに異なるので、各APIのパラメータの仕様についてご確認ください。

呼び出し回数の制限について

本APIにはご利用いただける回数の制限があります。

回数制限の上限を超えた場合、 リクエストしたデータは返却されず、429 Too Many Requestsのエラーとなります。

エラー

本APIのエラーは、レスポンス本文のステータスコードとメッセージで表現されます。

4xx Client Errorについては、下記をご参照ください。

5xx Server Errorについては、恐縮ですが、お問い合わせいただけますと幸いです。

400 Bad Request

本APIに必要なパラメータが正しく設定されていないときに発生します。必須パラメータの設定が漏れていないか、正しいフォーマットで設定できているか、等をご確認ください。

レスポンスヘッダーのステータスは200 OKです。

"400"

403 Forbidden

リクエストヘッダーにAPIキーが無いとき、ご指定のAPIキーが無効なときなどに発生します。

廃止されたバージョン・開発中のバージョンへの参照でも起こり得ます。

また、一部のデータは、利用申請以外の手続きが必要な場合がございます。 該当データをご利用いただけない状態でアクセスしたときも発生します。

レスポンスヘッダーのステータスは200 OKです。

{
  "statusCode": "403",
  "message": "Forbidden.",
  "description": ""
}

404 Not Found

本APIにご指定のURLに該当するAPIが無いときに発生します。

APIのアドレスに誤りはないか、バージョンアップで廃止されていないか、ご確認ください。

レスポンスヘッダーのステータスは200 OKです。

なお、レスポンス本文は以下の場合があります。

{
  "statusCode": "404",
  "message": "404. That's an error.",
  "description": "The requested URL /404 was not found on this server."
}

または

"404"

429 Too Many Requests

本APIへのリクエスト回数が多く、 1秒あたりのリクエスト平均数・リクエスト数/日のうち、どちらかの制限を超えると発生します。

429 Too Many Requestsを受け取ったときは、 自動的にリトライするか、ユーザーにリトライを促す実装としてください。

また、実装の工夫でリクエスト数を減らせないかのご検討もお願いします。

{
  "message": null
}