כניסה

עורך תוכן
​​​

ה-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 והלאה

דוגמאות

משיכת רשימת נושאי הסדרות - רמה 1 בפורמט XML

https://apis.cbs.gov.il/series/catalog/level?id=1&format=xml&download=false

 
משיכת רשימת נושאי הסדרות - רמה 1 בפורמט JSON

https://apis.cbs.gov.il/series/catalog/level?id=1&format=json&download=false

 
משיכת רשימת נושאי הסדרות - רמה 1 בפורמט XLS להורדה

https://apis.cbs.gov.il/series/catalog/level?id=1&format=xls&download=true

 
רשימת נושאי הסדרות רמה 2 בפורמט XML

https://apis.cbs.gov.il/series/catalog/level?id=2&subject=2&format=xml&download=false

 
משיכת רשימת נושאי הסדרות רמה 3 בפורמט XML

https://apis.cbs.gov.il/series/catalog/level?id=3&subject=2&format=xml&download=false

 
משיכת רשימת נושאי הסדרות רמה 4 בפורמט XML

https://apis.cbs.gov.il/series/catalog/level?id=4&subject=2&format=xml&download=false

 
משיכת רשימת נושאי הסדרות רמה 5 בפורמט XML

https://apis.cbs.gov.il/series/catalog/level?id=5&subject=2&format=xml&download=false

 


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

תבנית

https://apis.cbs.gov.il/series/catalog/path

פרמטרים

מאפיין סוג הסבר ברירת מחדל פרמטר חובה
id L1,L2,L3,L4,L5 קוד נושאי הרמות --- V

דוגמאות

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

https://apis.cbs.gov.il/series/catalog/path?id=2,1,1,2,379&format=xml&download=false

 
משיכת נושאי הסדרות שקוד הרמה הראשונה שלהם 2 והשנייה-1

https://apis.cbs.gov.il/series/catalog/path?id=2,1&format=xml&download=false

 


משיכת נתוני סדרות

נתונים לפי קודי הסדרות
נתונים לפי נתיב

נתונים לפי קודי הסדרות

תבנית

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/list?id=3763&format=xml&download=false

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

https://apis.cbs.gov.il/series/data/list?id=3763&startperiod=01-2000&endperiod=12-2019&format=xml&download=false

 


נתונים לפי נתיב

תבנית

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

 

 



​
​

(מוסתרת) הנחיות למשיכת סדרות עיתיות באמצעות ממשק ה-API

אופן משיכת סדרות עיתיות באמצעות ממשק ה-API

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

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

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

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

lang
רצוי
he / en
סוג שפה (עברית / אנגלית)
ברירת מחדל: he
format
רצוי
xml / json / csv / xls
סוג פורמט
ברירת מחדל: תלוי בדפדפן
download
רצוי
true / false
הורדה כקובץ (true) או הצגה בדפדפן (false)
ברירת מחדל: תלוי בדפדפן
page
אופציונלי
number
מספר דף נוכחי
ברירת מחדל: 1
pagesize
אופציונלי
number
כמות אובייקטים בדף. מקסימום: 1,000
ברירת מחדל: 100

משיכת נושאי הסדרות

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

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

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

תבנית:
https://apis.cbs.gov.il/series/catalog/level

פרמטרים

id
חובה
LX
מספר רמה
subject
חובה מרמה 2
number
קוד רמה הראשונה

דוגמאות

תיאורכתובת URL
משיכת נושאי הסדרות – רמה 1 בפורמט XMLhttps://apis.cbs.gov.il/series/catalog/level?id=1&format=xml&download=false
משיכת נושאי הסדרות – רמה 1 בפורמט JSONhttps://apis.cbs.gov.il/series/catalog/level?id=1&format=json&download=false
משיכת נושאי הסדרות – רמה 1 בפורמט XLS להורדהhttps://apis.cbs.gov.il/series/catalog/level?id=1&format=xls&download=true
רשימת נושאי הסדרות רמה 2 בפורמט XMLhttps://apis.cbs.gov.il/series/catalog/level?id=2&subject=2&format=xml&download=false
משיכת נושאי הסדרות רמה 3 בפורמט XMLhttps://apis.cbs.gov.il/series/catalog/level?id=3&subject=2&format=xml&download=false
משיכת נושאי הסדרות רמה 4 בפורמט XMLhttps://apis.cbs.gov.il/series/catalog/level?id=4&subject=2&format=xml&download=false
משיכת נושאי הסדרות רמה 5 בפורמט XMLhttps://apis.cbs.gov.il/series/catalog/level?id=5&subject=2&format=xml&download=false

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

