Search project units
GET/project-units
Units across all projects: active listings linked to a project, filtered by the unit (bedrooms, price, area) and by its project (city, developer, status). A listing linked to several projects appears once, under its strongest link. Units priced implausibly low for their city (installments, typos) are left out.
- Authentication
- Send a data key (dk_live_… or dk_test_…) as a Bearer token.
- Scope
projects- Cost
- NaN units per call
Parameters
| Name | Type | Description |
|---|---|---|
cityquery | string | Omit for all cities. |
neighborhood_idquery | integer[] | Neighborhood ids from GET /cities/{city}/neighborhoods; matches the unit's neighborhood, or its project's when the unit has none. |
developerquery | string | Exact developer name, as returned by GET /developers. |
statusquery | string[] | One or more, comma-separated. One of: |
project_typequery | string | One of: |
listing_categoryquery | string | Omit for both. One of: |
featuresquery | string[] | Only projects with all of these, see GET /enums. |
banksquery | string[] | Only projects financed by all of these, see GET /enums. |
listing_typequery | string | Omit for both. Most project units are for sale; some are rentals. One of: |
property_typequery | string[] | One or more, comma-separated. One of: |
bedroomsquery | integer | Exact number of bedrooms. |
bedrooms_minquery | integer | |
bedrooms_maxquery | integer | |
bathroomsquery | integer | Exact number of bathrooms. |
bathrooms_minquery | integer | |
price_minquery | integer | SAR. Compared with |
price_maxquery | integer | |
area_minquery | number | Square meters. |
area_maxquery | number | |
sortquery | string |
One of: |
limitquery | integer | |
cursorquery | string |
Response
The data field is a list; each item has these fields.
| Name | Type | Description |
|---|---|---|
idrequired | integer | Listing id; GET /listings/{id} returns the full listing (with the |
urlrequired | string | The listing's page on kite.sa. |
projectrequired | object | |
linkrequired | object | How the listing was tied to the project: |
titlerequired | string | null | |
listing_typerequired | string | One of: |
property_typerequired | string | |
sale_price_sarrequired | integer | null | Total purchase price in SAR. Null for rentals. |
Example request
curl "https://api.kite.sa/v1/project-units" \
-H "Authorization: Bearer $KITE_API_KEY"import { Kite } from "@kite-sa/sdk";
const kite = new Kite(); // reads KITE_API_KEY
const result = await kite.projects.unitsSearch();from kite_sa import Kite
kite = Kite() # reads KITE_API_KEY
result = kite.projects.units_search()Open in the interactive reference
Related endpoints
- Search projects
GET /projects - Get a project
GET /projects/{id} - List a project's units
GET /projects/{id}/units - List developers
GET /developers