Skip to main content
GET
Search Locations

Query parameters

At least one of city or district is required.
string
City name to search. Accepts Arabic or English, and handles partial/transliterated input (e.g. "ryad" matches "Riyadh"). Minimum 2 characters.When used alone, returns matching city results. When used alongside district, scopes the district search to that city.
string
District or neighbourhood name to search. Accepts Arabic or English. Minimum 2 characters.When used alone, searches districts across all cities. When used with city, scopes results to that city.
boolean
Pass true alongside city to return all districts of that city as a city object. No search is performed — every district is returned.

Response

Search response (object: "list")

Returned for city and district searches.
string
Always "list" for search responses.
array
Matching cities and/or districts, max 20 per request.
number
Number of items returned.
string
Only present when city was supplied but no city matched. Contains a hint to verify the city name.

City object response (object: "city")

Returned when districts=true is passed alongside city.
string
Always "city".
number
City numeric ID.
string
Official Arabic name.
string
English transliteration.
array
All districts in this city. Each item has id, name_ar, name_en.

Examples