Dictionaries & Enums

amenities

Description

Represents the list of amenities associated with a given project.
Amenities describe available infrastructure, lifestyle features, and services such as pools, gyms, gardens, sports courts, retail zones, kids’ areas, etc.

The field is typically used to:

• populate feature lists in project detail pages;
• display amenity badges or icons;
• enable user filtering (“projects with pool”, “projects with gym”) in UI;
• describe the character and class of the development (luxury, family-friendly, resort style).

Amenity data is stored as an array of strings.
Values are not fully normalized and may vary between projects; therefore, consuming applications may apply categorization or tagging on their side.

Meta

Allowed values

area_unit

Description

Defines the measurement system used to represent unit area values (e.g., sq. ft or sq. m).
Applicable to layouts or unit detail responses.
The area unit ensures correct formatting and conversion in UI.

This field is essential for:

• displaying unit areas consistently;
• switching between measurement systems (sqm ↔ sqft);
• making pricing comparisons (price per sq.ft or per sq.m).

Meta

Allowed values

bedrooms

Description

Represents the number of bedrooms in a unit.
The value is always numeric, and may include whole numbers or fractional values.

This field uses a unified numeric model to represent both standard bedroom counts and units with additional auxiliary rooms (e.g., maid’s room, study, storage).
The API does not return descriptive labels such as “Studio” or “2+Maids” — instead it encodes all variations through numeric values.

Value Interpretation

Fractional values (N + 0.5) indicate that the unit includes an extra functional space that is not counted as a full bedroom but is relevant for classification and filtering.

Notes

• The API always returns numeric values, not strings.
• The set of possible values is dynamic: it depends on actual units available in the project and can include large bedroom counts (e.g., 11).
• Fractional values should be treated strictly as “N bedrooms + auxiliary room” and not rounded or normalized on the client side.

Typical Usage Example (Units API)

{
  "id": 365944,
  "name": "106",
  "bedrooms": 1.5,
  "size": 847.0,
  "status": "available",
  "unit_type": "apartments"
}

building_id

Description
Represents the internal identifier of a specific building within a multi-building project.
Some projects contain several buildings (e.g., Tower A, Tower B, Villas cluster).
The building_id value links a unit or floor plan to the corresponding building record from the Buildings dataset.
If a project has only one building, the field may still be present but often remains null.

Meta

Allowed values

city

Description
Specifies the city where the project is located.
This field is part of the hierarchical location block: country → region → city → district → sector → village.
The field may be null for locations where the concept of “city” does not apply or where data was not supplied by the developer.
Used for sorting, filtering, displaying breadcrumbs, and mapping UI components.

Meta

Allowed values

completion_datetime

Description
Represents the officially declared planned completion date of the project, returned as an ISO-8601 datetime string.
This date is typically provided by the developer or extracted from government registries.
Used to determine delivery timelines, categorize presale inventory, display construction progress, and group projects by expected readiness.
The field can be missing or replaced with quarterly notation (e.g., Q2 2028) in some data sources; in such cases, the API may present both completion_datetime and a separate completion_date string.

Meta

Allowed values

completion_date

Description
Represents the publicly communicated delivery date of the project in a human-readable format such as "Q2 2028" or "2027".
This field complements completion_datetime:

• completion_datetime — machine-readable ISO date (when available)
• completion_date — marketing or developer-declared timeline, often less precise
  Used in UI for project cards, sorting, filtering by completion year/quarter, and in brochures where the exact date is not yet finalized.

Meta

Allowed values

construction_end_date

Description
Indicates the planned or registered end date of construction, when works are expected to be fully completed.
The field is returned as an ISO-8601 date string.
Used for compliance checks, timeline tracking, status determination (under_construction → completed), and filtering projects by delivery period.
If the project is in a very early stage, this value may be undefined.

Meta

Allowed values

construction_start_date

Description
Represents the official or planned start date of construction for the project.
Not always provided by developers; may appear only for government-registered or already launched projects.
This field is used to assess project maturity, acceleration/slippage timelines, and to calculate construction duration where both start and end dates are known.

Meta

Allowed values

Construction_status

Description
Indicates the current development stage of the project in terms of construction progress.
This value is used to inform brokers and clients whether the project is already built, under development, or still at a pre-construction stage. It also influences filtering, marketing messages, and risk perception for buyers and investors.

Meta

Allowed values

country

Description
Represents the country identifier associated with a project or location.
This field stores a numeric ID referencing the Countries dictionary, not a textual name.
The API returns the country ID inside location objects, while the actual country name is retrieved through the /countries dictionary endpoint.
Used primarily for geographic filtering, mapping, analytics, and regional segmentation.

Meta

Allowed values

deposit_description

Description
Represents an optional textual note describing deposit requirements or conditions for purchasing a unit or participating in a project.
May include rules, minimum payment amounts, reservation conditions, or other financial details used in sales workflows.
Frequently appears empty because many developers do not provide deposit details in the API.

Meta

Allowed values

developer_id

