How to Retrieve Indices Using the API Interface
The API provides a set of commands that can be used to retrieve the list of subjects of the indices, and an additional set of commands that enables retrieval of the indices' data.
Update
Notes- The Dwellings Price Index
General Parameters
Parameters that can be added generally to the API queries in order to define the format, language, and number of objects, among other things, on the page.
|
Parameter |
Type |
Explanation |
Default |
Required parameter |
| lang | he/en | Language types (Hebrew/English) | he | – |
| format | xml/json/csv/xls | Format type | Depends on type of browser; defining the desired format is recommended | Desired |
| download | true/false | Defines whether the data will be downloaded as a physical file (true) or shown in the browser (false) | Depends on format and type of browser; defining the desired characteristic is recommended | Desired |
| page | number | Number of current page (current_page) | 1 | – |
| pagesize | number | Number of objects that will appear on the page (page_size); maximum: 1,000 | 100 | – |
Notes- The Dwellings Price Index
1. The Dwellings Price Index is a bi-monthly index. Thus, the index published on the 15th of a particular month (t) is based on comparing transactions conducted two and three months ago (i.e., t-2 and t-3) to transactions conducted three and four months ago (i.e., t-3 and t 4). For example, when the calculator is used for a date during the period between July 16 and August 15, the latest published index is based on transactions conducted in April–May compared to transactions conducted in March–April.
2. In contrast to the other indices published in this series, the last three indices of the Dwellings Price Index are provisional and might be revised as further transactions are reported during those months. Therefore, indexation to a period when the index is still provisional is not recommended.
Retrieving index data
Index linkage calculator
Retrieving primary indices
Retrieving all the indices by various bases
Retrieving the Index Subjects
Complete list of subjects
List of subjects by level
Complete List of Subjects
Template
https://api.cbs.gov.il/index/catalog/tree
Parameters
|
Parameter |
Type |
Explanation |
Default |
Required parameter |
| period | M/Q/MQ/QM | Frequency of updating the data (M–monthly/Q–quarterly/MQ–monthly + quarterly) | MQ | X |
| q | string | Text to search for | – | X |
| string_match_type | begins_with/contains/equals | Search conditions (begins with/contains/equals) | contains | |
Examples
List of Subjects by Level
List of Chapters
List of Subjects by Chapter
List of Codes by Subject
List of Chapters
Template
https://api.cbs.gov.il/index/catalog/catalog
Example
List of Subjects by Chapter
Template
https://api.cbs.gov.il/index/catalog/chapter
|
Parameter |
Type |
Explanation |
Default |
Required parameter |
| id | string | Section code | – | V |
Example
List of codes by subject
Template
https://api.cbs.gov.il/index/catalog/subject
Parameters
|
Parameter |
Type |
Explanation |
Default |
Required parameter |
| id | number | Topic number | – | V |
| q | string | Text to search for | – | X |
| string_match_type | begins_with/contains/equals | search conditions (begins with/contains/equals) | contains | X |
Examples
Retrieving data of the indices
Template
https://api.cbs.gov.il/index/data/price
Parameters
|
Parameter |
Type |
Explanation |
Default |
Required parameter |
| id | number | Index code | – | V |
| startPeriod | mm-yyyy | From date | 01-1900 | X |
| endPeriod | mm-yyyy | To date | 01-2100 | X |
| last | number>0 | Number of objects to retrieve from one or more series, starting with the most updated and onward | all | X |
| coef | true/false | adding a coefficient | true | X |
Examples
Index Linkage Calculator
Template
https://api.cbs.gov.il/index/data/calculator/{id}
Parameters
|
Parameter |
Type |
Explanation |
Default |
Required parameter |
| id | number | Index code | – | V |
| value | number>0 | Linkage amount | – | V |
| date | mm-dd-yyyy/yyyy-mm-dd | From date | – | V |
| toDate | mm-dd-yyyy/yyyy-mm-dd | To date | – | V |
| currency | new_sheqel/old_sheqel/lira | Type of currency | new_sheqel | X |
Examples
Retrieving Main Indices:
Retrieving main indices by various bases
Retrieving main indices
Retrieving main indices by periods
Retrieving Main Indices by Various Bases
Template
https://api.cbs.gov.il/index/data/price_selected
|
Parameter |
Type |
Explanation |
Default |
Required parameter |
| oldformat* | true/false | Corrections to match the old format mainly regarding Hebrew, spaces, order of presentation in base | false | X
|
* Presently, support is only in XML format
Default: format=xml&download=false&chapter=&oldformat=false
Examples
Retrieving Main Indices
Template
https://api.cbs.gov.il/index/data/price_selected_b
Example*
* Presently, support is only in XML format
Retrieving Main Indices by Periods
Template
https://api.cbs.gov.il/index/data/price_selected_b
Parameters
|
Parameter |
Type |
Explanation |
Default |
Required parameter |
| StartDate | yyyymm | From date | 199701
(Minimum) | V |
| EndDate | yyyymm | Until date | --- | V |
Example*
* Presently, support is only in XML format
Retrieving All the Indices by Various Bases
Template
https://api.cbs.gov.il/index/data/price_all
|
Type |
Explanation |
Default |
Required parameter |
| true/false | Corrections to match the old format mainly regarding Hebrew, spaces, order of presentation in base | false | X |
| string | Ability to filter by specific chapter The list of chapters can be found at: https://api.cbs.gov.il/Index/Catalog/Catalog?lang=en
chapter=chaptereid * | Chapter | Description | | a | Consumer Prices Index | | aa | Average Housing Indices and Prices | | b | Producer Price Indices - Manufacturing Output for the Domestic Market | | ba | Producer Price Indices of Manufacturing| Mining and Quarrying Output for Exports | | bb | Producer Price Indices for Services (SPPI) | | c | Prices Indices of Input in Residential Building | | ca | Price Index of Input in Commercial and Office Building | | d | Price Indices of Input in Road Construction and Bridging | | e | Price Indices of Input in Agriculture | | f | Price Indices of Input in Buses | | fa | Price Indices of Input in Public Van Services |
|
""
All chapters |
X |
* Presently, support is only in XML format
Default: format=xml&download=false&chapter=&oldformat=false
Examples
