הנחיות למשיכת מדדים באמצעות ממשק ה-API

ה-API מספק סט פקודות שבאמצעותו ניתן למשוך את רשימת הנושאים של המדדים, וסט פקודות נוסף שמאפשר משיכה של נתוני המדדים.

עדכון

משיכת מדדים עיקריים

פרמטרים כלליים

פרמטרים שניתן להוסיף באופן כללי לשאילתות ה-API לצורך הגדרת הפורמט, השפה, מספר אובייקטים בדף וכדומה.

 

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
langhe/enסוג שפה (עברית/אנגלית)he---
formatxml/json/csv/xlsסוג פורמטתלוי בסוג הדפדפן, מומלץ להגדיר את הפורמט הרצוירצוי
download
true/falseמגדיר אם הנתונים ירדו כקובץ פיזי (true) או יוצגו בדפדפן (false)תלוי בפורמט ובסוג הדפדפן, מומלץ להגדיר את האופן הרצוירצוי
pagenumberמספר דף נוכחי (current_page)1---
pagesizenumberכמות האובייקטים שיופיעו בדף (page_size), מקסימום - 1000100---


תוכן עניינים:

משיכת נושאי המדדים
משיכת נתוני המדדים
מחשבון הצמדה למדד
משיכת מדדים עיקריים
משיכת כל המדדים לפי בסיסים שונים

משיכת נושאי המדדים:

רשימת הנושאים המלאה
רשימת הנושאים לפי לרמות

רשימת הנושאים המלאה

תבנית

https://api.cbs.gov.il/index/catalog/tree

פרמטרים

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
periodM/Q/MQ/QMתדירות עדכון הנתונים (M-חודשי/Q-רבעוני/MQ-חודשי+רבעוני)MQX
qstringטקסט לחיפוש---X
string_match_typebegins_with/contains/equalsתנאי החיפוש (מתחיל עם/מכיל/שווה)containsX

דוגמאות

משיכת נושאי המדדים - שם וקוד עבור כל מדד בפורמט XML

https://api.cbs.gov.il/index/catalog/tree?format=xml&download=false

 

משיכת נושאי המדדים והקודים שלהם עבור מדדים המכילים מלל מסוים

תעשייה=https://api.cbs.gov.il/index/catalog/tree?format=json&download=false&q

 

משיכת נושאי המדדים המתעדכנים ברמה החודשית

https://api.cbs.gov.il/index/catalog/tree?format=xml&download=false&period=M

 

רשימת הנושאים לפי לרמות:

רשימת פרקים
רשימת נושאים לפי פרק
רשימת קודים לפי נושא

רשימת פרקים

תבנית

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

דוגמאות

משיכת רשימת הפרקים של מדדי המחירים

https://api.cbs.gov.il/index/catalog/catalog?format=xml&download=false

 

רשימת נושאים לפי פרק

תבנית

https://api.cbs.gov.il/index/catalog/chapter

פרמטרים

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
idstringקוד הפרק---V

דוגמאות

משיכת נושאים של פרק מסוים ממדדי המחירים

https://api.cbs.gov.il/index/catalog/chapter?id=a&format=xml&download=false

 

רשימת קודים לפי נושא

תבנית

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

פרמטרים

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
idnumberמספר הנושא---V
qstringטקסט לחיפוש---X
string_match_typebegins_with/contains/equalsתנאי החיפוש (מתחיל עם/מכיל/שווה)containsX

דוגמאות

משיכת הקודים של סדרות המדדים לפי נושא מסוים

https://api.cbs.gov.il/index/catalog/subject?id=37&format=xml&download=false

 

משיכת הקודים של סדרות המדדים לפי נושא ספציפי ותיאור שמכיל מלל מסוים

פירות=https://api.cbs.gov.il/index/catalog/subject?id=37&format=xml&download=false&q

 

משיכת נתוני המדדים

תבנית

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

פרמטרים

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
idnumberקוד המדד---V
startPeriodmm-yyyyמתאריך01-1900X
endPeriodmm-yyyyעד תאריך01-2100X
lastnumber>0מספר האובייקטים למשיכה מהסדרה/ות החל מהערכים הכי מעודכנים והלאההכלX
coeftrue/falseהוספת מקדםfalseX

דוגמאות

משיכת נתוני מדד מסוים לפי קוד המדד