Description
The numeric identifier of the developer company associated with a project.
Used as a foreign key to link project data with the Developers directory.
Required for categorization, filtering, analytics, and grouping projects by developer.

Meta

Allowed values

floor_plans

Description
A list of project-level floor plan documents, typically provided as PDFs.
These represent large architectural drawings or sets of unit layout materials.
Each entry contains:

• internal ID
• name (often auto-generated from upload path)
• file URL
• file type
• optional description

This differs from unit-level layout images, which are handled separately.

Meta

Allowed values

Each object contains:

furnishing

Description
Indicates the furnishing level provided by the developer for the units in this project.
Values vary significantly because different developers use different classification styles.
Used mostly for UI labeling and filtering.

Meta

Allowed values

general_plan

Description
A large project-level masterplan image, typically provided as a WebP/JPEG file.
Represents the full development layout: buildings, roads, landscape, orientation, etc.
Unlike layout (unit-level plans) or floor_plans (PDF documents), this is a visual site masterplan.

Meta

Allowed values

id

Description
The primary identifier for the object.
Used across all endpoints where an entity is returned in list or detail form.
IDs are integers and globally unique within their table, not across the whole system.

Meta

Allowed values

image

Description
A generic media object used across multiple sections:

• unit layouts (layout[].image)
• building cover images (buildings[].cover_image)
• lobby/interior/architecture galleries
• any other image-bearing media structure

The schema of image objects is uniform: each includes a URL and metadata such as MIME type, dimensions, and size.

Meta

Allowed values

interior

Description
A gallery of interior renderings/photos associated with the project.
Represents visual materials showing apartment, villa, lobby, or common-area interior design.
Each element in the array follows the standard image media schema (url + metadata).

Typical usage: displaying interior design previews in project detail pages.

Meta

Allowed values

Array of media objects, where each object contains:

is_published

Description
Boolean attribute that reflects whether the project is published and visible for API consumers.
If false, the project is hidden from lists but may still be accessible internally or through admin tools.

In public /projects responses, all returned projects are typically is_published = true.

Meta

Allowed values

latitude

Description
Represents the geographic latitude coordinate of the project’s location.
Used for map positioning, marker rendering, distance calculations, and geospatial filtering logic on the client side (though server-side geo-filtering is not implemented).

Value comes from the related location object returned inside Project details.

Meta

Allowed values

layout

Description
A unit layout object representing one or more floor plan images associated with a specific typical unit configuration.
Layouts belong to typical_units and show floor plan previews with ordering information.
Each layout contains a media object and an order field that determines the display sequence.

Meta

Allowed values

Layout array consists of objects with:

lobby

Description
A gallery of project lobby or entrance-area renderings.
Used to visually represent the primary public interior spaces of the development.
Each element follows the standard media schema and may contain high-resolution marketing images.

Meta

Allowed values

Each item is a standard media object:

location

Description
Represents the full geographic and administrative location object associated with a project.
Contains identifiers and descriptive geographic attributes such as country, region, district, coordinates, and polygon boundaries.
This is one of the core relational objects in Project details, used for map placement, filtering by geography, UI display, and integration with Regions / Districts dictionaries.

Meta

Allowed values

Example polygon structure:

"polygon": {
  "type": "LineString",
  "coordinates": [
    [54.8055342, 24.855569],
    [54.8054934, 24.855428]
  ]
}

longitude

Description
Represents the geographic longitude coordinate of the project’s location.
Used for map rendering, marker placement on /projects/markers, distance calculations, and geospatial UI interactions.

Value is included inside the embedded location object.

Meta

Allowed values

managing_company

Description
Represents the property management company associated with the project.
This field is rarely used and often null.
When populated, it typically contains a string with the company’s name.
Not tied to a dictionary or external reference. Intended for UI informational display.

Meta

Allowed values

marketing_brochure

Description
Represents a URL to an external marketing brochure or promotional document associated with the project.
Usually links to Google Drive, PDF storage, or other external document hosting services.
Used to provide buyers or brokers with additional downloadable materials (full brochure, marketing kit, specifications, etc.).

Field is optional and may be null.

Meta

Allowed values

max_price

Description
Defines the maximum price (in the project’s currency) among all units listed for the project.
Used for UI display, project comparison, filtering, and price range widgets.
Value is dynamically calculated based on unit data associated with the project.

Meta

Allowed values

max_size

Description
Represents the maximum unit size available within the project.
Used in search filters, comparative analytics, and project highlight blocks.
Measurement units correspond to the project’s area_unit (sqft or m2).

Meta

Allowed values

metadata

Description
Represents a metadata object attached to media files (images, PDFs, layout images, amenities icons, etc.).
It contains technical characteristics of a file such as MIME type, size, width, and height.
Used to correctly display media, optimize loading, and validate image or document properties.

Structure appears across various media collections:
cover_image, general_plan, lobby[], interior[], architecture[], layout.image, amenity icons, document files, etc.

Meta

Allowed values

min_price

