Sign In

Content Editor ‭[2]‬

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.

Table of Contents
Retrieving index subjects

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

To retrieve index subjects – name and code for each index in XML format https://api.cbs.gov.il/index/catalog/tree?format=xml&download=false&lang=en
To retrieve the indices and their codes for indices that contain specific wording https://api.cbs.gov.il/index/catalog/tree?format=json&download=false&q=manufacturing&lang=en
To retrieve the index subjects that are updated monthly https://api.cbs.gov.il/index/catalog/tree?format=xml&download=false&period=M&lang=en


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

Retrieving sections(chapters) list from the price indices https://api.cbs.gov.il/index/catalog/catalog? format=xml&download=false&lang=en

 

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

Retrieving subjects of a specific section from the price indices https://api.cbs.gov.il/index/catalog/chapter?id=a&format=xml&download=false&lang=en

 

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 the codes of the index series by specific subject https://api.cbs.gov.il/index/catalog/subject?id=37&format=xml&download=false&lang=en
Retrieving the codes of the index series by specific subject and description that contains specific text https://api.cbs.gov.il/index/catalog/subject?q=fruit&id=37&format=xml&download=false&lang=en

 

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

Retrieving data of a specific index by index code https://api.cbs.gov.il/index/data/price?id=120010&format=xml&download=false&lang=en
Retrieving data of a specific index by specific dates https://api.cbs.gov.il/index/data/price?id=120010&format=xml&download=false&startPeriod=01-2000&endPeriod=12-2019&lang=en
Retrieving the most recent values of a specific index, including chaining coefficients https://api.cbs.gov.il/index/data/price?id=120010&format=xml&download=false&last=2&coef=true&lang=en

 

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

Calculation of the index https://api.cbs.gov.il/index/data/calculator/120010?value=100&date=01-01-2018&toDate=01-01-2019&format=xml&download=false&lang=en
Calculation of the index by values of the lira https://api.cbs.gov.il/index/data/calculator/120010?value=100&date=01-01-2000&toDate=12-01-2019¤cy=lira&format=xml&download=false&lang=en


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 the main indices by various bases https://api.cbs.gov.il/index/data/price_selected?format=xml&download=false&lang=en

Retrieving the main indices by various bases In the old format

https://api.cbs.gov.il/index/data/price_selected?lang=en&oldformat=true&format=xml&download=false


Retrieving Main Indices

Template

https://api.cbs.gov.il/index/data/price_selected_b

Example*

Retrieving main indices https://api.cbs.gov.il/index/data/price_selected_b

* 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*

Retrieving main indices from 01/1997 until 03/2021 https://api.cbs.gov.il/index/data/price_selected_b?StartDate=199701&EndDate=202103

* 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

Retrieving the indices in various bases
 https://api.cbs.gov.il/index/data/price_all?lang=en&format=xml&download=false

Retrieving the indices in various bases in old format 

https://api.cbs.gov.il/index/data/price_all?lang=en&format=xml&download=false&oldformat=true

Retrieving the indices in various bases for Chapter a:

Consumer Prices Index

 https://api.cbs.gov.il/index/data/price_all?lang=en&chapter=a

​

‭(Hidden)‬ Content Editor ‭[1]‬

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.

lang
Typehe/en
ExplanationLanguage types (Hebrew/English)
Defaulthe
Required parameter–
format
Desired
Typexml/json/csv/xls
ExplanationFormat type
DefaultDepends on type of browser; defining the desired format is recommended
Required parameterDesired
download
Desired
Typetrue/false
ExplanationDefines whether the data will be downloaded as a physical file (true) or shown in the browser (false)
DefaultDepends on format and type of browser; defining the desired characteristic is recommended
Required parameterDesired
page
Typenumber
ExplanationNumber of current page (current_page)
Default1
Required parameter–
pagesize
Typenumber
ExplanationNumber of objects that will appear on the page (page_size); maximum: 1,000
Default100
Required parameter–

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 subjectsRetrieving index dataIndex linkage calculatorRetrieving primary indicesRetrieving 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

