get_index_data
Retrieve price index data from the Israel Central Bureau of Statistics API by specifying index code, time range, and format. Use to analyze economic trends or perform inflation calculations.
Instructions
Get index data from Israel Statistics API
Input Schema
Name | Required | Description | Default |
---|---|---|---|
code | Yes | The index code (numeric string) you want price data for. Get this code first from getSubjectCodes or getIndexTopics. Example: '120010' for general CPI. | |
coef | No | Set to true to include linkage coefficients for inflation calculations. Only needed if you plan to do manual price adjustments. | |
endPeriod | No | Ending period in mm-yyyy format like '12-2024' for December 2024. Leave empty to get data up to the most recent available. | |
explanation | No | Additional explanation or context for the request | |
format | No | Response format. Options: json=JSON format (recommended, default) | xml=XML format. Use json unless you specifically need XML. | |
lang | No | Language for response. Options: he=Hebrew (default) | en=English. Use 'en' for English responses. | |
last | No | Get only the N most recent data points instead of the full series. Useful for getting just the latest values, e.g., use 12 for the last year of monthly data. | |
page | No | Page number for pagination. Start with 1 for first page. Use with pagesize to navigate large result sets. | |
pagesize | No | Number of results per page (maximum 1000). Controls how many items to return. Use with page for pagination. | |
startPeriod | No | Starting period in mm-yyyy format like '01-2020' for January 2020. Leave empty to get data from the beginning of the series. |