Description
Represents the minimum price among all units belonging to the project.
Displayed in catalog listings and used for sorting, filtering, and highlighting affordability ranges.
Value corresponds to the project currency defined in price_currency.

Meta

Allowed values

min_size

Description
Represents the minimum unit size available within the project.
Useful for filters, UI comparison components, and analytics.
Uses the same measurement unit as the project (area_unit).

Meta

Allowed values

name

Description

Represents the official display name of an entity.
For projects, this is the commercial project name used in marketing materials.
For developers, it reflects the registered brand or company name.
For locations, it identifies the region, district, or micro-location as used in the Reelly catalog.
The value is always a string and should be used in UI listings, search results, breadcrumbs and selection controls.

Meta

Allowed values

ne_latitude

Description

Defines the northernmost latitude corner of the bounding box for regions or locations.
Together with sw_latitude, sw_longitude, and ne_longitude, it determines the rectangular geographic area containing all projects within that region.
Used primarily by mapping libraries (Google Maps, Mapbox, Leaflet) for auto-zooming to a region.

Meta

Allowed values

ne_longitude

Description

Defines the eastern boundary of the geographic bounding box for a region or project location.
Works together with ne_latitude to represent the top-right corner of the area used for map-level filtering, zooming, and clustering.

Meta

Allowed values

cover_image

Description
Represents the main visual image of a project or building.
Usually displayed as the first/primary image in cards, search results, and detail pages.
The object includes a url to the file and a metadata block describing the image (mime type, size, dimensions).
This field is used in Projects, Buildings, and sometimes Units depending on API structure.

Meta

Allowed values

Example object

{
  "url": "...",
  "metadata": {
    "mime": "image/jpeg",
    "size": 112300,
    "width": 1300,
    "height": 731
  }
}

payment_plan

Description

Defines the structured or semi-structured payment schedule offered for purchasing a unit or participating in a project.
A payment plan typically includes installment percentages, milestone-based payments (e.g., on booking, during construction, on handover), and post-handover schemes.
The API may return payment plans as structured objects (with percentage splits and event triggers) or as free-text descriptions supplied by the developer or project manager.
This field is important for CRM systems and sales workflows, allowing agents or client platforms to present financial breakdowns to buyers and to compare projects based on financing models.
If a project does not have a defined payment plan, the field may be omitted or null.

Meta

Allowed values

Example object

{
  "on_booking": 10,
  "during_construction": 60,
  "on_handover": 30
}

developer_logo

Description
Represents the logo image object of a developer, including the file URL and metadata (mime, dimensions, size).
Displayed across UI elements such as developer cards, headers on project pages, search results, and promotional blocks.
Not all developers provide logos; the API may return null.

Meta

Allowed values

district

Description
Represents the administrative district (sub-region) where the project is located.
Used to group and filter projects geographically and to support map-based search.
Districts originate from the Locations directory and are not fully standardized — naming depends on the underlying geodata.

Meta

Allowed values

eoi

Description
EOI stands for Expression of Interest — an optional text field used by developers to indicate fees or conditions required to register early interest before sales open.
This is used mostly for presale phases.
Often appears empty in the API because many developers do not support formal EOI collection.

Meta

Allowed values

escrow

Description
Represents escrow account information for individual buildings within a project, if provided.
Escrow accounts are part of regulatory compliance in Dubai and Abu Dhabi: developers must register specific escrow numbers for buildings to protect buyer payments.
Most buildings do not provide this field, so the value is often null.

Meta

Allowed values

escrow_number

Description
The project-level escrow account number registered with the local land department (primarily Dubai DLD).
Unlike escrow (which appears inside buildings), this field represents the main escrow reference for the entire project.
Used for compliance, verification, and brokerage workflows.

Meta

Allowed values

floor

Description
Indicates the floor level on which a specific unit is located within a building.
The value may represent standard residential floors as well as special building levels using fractional or negative values.

Integer values correspond to standard numbered floors, while certain fractional or negative values are used to denote non-residential or transitional levels commonly found in multi-storey buildings.

Meta

Value Semantics

Response Examples

{
  "id": 455453,
  "name": "503",
  "floor": 5.0,
  "bedrooms": 2.0,
  "status": "available"
}

Notes

Description
Provides additional free-form textual information associated with a project, building, unit, or related entity.
This field is used for internal or auxiliary remarks that do not fall under any structured metadata category. The content often includes clarifications for property managers, sales teams, or integrators (e.g., information about specific restrictions, special conditions, internal comments, or supplementary marketing notes).
Values may vary significantly across records: some entries contain a brief remark, others a longer descriptive paragraph.
The field is optional and may appear empty in many objects.

Meta

Allowed values

number_of_floors

Description
Indicates the total number of floors in a building associated with a project or unit.
This attribute helps integrators determine building scale, unit positioning, and applicability of certain amenities or views.
The field may appear either at project-level (if a project consists of a single building) or at building-level when detailed building data is provided.
Values are always integers and usually range from low-rise villas (1–3 floors) to high-rise towers (20–80+ floors).
If the building data is not structured in the API for a specific project, this field may be omitted.