period
X
TypeM/Q/MQ/QM
ExplanationFrequency of updating the data (M–monthly/Q–quarterly/MQ–monthly + quarterly)
DefaultMQ
Required parameterX
q
X
Typestring
ExplanationText to search for
Default–
Required parameterX
string_match_type
Typebegins_with/contains/equals
ExplanationSearch conditions (begins with/contains/equals)
Defaultcontains

Examples

To retrieve index subjects – name and code for each index in XML format
To retrieve the indices and their codes for indices that contain specific wording
To retrieve the index subjects that are updated monthly

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

Retrieving sections(chapters) list from the price indices

List of Subjects by Chapter

Template:
https://api.cbs.gov.il/index/catalog/chapter
id
Required
Typestring
ExplanationSection code
Default–
Required parameterV

Example

Retrieving subjects of a specific section from the price indices

List of codes by subject

Template:
https://api.cbs.gov.il/index/catalog/subject

Parameters

id
Required
Typenumber
ExplanationTopic number
Default–
Required parameterV
q
X
Typestring
ExplanationText to search for
Default–
Required parameterX
string_match_type
X
Typebegins_with/contains/equals
Explanationsearch conditions (begins with/contains/equals)
Defaultcontains
Required parameterX

Examples

Retrieving the codes of the index series by specific subject
Retrieving the codes of the index series by specific subject and description that contains specific text

Retrieving data of the indices

Template:
https://api.cbs.gov.il/index/data/price

Parameters

id
Required
Typenumber
ExplanationIndex code
Default–
Required parameterV
startPeriod
X
Typemm-yyyy
ExplanationFrom date
Default01-1900
Required parameterX
endPeriod
X
Typemm-yyyy
ExplanationTo date
Default01-2100
Required parameterX
last
X
Typenumber>0
ExplanationNumber of objects to retrieve from one or more series, starting with the most updated and onward
Defaultall
Required parameterX
coef
X
Typetrue/false
Explanationadding a coefficient
Defaulttrue
Required parameterX

Examples

Retrieving data of a specific index by index code
Retrieving data of a specific index by specific dates
Retrieving the most recent values of a specific index, including chaining coefficients

Index Linkage Calculator

Template:
https://api.cbs.gov.il/index/data/calculator/{id}

Parameters

id
Required
Typenumber
ExplanationIndex code
Default–
Required parameterV
value
Required
Typenumber>0
ExplanationLinkage amount
Default–
Required parameterV
date
Required
Typemm-dd-yyyy/yyyy-mm-dd
ExplanationFrom date
Default–
Required parameterV
toDate
Required
Typemm-dd-yyyy/yyyy-mm-dd
ExplanationTo date
Default–
Required parameterV
currency
X
Typenew_sheqel/old_sheqel/lira
ExplanationType of currency
Defaultnew_sheqel
Required parameterX

Examples

Calculation of the index
Calculation of the index by values of the lira

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
oldformat*
X
Typetrue/false
ExplanationCorrections to match the old format mainly regarding Hebrew, spaces, order of presentation in base
Defaultfalse
Required parameterX

* Presently, support is only in XML format

Default: format=xml&download=false&chapter=&oldformat=false

Examples

Retrieving the main indices by various bases
Retrieving the main indices by various bases In the old format

Retrieving Main Indices

Template:
https://api.cbs.gov.il/index/data/price_selected_b

Example*

Retrieving main indices

* Presently, support is only in XML format

Retrieving Main Indices by Periods

Template:
https://api.cbs.gov.il/index/data/price_selected_b

Parameters

StartDate
Required
Typeyyyymm
ExplanationFrom date
Default199701 (Minimum)
Required parameterV
EndDate
Required
Typeyyyymm
ExplanationUntil date
Default---
Required parameterV

Example*

Retrieving main indices from 01/1997 until 03/2021

* Presently, support is only in XML format

Retrieving All the Indices by Various Bases

Template:
https://api.cbs.gov.il/index/data/price_all
true/false
X
ExplanationCorrections to match the old format mainly regarding Hebrew, spaces, order of presentation in base
Defaultfalse
Required parameterX
string
X
Explanation

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

Default"" All chapters
Required parameterX

* Presently, support is only in XML format

Default: format=xml&download=false&chapter=&oldformat=false

Examples

Retrieving the indices in various bases
Retrieving the indices in various bases in old format
Retrieving the indices in various bases for Chapter a: Consumer Prices Index