API-Dictionary

CBS Dictionaries

A list of dictionaries and parameters is in the appendix below.

General Search

Template: https://api.cbs.gov.il /dictionary/{subject}/{resource}

Parameters:

Field	Type	Explanation	Default
*subject*	string	Subject name
*resource*	string	Resource name
q	string	Text to search	""
*string_match_type*	BEGINS_WITH CONTAINS EQUALS	Type of searching	begins_with
*sort*	string	+field/-field	""
*expand*	True/false up/down resource1.resource2, resource3….		true
*fields*	F1,f2,r2.f3,r2.f4	Fields list (field/resource.field)	*
*filter*	f1={xxx}&f2={xxx}
*Page*	Int>0	Page number	1
*Page_size*	Int>0	Page size	100 Max: 250

* Browsing support

Examples:

https://api.cbs.gov.il/Dictionary/geo/localities

Expand

https://api.cbs.gov.il/Dictionary/geo/localities?expand=true&format=xml&download=False&page=1&page_size=50

q(query):

https://api.cbs.gov.il/Dictionary/geo/localities?q=jer&expand=false& format=xml&download=False&page=1&page_size=50

sort:

https://api.cbs.gov.il/Dictionary/geo/localities?expand=false&sort=name_heb&format=xml&download=False&page=1&page_size=50

fields:

https://api.cbs.gov.il/Dictionary/geo/localities?expand=false&fields=name_eng,name_heb&format=xml&download=False&page=1&page_size=50

filter:

https://api.cbs.gov.il/Dictionary/geo/localities?organization=2&district=6&expand=false&format=xml&download=False&page=1&page_size=50

Output:

Depending on the dictionary requested

Specific Search

Template:

https://api.cbs.gov.il /dictionary/{subject}/{resource}/{id}

Parameters:

Field	Type	Explanation	Default
subject	string	Subject name
resource	string	Resource name
id	string	Resource id
sort	+-F1,+-f2	+field/-field
expand	True/false/up/down/resource1.resource2, resource3….		true
fields	F1,f2,r2.f3,r2.f4	Fields list (field/resource.field)	*
*Page*	Int>0	Page number	1
*Page_size*	Int>0	Page size	100 Max: 250

* Browsing support

Example:

https://api.cbs.gov.il/Dictionary/Geo/localities/7?expand=true

https://api.cbs.gov.il/Dictionary/geo/localities?id=7&expand=true&format=xml&download=False&page=1&page_size=50

Output:

Depending on the dictionary requested

Appendix of Dictionaries

List of Dictionaries

List of Parameters

List of Dictionaries

*Subject*	*Resource*
Geo	districts
Geo	population_groups
Geo	municipal_or_council_status
Geo	metropolins
Geo	natural_areas
Geo	organizational_affiliations
Geo	planning_committee
Geo	regions
Geo	religions
Geo	locality_types
Geo	localities

List of Parameters

Shared Parameters

Unique Parameters

Shared Parameters

*Parameter*	*Description*
id	External ID This is part of the key, together with the year
Year	Year This is part of the key, together with the ID

name_heb	Name in Hebrew
name_eng	Name in English

Unique Parameters

https://api.cbs.gov.il/Dictionary/geo/localities

Parameter	Dictionary
year	localities
id	localities
name_heb	localities
name_eng	localities
district	localities
region	localities
natural_area	localities
planning_committee	localities
municipal_or_council_status_symbol	localities
metropolin	localities
locality_type	localities
organization	localities
religion	localities
total_population	localities
total_jews_and_others	localities
total_jews	localities
total_arabs	localities

https://api.cbs.gov.il/Dictionary/geo/districts

*Parameter*	*Dictionary*
year	districts
id	districts
name_heb	districts
name_eng	districts

https://api.cbs.gov.il/Dictionary/geo/regions

*Parameter*	*Dictionary*
year	regions
id	regions
name_heb	regions
name_eng	regions

https://api.cbs.gov.il/Dictionary/geo/natural_areas

*Parameter*	*Dictionary*
year	natural_areas
id	natural_areas
name_heb	natural_areas
name_eng	natural_areas

https://api.cbs.gov.il/Dictionary/geo/planning_committee

*Parameter*	*Dictionary*
year	planning_committee
id	planning_committee
name_heb	planning_committee
name_eng	planning_committee

https://api.cbs.gov.il/Dictionary/geo/municipal_or_council_status

*Parameter*	*Dictionary*
year	municipal_or_council_status
id	municipal_or_council_status
name_heb	municipal_or_council_status
name_eng	municipal_or_council_status

https://api.cbs.gov.il/Dictionary/geo/Metropolins

*Parameter*	*Dictionary*
year	metropolins
id	metropolins
name_heb	metropolins
name_eng	metropolins

https://api.cbs.gov.il/Dictionary/geo/locality_types

*Parameter*	*Dictionary*
year	locality_types
id	locality_types
name_heb	locality_types
name_eng	locality_types

https://api.cbs.gov.il/Dictionary/geo/organizational_affiliations

*Parameter*	*Dictionary*
year	organizational_affiliations
id	organizational_affiliations
name_heb	organizational_affiliations
name_eng	organizational_affiliations

https://api.cbs.gov.il/Dictionary/geo/Religions

*Parameter*	*Dictionary*
year	religions
id	religions
name_heb	religions
name_eng	religions

https://api.cbs.gov.il/Dictionary/geo/population_groups

*Parameter*	Dictionary
year	population_groups
id	population_groups
name_heb	population_groups
name_eng	population_groups