Meta

Allowed values

parking_ratio

Description
Specifies the ratio of available parking spaces relative to unit bedrooms, unit types, or project capacity.
This field is relevant for understanding how parking allocations are distributed across unit inventory — for example, 1 parking per 1-bedroom unit or 2 parkings per 3-bedroom unit.
The ratio is often derived from project planning rules and is used to determine parking availability during unit selection, CRM integration, and purchase workflows.
The value may be numeric, fractional, or descriptive depending on dataset completeness.
If parking allocation is controlled by separate mapping tables, this field may be absent.

Meta

Allowed values

Allowed values

penthouse_views

Description
Indicates the types of panoramic or premium views available specifically for penthouse units within a project.
This may include sea views, skyline views, park views, water/lake views, or developer-specific naming.
The attribute is typically used by marketing teams and CRM systems to highlight premium features of high-floor or exclusive units.
The field may contain a list of multiple views, a single string, or may be missing entirely if a project does not include penthouses.

Meta

Allowed values

phase

Description
Represents the development phase of a project or a project component.
Large developments often release properties in multiple phases (Phase 1, Phase 2, Phase A, etc.), each with its own launch date, pricing, construction progress, and marketing materials.
This attribute helps integrators distinguish between project segments and accurately filter or group units or listings.
The field may be numeric, alphabetical, or a composite label. Some projects may omit the attribute entirely if not structured in phases.

Meta

Allowed values

plot_area

Description
Represents the total land area associated with a project or development plot.
This attribute is typically used in master–planned communities, villa developments, and large-scale projects where the land parcel size influences planning, pricing, and regulatory approvals.
The value usually represents the full plot area as defined by the developer or land authority. Units may vary depending on developer conventions (sqft or m²).
If the project is an apartment tower or vertical building without explicitly defined plot area, this field may be null.

Meta

Allowed values

polygon

Description
Defines the geographic outline of a project location as a geometric shape.
The polygon attribute represents the spatial footprint or boundary of a project on the map and is primarily used for map rendering, visualization, and spatial context.

The polygon is expressed using a standard GeoJSON-like structure and contains a sequence of geographic coordinates that describe the project’s area or boundary line.

Meta

Polygon Object Fields

Coordinates Structure
Each coordinate entry is an array of two numeric values:

[longitude, latitude]

Example

{
  "type": "LineString",
  "coordinates": [
    [55.2094681, 25.0635459],
    [55.2094491, 25.0634718],
    [55.2094040, 25.0632960]
  ]
}

Notes

• Coordinates use the WGS 84 coordinate system (longitude, latitude).
• The order of points is significant and reflects the path of the boundary.
• The geometry type is provided as LineString, even when the shape visually represents a closed area.
• The polygon is intended for map visualization purposes and should not be interpreted as a legally precise land boundary.
• Absence of polygon data does not affect the availability of other project or location information.

postal_code

Description
Indicates the postal code associated with the project's address, district, or region.
In regions like Dubai where postal codes are not universally applied, this field may often be missing or null.
The attribute is more commonly relevant for international projects (e.g., Cyprus, Thailand, Bali) where postal codes form part of a standardized address structure.

Meta

Allowed values

price_per_area

Description
Represents the price per unit of area for a specific real estate unit.
The value indicates how much the unit costs per single area unit (for example, per square foot or per square meter), allowing clients to easily compare unit pricing independently of total size.

The area unit used for this value corresponds to the area_unit context of the response (such as sqft or m2).

Meta

Response Examples

{
  "id": 455457,
  "price": 18365583,
  "size": 4940.0,
  "price_per_area": 3717,
  "area_unit": "sqft"
}

Notes

• price_per_area is provided as a numeric value without currency symbols.
• The corresponding currency is defined by the price_currency field in the same response context.
• The value enables consistent comparison between units of different sizes.
• Clients should display price_per_area together with both price_currency and area_unit for clarity (for example: “3,717 AED per sqft”).
• The field is informational and does not act as a filter by itself.

price_currency

Description
Specifies the currency in which the project or unit prices are expressed.
The value is typically a three-letter ISO currency code (e.g., AED, USD).
This field may appear in pricing summaries, unit price listings, or project-level financial metadata.
When not explicitly defined, the default assumed currency for UAE-based projects is AED.

Meta

Allowed values

price_from

Description
Indicates the minimum price (in the project’s currency) among all units listed for the project.
Used for UI display, project comparison, filtering, and price range widgets.
Value is dynamically calculated based on unit data associated with the project.

Meta

Allowed values

price_to

Description
Represents the maximum price available within a project or unit collection.
Typically corresponds to the most expensive unit (e.g., penthouse, premium villa, or high-floor duplex).
Used by platforms for showing price ranges, filtering high-end buyers, and presenting comparative analytics.
Like price_from, this field may be null when price lists are incomplete or unavailable.

Meta

Allowed values

project_id