תבנית:
https://apis.cbs.gov.il/series/catalog/path

פרמטרים

id
חובה
L1, L2, L3, L4, L5
קוד נושאי הרמות

דוגמאות

תיאורכתובת URL
משיכת נושא הסדרה לפי הנתיבhttps://apis.cbs.gov.il/series/catalog/path?id=2,1,1,2,379&format=xml&download=false
משיכת נושאי סדרות שקוד רמה ראשונה 2 ורמה שנייה 1https://apis.cbs.gov.il/series/catalog/path?id=2,1&format=xml&download=false

משיכת נתוני סדרות

נתונים לפי קודי הסדרות נתונים לפי נתיב

נתונים לפי קודי הסדרות

תבנית:
https://apis.cbs.gov.il/series/data/list

פרמטרים

id
חובה
number
קוד/י הסדרה/ות
startPeriod
אופציונלי
mm-yyyy
מתאריך
ברירת מחדל: 01-1900
endPeriod
אופציונלי
mm-yyyy
עד תאריך
ברירת מחדל: 01-2100
last
אופציונלי
number > 0
מספר האובייקטים למשיכה החל מהערכים המעודכנים ביותר
ברירת מחדל: הכל
addNull
אופציונלי
true / false
כולל ערכים ריקים או לא
ברירת מחדל: true
data_hide
אופציונלי
true / false
להסתיר נתונים ולהשאיר מטא-דאטה בלבד
ברירת מחדל: false

דוגמאות

תיאורכתובת URL
משיכת סדרה ספציפית על פי הקוד שלהhttps://apis.cbs.gov.il/series/data/list?id=3763&format=xml&download=false
משיכת נתוני סדרה ספציפית בין תאריכים מסוימיםhttps://apis.cbs.gov.il/series/data/list?id=3763&startperiod=01-2000&endperiod=12-2019&format=xml&download=false

נתונים לפי נתיב

תבנית:
https://apis.cbs.gov.il/series/data/path

פרמטרים

id
חובה
L1, L2, L3, L4, L5
קוד נושאי הרמות
startPeriod
אופציונלי
mm-yyyy
מתאריך
ברירת מחדל: 01-1900
endPeriod
אופציונלי
mm-yyyy
עד תאריך
ברירת מחדל: 01-2100
time
אופציונלי
number
יחידת זמן ספציפית
ברירת מחדל: הכל
data
אופציונלי
number
סוג נתונים ספציפי
ברירת מחדל: הכל
price
אופציונלי
number
סוג מחיר ספציפי
ברירת מחדל: הכל
calc
אופציונלי
number
סוג חישוב ספציפי
ברירת מחדל: הכל
unit
אופציונלי
number
יחידת מידה ספציפית
ברירת מחדל: הכל
last
אופציונלי
number > 0
מספר האובייקטים למשיכה החל מהערכים המעודכנים ביותר
ברירת מחדל: הכל
addNull
אופציונלי
true / false
כולל ערכים ריקים או לא
ברירת מחדל: true
data_hide
אופציונלי
true / false
להסתיר נתונים ולהשאיר מטא-דאטה בלבד
ברירת מחדל: false

דוגמאות

תיאורכתובת URL
משיכת נתוני סדרה/ות שמתאימות לנתיב המסויםhttps://apis.cbs.gov.il/series/data/path?id=2,1,1,2,379&format=xml&download=false
משיכת מטא-דאטה עבור סדרות שקוד נושא רמה ראשונה שלהם הוא 2https://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​