הנחיות למשיכת סדרות עיתיות באמצעות ממשק ה-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 | --- |
משיכת נושאי הסדרות
משיכת נתוני סדרות
משיכת נושאי הסדרות
הרשימה של נושאי הסדרות מחולקת לחמש רמות, כל רמה מכילה את תתי הנושאים של הרמה שמעליה.
כלומר, הרמה הראשונה כוללת את הנושאים העיקריים, הרמה השנייה כוללת את תתי הנושאים של הרמה הראשונה וכן הלאה.
רשימת נושאים לפי רמה
רשימת נושאים לפי נתיב
רשימת נושאים לפי רמה
תבנית
https://apis.cbs.gov.il/series/catalog/level
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| id | LX | מספר רמה | --- | V |
| subject | number | קוד רמה הראשונה | --- | V - מרמה 2 והלאה |
דוגמאות
רשימת נושאים לפי נתיב
תבנית
https://apis.cbs.gov.il/series/catalog/path
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| id | L1,L2,L3,L4,L5 | קוד נושאי הרמות | --- | V |
דוגמאות
משיכת נתוני סדרות
נתונים לפי קודי הסדרות
נתונים לפי נתיב
נתונים לפי קודי הסדרות
תבנית
https://apis.cbs.gov.il/series/data/list
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| id | number | קוד/י הסדרה/ות | --- | V |
| startPeriod | mm-yyyy | מתאריך | 01-1900 | X |
| endPeriod | mm-yyyy | עד תאריך | 01-2100 | X |
| last | number>0 | מספר האובייקטים למשיכה מהסדרה/ות החל מהערכים הכי מעודכנים והלאה | הכל | X |
| addNull | true/false | כולל ערכים ריקים או לא | true | X |
| data_hide | true/false | להסתיר את הדאטה - הנתונים ולהשאיר רק מטא-דאתה - מידע אודות הנתונים | false | X |
דוגמאות
נתונים לפי נתיב
תבנית
https://apis.cbs.gov.il/series/data/path
פרמטרים
|
מאפיין |
סוג |
הסבר |
ברירת מחדל |
פרמטר חובה |
| id | L1,L2,L3,L4,L5 | קוד נושאי הרמות | --- | V |
| startPeriod | mm-yyyy | מתאריך | 01-1900 | X |
| endPeriod | mm-yyyy | עד תאריך | 01-2100 | X |
| time | number | יחידת זמן ספציפית | הכל | X |
| data | number | סוג נתונים ספציפי | הכל | X |
| price | number | סוג מחיר ספציפי | הכל | X |
| calc | number | סוג חישוב ספציפי | הכל | X |
| unit | number | יחידת מידה ספציפית | הכל | X |
| last | number>0 | מספר האובייקטים למשיכה מהסדרה/ות החל מהערכים הכי מעודכנים והלאה | הכל | X |
| addNull | true/false | כולל ערכים ריקים או לא | true | X |
| data_hide | true/false | להסתיר את הדאטה - הנתונים ולהשאיר רק מטא-דאתה - מידע אודות הנתונים | false | X |
דוגמאות
| משיכת נתוני סדרה/ות שמתאימות לנתיב המסוים |
https://apis.cbs.gov.il/series/data/path?id=2,1,1,2,379&format=xml&download=false |
| משיכת מטא-דאתה עבור הסדרה/ות שקוד נושא רמה ראשונה שלהם הוא 2 |
https://apis.cbs.gov.il/series/data/path?id=2&data_hide=true&format=xml&download=false |
| שליפת נתוני סדרה/ות בנתיב המסוים ביחידת זמן של שנה |
https://apis.cbs.gov.il/series/data/path?id=2,1,1,2,379&time=1&format=xml&download=false |
| שליפת נתוני הסדרה/ות בתאריכים מסוימים בנתיב הספציפי |
https://apis.cbs.gov.il/series/data/path?id=2,1,1,2,379&startperiod=01-2000&endperiod=12-2020&format=xml&download=false |
| שליפת שני הנתונים האחרונים (-המעודכנים ביותר) של הסדרה/ות בנתיב הספציפי |
https://apis.cbs.gov.il/series/data/path?id=2,1,1,2,379&last=2&format=xml&download=false |