Description
A unique identifier assigned to each project in the system.
It serves as the primary reference key for fetching detailed project information, linking units to their parent project, retrieving markers, and associating related resources such as layouts, media, and amenities.
This field is essential for routing, relational UI structures, and internal data normalization.
Project IDs are positive integers and remain stable across different versions of the API.

Meta

Allowed values

project_name

Description
The human-readable name of the project as provided by the developer.
Used across all client-facing interfaces to identify and visually present the real estate development.
The name may include branding, community identifiers, or marketing designations.
Names are unique only in marketing context but not guaranteed to be unique system-wide; therefore, project_id is the reliable identifier.

Meta

Allowed values

property_type

Description
Indicates the primary classification of the real estate object or unit (e.g., apartment, villa, penthouse).
Used for filtering and segmentation in search results, analytics, pricing models, and UI grouping.
This field usually appears on unit-level entities but may appear on project summaries.
Values are standardized strings, often representing categories common across developers.

Meta

Allowed values

published_at

Description
Timestamp indicating when the resource (project, unit, or related entity) was published and became visible to end-users.
Used for sorting by recency, determining newly added projects, and analytics around content lifecycle.
Typically stored in UTC and returned in ISO-8601 format.

Meta

Allowed values

readiness_progress

Description
Numeric indicator showing the construction progress of a project, usually expressed as a percentage.
Used for monitoring project development states, visual progress bars, and end-user expectations.
If the developer does not provide periodic updates, the field may remain null.

Meta

Allowed values

region

Description
Specifies the administrative region within the country where the project is located.
Used for search filters, geospatial grouping, and UI display.
Region values depend on the country dataset and are often sourced from official registries.

Meta

Allowed values

sale_status

Description
Represents the current sales phase of a project as defined by the developer or platform.
Used for labeling availability (e.g., "On sale", "Sold out"), filtering search results, and client-side messaging.
Values map to predefined statuses and may influence visibility or business rules such as reservation or EOI handling.

Meta

Allowed values

sector

Description
A finer subdivision of a district or region used to categorize project locations.
Often corresponds to planning sectors or micro-zones defined by municipal authorities.
Not all locations include sectors; therefore, the field is frequently null.

Meta

Allowed values

service_charge

Description
Represents maintenance fees per area unit (typically AED per sqft) charged annually to property owners.
Used by investors and brokers to estimate ongoing ownership costs.
May include a numeric value and a unit descriptor as part of a single string.

Meta

Allowed values

short_description

Description
A brief marketing-focused summary of the project or unit.
Displayed in listings, previews, or search results.
This text highlights positioning, amenities, or key differentiators.
Length varies depending on content strategy; may be null when the project relies solely on full description.

Meta

Allowed values

size_from

Description
Indicates the minimum unit size within the project’s unit collection.
Used for filtering by square footage, comparative analysis, and UI display of unit ranges.
Values typically come from unit floor areas provided by developers.

Meta

Allowed values

size_to

Description
Represents the maximum unit size available within the project’s inventory.
Used for displaying unit size ranges, enabling filtering logic, and supporting comparative analytics across projects.
Typically derived from the largest available unit in the project (in sqft or m2 depending on the source data).
Returned as a numeric value; no formatting is applied.

Meta

Allowed values

sky_mansions

Description
Indicates whether the project includes units categorized as "sky mansions"—large, ultra-premium units typically occupying entire floors or multi-level penthouse formats.
This attribute may appear in unit grouping definitions (e.g., parking rules, typical units).
Represents a categorical string rather than a boolean.

Meta

Allowed values

start_date

Description
Represents the beginning of a date interval associated with a payment schedule step, offer, or milestone.
Used exclusively within structured collections such as payment plan steps.
Returned as date or datetime depending on source data.
If the step does not require a date, the value remains null.

Meta

Allowed values

statistics

Description
Aggregated statistical information related to the developer.
This block provides a concise overview of the developer’s project portfolio, allowing clients to quickly assess overall activity and scale without performing additional queries.

The statistics object is informational and intended for display, analytics, and filtering logic on the client side.

Meta

Statistics Object Fields

Example

{
  "statistics": {
    "projects_total": 5,
    "projects_active": 3
  }
}

Notes

• projects_total reflects all projects ever linked to the developer.
• projects_active reflects only projects considered active at the time of the request.
• The exact definition of “active” is determined by project status logic on the platform and is consistently applied across all developer responses.
• This block is read-only and cannot be used as a filter parameter.

status (project status)

Description
Represents the development (construction) stage of a project as returned by endpoints that use the field name status instead of construction_status.
Even though the naming differs, the underlying meaning and allowed values are identical to construction_status.
This field is mainly used in endpoints optimized for map data (e.g., project markers) and some list endpoints.
Consumers must treat status and construction_status as equivalent indicators of a project’s lifecycle stage.

Meta

Allowed values

status (developer status)

Type
string (enum)

Description
Indicates the lifecycle status of a developer entity as returned in the API response.

The developer_status value is provided as an informational attribute of developer objects and reflects their current state within the system.
This attribute is intended for data interpretation, labeling, and UI presentation on the client side.