https://api.cbs.gov.il/index/data/price?id=120010&format=xml&download=false

 

משיכת נתוני מדד מסוים בתאריכים מסוימים

https://api.cbs.gov.il/index/data/price?id=120010&format=xml&download=false&startPeriod=01-2000&endPeriod=12-2019

 

משיכת הערכים האחרונים של מדד מסוים כולל מקדמי קשר

https://api.cbs.gov.il/index/data/price?id=120010&format=xml&download=false&last=2&coef=true

 

מחשבון הצמדה למדד

תבנית

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

פרמטרים

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
idnumberקוד המדד---V
valuenumber>0סכום ההצמדה---V
datemm-dd-yyyy/yyyy-mm-ddמתאריך---V
toDatemm-dd-yyyy/yyyy-mm-ddעד תאריך---V
currencynew_sheqel/old_sheqel/liraסוג מטבעnew_sheqelX

דוגמאות

חישוב מדד

https://api.cbs.gov.il/index/data/calculator/120010?value=100&date=01-01-2018&toDate=01-01-2019&format=xml&download=false

 

חישוב מדד לפי ערכי לירה

https://api.cbs.gov.il/index/data/calculator/120010?value=100&date=01-01-2000&toDate=12-01-2019&currency=lira&format=xml&download=false

 

משיכת מדדים עיקריים:

משיכת מדדים עיקריים לפי בסיסים שונים
משיכת מדדים עיקריים
משיכת מדדים עיקריים לפי תקופות

משיכת מדדים עיקריים לפי בסיסים שונים

תבנית

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

פרמטרים

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
oldformat*
true/false
תיקונים להתאמה לפורמט הישן בעיקר בנוגע לעברית , רווחים , סדר הצגה ב base 
false
X


* עדכון

דוגמאות*

משיכת המדדים העיקריים בבסיסים שונים

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

משיכת המדדים העיקריים בבסיסים שונים בפורמט הישן

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

 * כרגע התמיכה היא בפורמט XML בלבד ,

ברירת מחדל oldformat=false&format=xml&download=false


משיכת מדדים עיקריים

תבנית

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

דוגמא*

משיכת המדדים העיקריים
https://api.cbs.gov.il/index/data/price_selected_b

 * כרגע התמיכה היא בפורמט XML בלבד.

משיכת מדדים עיקריים לפי תקופות


תבנית

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


פרמטרים

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
StartDateyyyymm
מתאריך199701
(מינימום)
V
EndDateyyyymm
עד תאריך---
V


דוגמא*

משיכת המדדים העיקריים
מ-01/1997 עד- 03/2021 

 * כרגע התמיכה היא בפורמט XML בלבד.



משיכת כל המדדים לפי בסיסים שונים

תבנית

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

פרמטרים

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
oldformattrue/falseתיקונים להתאמה לפורמט הישן בעיקר בנוגע לעברית , רווחים , סדר הצגה ב base falseX
chapterstring

ניתן לסנן לפי פרק מסוים

את רשימת הפרקים ניתן למצוא ב:

https://api.cbs.gov.il/Index/Catalog/Catalog

chapter=chaptereid  *

פרק* תיאור
aמדד המחירים לצרכן
aaמדד ומחירים ממוצעים משוק הדירות
bמדד מחירי יצרן - תפוקת התעשייה ליעדים מקומיים
baמדד מחירי יצרן - יצוא בענפי התעשייה, כרייה וחציבה
bbמדד מחירי יצרן - ענפי השירותים
cמדד מחירי תשומה בבנייה למגורים
caמדד מחירי תשומה בבנייה למסחר ולמשרדים
dמדד מחירי תשומה בסלילה וגישור
eמדד מחירי תשומה בחקלאות
fמדד מחירי תשומה באוטובוסים
faמדד מחירי תשומה באוטובוסים זעירים ציבוריים

""

כל הפרקים

X


דוגמאות*

משיכת המדדים בבסיסים השונים 

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

משיכת המדדים בבסיסים השונים באנגלית

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

 משיכת המדדים בבסיסים השונים בפורמט הישן

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

 משיכת המדדים בבסיסים השונים עבור פרק a

מדד המחירים לצרכן

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

 * כרגע התמיכה היא בפורמט XML בלבד

ברירת מחדל format=xml&download=false&chapter=&oldformat=false