הנחיות למשיכת מדדים באמצעות ממשק ה-API
ה-API מספק סט פקודות שבאמצעותו ניתן למשוך את רשימת הנושאים של המדדים, וסט פקודות נוסף שמאפשר משיכה של נתוני המדדים.
עדכון
הערות - מדד מחירי הדירות
פרמטרים כלליים
פרמטרים שניתן להוסיף באופן כללי לשאילתות ה-API לצורך הגדרת הפורמט, השפה, מספר אובייקטים בדף וכדומה.
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| lang | he/en | סוג שפה (עברית/אנגלית) | he | --- |
| format | xml/json/csv/xls | סוג פורמט | תלוי בסוג הדפדפן, מומלץ להגדיר את הפורמט הרצוי | רצוי |
download
| true/false | מגדיר אם הנתונים ירדו כקובץ פיזי (true) או יוצגו בדפדפן (false) | תלוי בפורמט ובסוג הדפדפן, מומלץ להגדיר את האופן הרצוי | רצוי
|
| page | number | מספר דף נוכחי (current_page) | 1 | --- |
pagesize
| number | כמות האובייקטים שיופיעו בדף (page_size), מקסימום - 1000 | 100 | --- |
הערות - מדד מחירי הדירות
1. מדד מחירי הדירות הוא מדד דו-חודשי. לפיכך, המדד שפורסם ב-15 בחודש מסוים (t) מתבסס על השוואת עסקאות שבוצעו לפני חודשיים ולפני שלושה חודשים (כלומר t-2 ו-t-3) לעומת עסקאות שבוצעו לפני שלושה וארבעה חודשים (כלומר t-3 ו-t-4). לדוגמה, בשימוש במחשבון עבור מועד בין ה-16 ביולי ל-15 באוגוסט, המדד האחרון שפורסם מתבסס על עסקאות שבוצעו בחודשים אפריל-מאי לעומת עסקאות שבוצעו בחודשים מרץ-אפריל.
2. בניגוד למדדים האחרים המתפרסמים בסדרה זו, שלושת המדדים האחרונים של מדד מחירי הדירות הם ארעיים ועשויים להתעדכן עם קבלת דיווח על עסקאות נוספות שנעשו באותם חודשים. אי לכך, הצמדה לתקופה שבה המדד עדיין ארעי אינה מומלצת.
תוכן עניינים:
משיכת נושאי המדדים
משיכת נתוני המדדים
מחשבון הצמדה למדד
משיכת מדדים עיקריים
משיכת כל המדדים לפי בסיסים שונים
משיכת נושאי המדדים:
רשימת הנושאים המלאה
רשימת הנושאים לפי לרמות
רשימת הנושאים המלאה
תבנית
https://api.cbs.gov.il/index/catalog/tree
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| period | M/Q/MQ/QM | תדירות עדכון הנתונים (M-חודשי/Q-רבעוני/MQ-חודשי+רבעוני) | MQ | X |
| q | string | טקסט לחיפוש | --- | X |
| string_match_type | begins_with/contains/equals | תנאי החיפוש (מתחיל עם/מכיל/שווה) | contains | X |
דוגמאות
רשימת הנושאים לפי לרמות:
רשימת פרקים
רשימת נושאים לפי פרק
רשימת קודים לפי נושא
רשימת פרקים
תבנית
https://api.cbs.gov.il/index/catalog/catalog
דוגמאות
רשימת נושאים לפי פרק
תבנית
https://api.cbs.gov.il/index/catalog/chapter
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| id | string | קוד הפרק | --- | V |
דוגמאות
רשימת קודים לפי נושא
תבנית
https://api.cbs.gov.il/index/catalog/subject
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| id | number | מספר הנושא | --- | V |
| q | string | טקסט לחיפוש | --- | X |
| string_match_type | begins_with/contains/equals | תנאי החיפוש (מתחיל עם/מכיל/שווה) | contains | X |
דוגמאות
משיכת נתוני המדדים
תבנית
https://api.cbs.gov.il/index/data/price
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| id | number | קוד המדד | --- | V |
| startPeriod | mm-yyyy | מתאריך | 01-1900 | X |
| endPeriod | mm-yyyy | עד תאריך | 01-2100 | X |
| last | number>0 | מספר האובייקטים למשיכה מהסדרה/ות החל מהערכים הכי מעודכנים והלאה | הכל | X |
| coef | true/false | הוספת מקדם | false | X |
דוגמאות
מחשבון הצמדה למדד
תבנית
https://api.cbs.gov.il/index/data/calculator/{id}
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| id | number | קוד המדד | --- | V |
| value | number>0 | סכום ההצמדה | --- | V |
| date | mm-dd-yyyy/yyyy-mm-dd | מתאריך | --- | V |
| toDate | mm-dd-yyyy/yyyy-mm-dd | עד תאריך | --- | V |
| currency | new_sheqel/old_sheqel/lira | סוג מטבע | new_sheqel | X |
דוגמאות
משיכת מדדים עיקריים:
משיכת מדדים עיקריים לפי בסיסים שונים
משיכת מדדים עיקריים
משיכת מדדים עיקריים לפי תקופות
משיכת מדדים עיקריים לפי בסיסים שונים
תבנית
https://api.cbs.gov.il/index/data/price_selected
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
oldformat*
| true/false
| תיקונים להתאמה לפורמט הישן בעיקר בנוגע לעברית , רווחים , סדר הצגה ב base
| false
| X
|
* כרגע התמיכה היא בפורמט XML בלבד ,
ברירת מחדל
oldformat=false&format=xml&download=false
משיכת מדדים עיקריים
תבנית
https://api.cbs.gov.il/index/data/price_selected_b
* כרגע התמיכה היא בפורמט XML בלבד.
משיכת מדדים עיקריים לפי תקופות
תבנית
https://api.cbs.gov.il/index/data/price_selected_b
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| StartDate | yyyymm
| מתאריך | 199701
(מינימום)
| V
|
| EndDate | yyyymm
| עד תאריך | ---
| V
|
משיכת המדדים העיקריים
מ-01/1997 עד- 03/2021
|
|
* כרגע התמיכה היא בפורמט XML בלבד.
משיכת כל המדדים לפי בסיסים שונים
תבנית
https://api.cbs.gov.il/index/data/price_all
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| oldformat | true/false | תיקונים להתאמה לפורמט הישן בעיקר בנוגע לעברית , רווחים , סדר הצגה ב base | false | X |
| chapter | string | ניתן לסנן לפי פרק מסוים את רשימת הפרקים ניתן למצוא ב:
https://api.cbs.gov.il/Index/Catalog/Catalog chapter=chaptereid * |
פרק* |
תיאור | | a | מדד המחירים לצרכן | | aa | מדד ומחירים ממוצעים משוק הדירות | | b | מדד מחירי יצרן - תפוקת התעשייה ליעדים מקומיים | | ba | מדד מחירי יצרן - יצוא בענפי התעשייה, כרייה וחציבה | | bb | מדד מחירי יצרן - ענפי השירותים | | c | מדד מחירי תשומה בבנייה למגורים | | ca | מדד מחירי תשומה בבנייה למסחר ולמשרדים | | d | מדד מחירי תשומה בסלילה וגישור | | e | מדד מחירי תשומה בחקלאות | | f | מדד מחירי תשומה באוטובוסים | | fa | מדד מחירי תשומה באוטובוסים זעירים ציבוריים |
|
""
כל הפרקים |
X |
דוגמאות*
* כרגע התמיכה היא בפורמט XML בלבד
ברירת מחדל format=xml&download=false&chapter=&oldformat=false