Meta

Returned Values

Notes

• The status (developer status) field is included in developer objects returned by the API.
• The attribute is commonly used for:
  • displaying developer state in UI;
  • sorting or grouping developers client-side;
  • applying presentation logic (visibility, badges, labels).

status (unit status)

Description
Represents the current availability state of an individual unit within a project.
The status reflects the commercial and reservation state of the unit at the time of the latest data update.

This attribute is returned as part of unit objects and may be used by clients to understand whether a unit is available for purchase, temporarily reserved, or no longer available.

Allowed Values

Notes

• The unit_status value is derived from the underlying unit inventory records.
• Returned values are always provided in snake_case.
• Clients should treat this field as the authoritative indicator of unit availability.
• Interpretation of each status should be handled on the client side according to business logic (for example, UI labeling or availability badges).

steps

Description
A structured list describing sequential payment obligations under a payment plan.
Each step may contain a percentage, fixed amount, name, optional start/end dates, and hierarchical children.
Used for UI rendering of payment schedules and for internal financial calculations.

Meta

Allowed values

suites

Description
Represents the count or availability of suite-type rooms or components inside a unit or building description.
Appears irregularly and may depend on developer terminology.
Often used for labeling luxury or serviced units.

Meta

Allowed values

target

Description
Used in map point definitions to represent the name of the target location or reference point (e.g., school, mall, beach).
Assists in calculating distance markers and enriching UI maps.
Often accompanied by distance/time values.

Meta

Allowed values

terms

Description
Represents human-readable text associated with payment plan terms, booking conditions, or contractual notes.
This field is not standardized and may contain long-form descriptions.
Used for displaying informational content alongside payment schedules.

Meta

Allowed values

time

Description
Represents the estimated travel time to a map point (e.g., airport, mall, school) from the project location.
Paired with distance.
May be null when developers do not provide travel duration.

Meta

Allowed values

title

Description
Human-friendly text label used in various contexts: media items, floor plans, documents, marketing elements.
Purpose varies depending on the parent object.
If the source object has no naming convention, title may be autogenerated or null.

Meta

Allowed values

to_price_aed

Description
Indicates the highest price value within the range for a specific unit type or typical unit block.
Displayed in unit summaries and pricing breakdowns.
Price is always denominated in AED, independent of user preferences.

Meta

Allowed values

to_price_usd

Description
Represents the upper bound of the price range for a specific unit type when expressed in USD.
Used in pricing breakdowns, typical unit summaries, and comparative analytics for international buyers.
The value is always a numeric field in USD, regardless of the project's native pricing currency (AED).

Meta

Allowed values

to_size_m2

Description
Indicates the upper bound of the unit size range expressed in square meters.
Used for international presentation of areas and for supporting size-based comparisons.
Returned as a floating-point value; may differ slightly due to rounding during sqft → m² conversion.

Meta

Allowed values

to_size_sqft

Description
Represents the maximum unit size in square feet within a typical unit grouping.
Used in UI displays, filtering, and analytics where size ranges help users evaluate unit configurations.
Returned as a number.

Meta

Allowed values

total_area

Description
Represents the full area specification of a unit or space, often combining usable interior area and exterior/balcony space.
Appears in unit-level data where detailed floor plan measurements are available.
Returned as a number, usually in sqft unless converted by user preference.

Meta

Allowed values

total_count

Description
Represents the aggregated count of items in contexts such as contacts, units, unavailable units, map points, or dataset summaries.
Used to calculate how many elements exist in a group or for simple analytics.
The meaning depends fully on the parent structure.

Meta

Allowed values

type

Description
A versatile attribute used across multiple objects (media, files, map points, buildings, payment steps, etc.).
Provides the categorical classification of the parent object and governs how the client application interprets or displays that item.
The meaning changes depending on context, but always indicates a category or subtype.

Meta

Allowed values

unit_bedrooms

Type
string (comma-separated numeric values)

Description
Filters projects or markers by the number of bedrooms available in their units.
The parameter accepts one or multiple numeric values representing bedroom counts and matches them against unit bedroom configurations available within each project.

Filtering is based on actual unit bedroom values (or typical unit configurations, depending on the endpoint), using the same numeric model as the bedrooms field in the Units API.

This parameter allows precise filtering for studios, standard apartments, and units with auxiliary rooms using a single, consistent numeric representation.

Value Interpretation
Each value represents a bedroom configuration:

Multiple values can be provided as a comma-separated list. A project is included in the results if at least one unit matches any of the specified bedroom values.

Meta

Request and Response Examples

Filter by studio units:

GET /api/v2/clients/projects?unit_bedrooms=0

Filter by 1-bedroom units:

GET /api/v2/clients/projects/markers?unit_bedrooms=1

Filter by multiple bedroom configurations:

GET /api/v2/clients/projects?unit_bedrooms=1,2.5,3

Filter units within a project (Units API context):

GET /api/v2/clients/projects/1147/units?unit_bedrooms=1.5

