get_e_stat_data_catalog
Search and retrieve statistical data catalogs from Japan's e-Stat API by keyword and survey year, with pagination control.
Instructions
Retrieves the data catalog from the E-Stat API.
機能名:データカタログ情報取得
政府統計の総合窓口(e-Stat)で提供している統計表ファイルおよび統計データベースの情報を取得できます。
統計表情報取得機能同様に、リクエストパラメータの指定により条件を絞った情報の取得も可能です。
Args:
search_word (str): Search keyword for statistics tables.
Use "AND", "OR", or "NOT" to specify multiple words for search.
Examples:
- "東京 AND 人口"
- "東京 OR 大阪"
surveyYears (str): The survey years for the statistics tables.
Must be in one of the following formats:
- yyyy: Unified year.
- yyyymm: Unified month.
- yyyymm-yyyymm: Unified month range.
Example: "2023" or "202301-202312" or "202301"
startPosition (int, optional): Start position for the search results.
Defaults to 1. For example:
- To get the first 100 results, set startPosition to 1.
- To get the next 100 results, set startPosition to 101.
limit (int, optional): Maximum number of results to retrieve. Defaults to 100.
Example:
search_word = "東京 AND 人口"
surveyYears = "2023"
startPosition = 1
limit = 100
Returns:
str: The response text from the E-Stat API.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| search_word | Yes | ||
| surveyYears | Yes | ||
| startPosition | No |