Notes

• Values must be numeric (integers or decimals).
• Multiple values must be comma-separated, without spaces.
• The filter is inclusive: projects are returned if any matching unit configuration exists.
• Bedroom values are matched exactly; the API does not perform rounding or normalization.
• This parameter shares the same semantic rules as the bedrooms field returned in unit objects.

unit_count

Description
Represents the number of units in a particular building, project section, or grouping.
Used in building details and project summaries.
Displayed as an integer.

Meta

Allowed values

unit_id

Description
Unique identifier for a unit object returned from the Units API or from project detail collections (e.g., typical units).
Used for linking, deep navigation, and unit-specific data queries.
Displayed as an integer.

Meta

Allowed values

unit_number

Description
Human-readable identifier of the unit as assigned by the developer (e.g., apartment number, villa number, townhouse number).
Can include alphanumeric patterns.
Used for marketing display, filtering, and internal navigation.

Meta

Allowed values

unit_price_aed

Description
Represents the unit’s price expressed in AED (United Arab Emirates Dirham).
This value is typically the current asking price or list price for a specific unit, as returned by Units or Project Details APIs.
It is the primary commercial value used for price filters, comparisons between units within the same project, and export to CRM or transaction systems.
Even if USD values are present in parallel fields, unit_price_aed remains the canonical monetary field for Dubai/Abu Dhabi market operations.

Meta

Allowed values

unit_price_usd

Description
Represents the unit’s price expressed in USD, calculated based on internal currency conversion from AED.
Primarily used for international buyers, dashboards, and analytics where USD is preferred as a reference currency.
The value is dependent on conversion logic (e.g., a daily or fixed rate) implemented in the backend and may not be a developer-provided field.

Meta

Allowed values

unit_size_m2

Description
Indicates the unit’s area measured in square meters.
This field is used to present unit dimensions in metric units, support size-based filters, and calculate price-per-square-meter metrics.
The value may be provided directly by the developer or calculated from unit_size_sqft. In mixed-data cases, slight rounding differences are possible.

Meta

Allowed values

unit_size_sqft

Description
Represents the unit’s area measured in square feet.
This is typically the primary area metric for projects in Dubai/Abu Dhabi and is directly used in most developer brochures and technical documents.
Used for size filters, visual comparisons between units, and price-per-square-foot calculations.

Meta

Allowed values

unit_type

Description
Represents the type/category of a unit (property). The value is returned as a plain string and can be used for grouping, UI labels, and client-side filtering logic. Unit types are consistent across unit objects and use the canonical naming stored in the system.

Meta

Allowed values

unit_types

Description
Filters results by unit type. The parameter accepts one or multiple unit type values and returns items where at least one unit matches any of the specified types.

Values must be provided as canonical strings (the same values that appear in the unit_type field). Multiple values are passed as a comma-separated list.

Meta

Request and Response Examples

Filter by a single unit type:

GET /api/v2/clients/projects?unit_types=apartments

Filter by multiple unit types:

GET /api/v2/clients/projects?unit_types=villa,townhouse

Filter including a value with a space (URL-encoded):

GET /api/v2/clients/projects?unit_types=hotel%20apartments,penthouse

Response (fragment):

{
  "count": 1906,
  "results": [
    {
      "id": 791,
      "name": "48 Parkside",
      "min_price": 1159000.0149,
      "sale_status": "on_sale"
    }
  ]
}

Notes

• Values are plain strings and must match the canonical values from the system.
• For values containing spaces (e.g., hotel apartments), clients must URL-encode them (hotel%20apartments).
• Multiple values are passed as a comma-separated list (no spaces).

units_count

Description
Represents the total number of units that belong to a project or a particular scope object (e.g., building, section).
At the project level, it shows how many saleable units are registered for that development in the system.
It is used in statistics, project overview cards, and to estimate scale and density of the project.

Meta

Allowed values

unusable_area

Description
Represents the portion of a unit’s area that is not considered usable/livable space according to local norms or developer definitions (e.g., structural, technical or service areas).
This field is used in advanced calculations (e.g., net vs gross area), especially when calculating efficiency ratios (usable area / total area).
Not all projects or units provide this value; when missing, UI should gracefully fall back to total and usable areas only.

Meta

Allowed values

updated

Description
Represents the timestamp when the object (project, unit, developer, etc.) was last updated in the system.
Used for data freshness checks, synchronization with external systems, and cache invalidation on client side.
Formatted as a datetime string, usually in ISO 8601 format with timezone or as a UTC timestamp depending on implementation.

Meta

Allowed values

url

Description
Represents a direct link (URL) to a resource such as an image, document, media file, or external page (e.g., Google Drive brochure, S3 object, vault resource).
Used widely across the API to connect structured metadata with actual assets consumed by the client application (images, PDFs, etc.).
The URL may be public, signed, or internal depending on storage configuration, and the client must handle it according to project security rules.

Meta

Allowed values

usage

Description
Represents a list of usage classifications associated with a broker’s annual transaction statistics.
Each usage entry describes the purpose/type of the transacted property (e.g., Residential, Commercial) and includes a count of transactions within that usage category for the given year.
This field appears only in the context of broker statistics and is not related to unit usage, project usage, or zoning usage—its meaning is strictly tied to DLD (Dubai Land Department) transaction reporting categories.

Meta

Allowed values

usage_type_id

Description
Identifier representing a specific property usage category within DLD transaction statistics.
This ID is part of each usage object and groups all transactions of the same category.
Although current data shows only 0, the API design implies that more usage types may exist as DLD expands classification sets.

Meta

Allowed values

usage_type_name_ar

Description
Arabic-language label describing the property usage type within a transaction category.
Used for localization, bilingual UI, reporting, and official documentation for DLD-related statistics.
Always appears inside a usage array element and corresponds directly to usage_type_name_en.

Meta

Allowed values

usage_type_name_en

Description
English-language label for the transaction usage category, used for UI filters, analytics, and reporting.
Appears alongside its Arabic equivalent inside each usage entry.
The values reflect DLD classification terms and can include Residential, Commercial, Industrial, or other official transaction categories.

Meta

Allowed values

uuid

Description
A universally unique identifier assigned to certain objects in the system (e.g., media items, vault objects, layouts, auxiliary structures).
Used as a stable reference key for storing, retrieving, and caching non-relational assets.
Unlike simple integer IDs, UUIDs provide global uniqueness and allow safe referencing across distributed systems or external storages.

Meta

Allowed values

vault

Description
A logical reference to the location/storage container where media files, images, documents, brochures, floor plans, and other assets are stored.
Usually represented as a string or object containing identifiers of the storage bucket, path, or internal resource name.
It is not itself a direct URL — the actual file link is available via the url field.
The vault field is used for backend operations, CDN routing, and media lifecycle management.

Meta

Allowed values

view

Description
Represents the type of view that a unit offers (e.g., sea view, city view, park view).
Derived from developer materials, brochures, or project metadata.
Used in UI tags, search filters, and premium property classification.
Not all units contain this field; when absent, the view is considered unspecified.

Meta

Allowed values

view_360

Description
A URL or media reference pointing to a panoramic 360-degree view associated with a project, unit, or marketing material.
This asset allows users to explore the interior or exterior environment interactively.
If present, it typically refers to a single panoramic scene; some projects may list multiple assets under a separate gallery structure.

Meta

Allowed values

views

Description
An array describing the count or types of unit view categories (e.g., sea, city, park).
Not always present in the dataset.
When included, typically reflects marketing attributes used for premium positioning or search filtering.
The field may be numeric (views_count) or descriptive (an array of view labels such as "Sea View", "City View").

Meta

Allowed values

views_count

Description
Numeric value indicating the number of distinct view types available for a unit or project.
Used for UI summarization (e.g., “2 views available”) and analytics.
This field is a compressed version of the views attribute.

Meta

Allowed values

villa_type

Description
Subtype classification for villa units, if defined by the developer.
Used to differentiate between villa models (e.g., "Type A", "Mediterranean", "Contemporary").
This field appears only for villa products and is absent for apartments, penthouses, duplexes, etc.

Meta

Allowed values

website

Description
Official website URL of a developer, project, or organization.
Used to link external marketing pages or corporate profiles.
Appears primarily in developer objects and occasionally in project metadata.

Meta

Allowed values

whatsapp_number

Description
A phone number formatted specifically for WhatsApp communication with a developer or sales office.
Used for direct inquiries, lead generation, or contact widgets in integrated CRM systems.
Format must follow international standards (e.g., +971XXXXXXXXX).

Meta

Allowed values

year

Description
Represents a calendar year associated with broker transaction statistics.
Used exclusively in the DLD broker reporting endpoint.
Each year groups the count of transactions and associated usage categories.

Meta

Allowed values

youngest_transaction

Description
Represents the most recent transaction date associated with a developer, broker, or project (depending on endpoint architecture).
Used to indicate the freshness or current activity of transactions.
Format follows ISO date/time if available.

Meta

Allowed values

zone

Description
Represents a named sub-area within a district or master community.
Used to provide more granular geographic segmentation inside a broader district.
Often appears in project location metadata when developers or master developers define marketing zones (e.g., “West Zone”, “Central Zone”).
The field is optional and may be empty for most projects.

Meta

Allowed values

zone_id

Description
Internal numeric identifier associated with a specific zone.
Used when a project location includes a structured hierarchy of regions → districts → zones.
Not all projects have zoned geography, therefore the field may frequently be null.
When present, zone_id can be used for filtering or grouping at a deeper geographic level.

Meta

Allowed values

zoom

Description
Represents the recommended initial zoom level for displaying a project on a map.
Used in certain map-based endpoints or internal location objects.
A higher value indicates a closer zoom-in (e.g., 16 for building-level), while a lower value (e.g., 10) represents a city-level view.
If not present, the map client typically uses default zoom logic.

Meta

Allowed values