### Example request: GET /projects?country=Dubai&format=json Source: https://docs.reelly.ai/docs Shows a sample API request using the GET method with query parameters for country and format. The format parameter defaults to json, and json is the primary and complete format. ```http GET /projects?country=Dubai&format=json ``` -------------------------------- ### GET project details request and response Source: https://docs.reelly.ai/docs/project-details Example of a GET request to the /api/v2/clients/projects/1127 endpoint and the corresponding JSON response containing project details. ```http GET `/api/v2/clients/projects/1127` ``` ```json { "id": 1127, "name": "Muraba Veil", "developer": "Muraba Properties", "construction_status": "under_construction", "sale_status": "out_of_stock", "min_price": 12576212.013625, "max_price": 72873192.0085, "min_size": 3838.0102893381595, "max_size": 9903.078154476, "price_currency": "AED", "area_unit": "sqft" } ``` -------------------------------- ### Query projects with multiple filters Source: https://docs.reelly.ai/docs/list-projects Example of a GET request combining multiple optional parameters for filtering projects. ```http GET /api/v2/clients/projects?country=Cyprus®ion=Dubai&location_ids=301,302&status=Under%20Construction&sale_status=On%20Sale ``` -------------------------------- ### GET /developers/logos Response Example Source: https://docs.reelly.ai/docs/developers Example JSON response from the GET /api/v2/clients/developers/logos endpoint. Shows a list of developers with id, name, and logo object (or null). Logo metadata includes URL, MIME type, size, width, and height. Note that logos may be null and ordering is not guaranteed. ```json [ { "id": 63, "name": "32Group", "logo": null }, { "id": 507, "name": "4Direction Developers", "logo": { "url": "https://api.reelly.io/vault/ZZLvFZFt/8-XEjA4gjpLtBsL4u-XTPMRSseA/c1UTzA../Screenshot_1.png", "metadata": { "mime": "image/png", "size": 27252, "width": 597, "height": 597 } } }, { "id": 315, "name": "7 Sens", "logo": { "url": "https://api.reelly.io/vault/ZZLvFZFt/EprlCEawG8nDXpLc25B4fZoFD24/dIRT6w../%D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA+%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0+2024-02-22+%D0%B2+13.30.52.png", "metadata": { "mime": "image/png", "size": 570246, "width": 764, "height": 674 } } }, { "id": 590, "name": "7th Key Development", "logo": { "url": "https://reelly-backend.s3.amazonaws.com/1080x1080_cabea3c3b336434dbe126da6f943e377.webp", "metadata": { "mime": "image/webp", "size": 14134, "width": 1080, "height": 1080 } } }] ``` -------------------------------- ### Retrieve paginated project list Source: https://docs.reelly.ai/docs/list-projects Example JSON response structure for a paginated GET request to the projects endpoint. ```json { "count": 0, "next": "https://api-reelly.up.railway.app/api/v2/clients/projects?limit=5&offset=5", "previous": null, "results": [ { "id": 128, "name": "Canal Heights", "developer": "DAMAC", "construction_status": "under_construction", "sale_status": "on_sale", "min_price": 2827999.994625, "max_price": 17542999.9875, "min_size": 948.5274857198399, "max_size": 4381.16457587796, "price_currency": "AED", "area_unit": "sqft", "units_count": 48, "readiness_progress": 13.37, "location": { "id": 641, "country": 219, "region": "Dubai", "city": null, "district": "Business Bay", "sector": "Business Bay", "village": null, "latitude": 25.183638, "longitude": 55.278551 }, "cover_image": { "url": "https://api.reelly.io/vault/ZZLvFZFt/ZNIiE9EN7ACufoA0rYkcdC8AT1M/We3V0A../WhatsApp+Image+2023-02-17+at+17_49_43+%281%29.jpeg", "metadata": { "mime": "image/jpeg", "size": 288715, "width": 1600, "height": 1131 } }, "is_partner_project": false, "status": "under_construction" } ] } ``` -------------------------------- ### Example response for min_price filter Source: https://docs.reelly.ai/docs/available-units Example JSON response fragment showing a count of 7 results with unit details including id, name, price, size, and bedrooms. ```json { "count": 7, "results": [ { "id": 455457, "name": "1101", "price": 18365583, "size": 4940.0, "bedrooms": 2.0 } ]} ``` -------------------------------- ### Example response fragment for min_size filter Source: https://docs.reelly.ai/docs/available-units Example JSON response fragment showing unit size and bedrooms for a min_size query. ```json { "results": [ { "id": 455457, "size": 459.95, "bedrooms": 2.0 } ]} ``` -------------------------------- ### GET /api/v2/clients/developers - Response Example Source: https://docs.reelly.ai/docs/developers Example JSON response from the List Developers endpoint. It shows an array of developer objects with fields like id, name, website, description, logo metadata, status, social_links, phone, email, working_hours, and offices. The response is a simple JSON array without pagination. ```json [ { "id": 49, "name": "Kappa Acca Real Estate Development", "website": "https://kappaacca.ae/", "description": "Kappa Acca Real Estate Development is developed by Khamas Group. It is a very esteemed and reputed company in the UAE, it is one of the most respected enterprises. Its success exceeds it in the business world, especially that it is a leading stakeholder in construction and other industries. The company has progressed and grown simultaneously with Emirates’ growth and developments.", "logo": { "url": "https://api.reelly.io/vault/ZZLvFZFt/hfmrpc0d_fRIEIoHBoj52Nwq52o/0UMgvA../306155932_409449851310971_4064157388172736233_n.jpg", "metadata": { "mime": "image/jpeg", "size": 95854, "width": 800, "height": 800 } }, "status": "active", "social_links": [], "phone": "+97142828244", "email": "info@kappaacca.ae", "working_hours": null, "offices": [ { "id": 1283, "developer": 49, "country": { "id": 219, "country": { "code": "AE", "name": "United Arab Emirates", "alpha_2": "AE", "alpha_3": "ARE", "numeric": 784, "flag": "https://reelly-backend.s3.amazonaws.com/static/flags/ae.gif" }, "currency": "AED", "timezone": "Asia/Dubai", "phone_code": "+971", "status": "active", "region": null, "custom_fields": null, "city": null, "district": null, "sector": null, "village": null }, "region": "Dubai", "city": "Dubai", "address": "Airport Rd, Al Garhoud, Dubai", "working_hours": [], "is_main": false, "email": "info@kappaacca.ae", "name": "Kappa Acca Real Estate Development" } ] }, { "id": 218, "name": "Karma Developers", "website": "https://karmadevelopers.ae/", "description": "Karma Developers have successfully established a prominent presence in the fiercely competitive mid-size development sphere within the rapidly expanding real estate sector of the United Arab Emirates.", "logo": { "url": "https://api.reelly.io/vault/ZZLvFZFt/xgOZFvxlhhmKdM5wdAPG-9faK80/NR3kSA../Frame+15.png", "metadata": { "mime": "image/png", "size": 704163, "width": 500, "height": 500 } }, "status": "active", "social_links": [], "phone": null, "email": "admin@karmadevelopers.ae", "working_hours": null, "offices": [ { "id": 977, "developer": 218, "country": null, "region": null, "city": null, "address": "25th Floor, Binary Tower, Business Bay, Dubai, U.A.E", "working_hours": [ { "days": "Monday - Friday ", "time_range": " 9 AM - 6 PM" }, { "days": "Saturday ", "time_range": "9 AM - 2:30 PM" }, { "days": "Sunday ", "time_range": "Day off" } ], "is_main": false, "email": null, "name": null } ] }] ``` -------------------------------- ### Project Details Response Example Source: https://docs.reelly.ai/docs/project-details Example JSON response from the Project Details endpoint. Shows the structure including id, name, country, region, status, sale_status, min_price, max_price, developer object, cover_image with metadata, typical_units array, amenities array, and location object. ```json { "id": 128, "name": "Central Hill Residences", "country": "UAE", "region": "Dubai", "status": "Under Construction", "sale_status": "On Sale", "min_price": 3556000, "max_price": 12460000, "developer": { "id": 194, "name": "ABC Developers" }, "cover_image": { "url": "https://...", "metadata": { "mime": "image/webp", "size": 24400 } }, "typical_units": [ { "bedrooms": 2, "min_price": 3538000, "max_price": 4441000, "unit_type": "apartments" } ], "amenities": [ "Pool", "Gym", "Parking" ], "location": { "id": 301, "name": "Downtown" }} ``` -------------------------------- ### List Projects Response Example (JSON) Source: https://docs.reelly.ai/docs/list-projects Example JSON response from the List Projects endpoint. Shows the pagination fields (count, next, previous) and a project object with summary fields like name, country, status, price range, cover image, and developer reference. ```json { "count": 0, "next": "https://api-reelly.up.railway.app/api/v2/clients/projects?limit=5&offset=5", "previous": null, "results": [ { "id": 1, "name": "Project Example", "country": "Cyprus", "region": "Limassol", "status": "Under Construction", "sale_status": "On Sale", "min_price": 250000, "max_price": 450000, "cover_image": { "url": "https://...", "metadata": { "mime": "image/webp", "size": 18234, "width": 1024, "height": 768 } }, "developer": { "id": 12, "name": "ABC Development" } } ] } ``` -------------------------------- ### Request prices in USD Source: https://docs.reelly.ai/docs/list-projects Example request for project prices in USD. ```json { "count": 123, "next": "...", "previous": null, "results": [ { "id": 2211, "name": "Jacob and Co Beachfront Living", "price_currency": "USD", "min_price": 1092171.55, "max_price": 5491354.66 } ] } ``` -------------------------------- ### Example response fragment for preferred_area_unit Source: https://docs.reelly.ai/docs/available-units Example JSON response fragment showing converted size and price_per_area when preferred_area_unit=m2 is used. ```json { "results": [ { "id": 455457, "size": 459.95, "price_per_area": 401.2 } ]} ``` -------------------------------- ### Response for GET /api/v2/clients/regions (Default Language) Source: https://docs.reelly.ai/docs/metadata-apis Example JSON response showing regions with English names (e.g., 'Dubai' and 'Abu Dhabi') and bounding box coordinates. ```json [ { "id": 5, "name": "Dubai", "sw_latitude": 24.620369, "sw_longitude": 54.782523, "ne_latitude": 25.446058, "ne_longitude": 56.205636 }, { "id": 3, "name": "Abu Dhabi", "sw_latitude": 22.631514, "sw_longitude": 51.421236, "ne_latitude": 25.249089, "ne_longitude": 56.018126 }] ``` -------------------------------- ### Example response fragment Source: https://docs.reelly.ai/docs/available-units A sample JSON response showing the unit price and price_per_area fields. ```json { "results": [ { "id": 365944, "name": "106", "price": 315588.84, "price_per_area": 372.2, "size": 847.0, "status": "available" } ]} ``` -------------------------------- ### Example response fragment for building filter Source: https://docs.reelly.ai/docs/available-units Example JSON response fragment showing a unit with building_id 1281, floor 5, and price. The response includes count and results array. ```json { "count": 8, "results": [ { "id": 455453, "name": "503", "building_id": 1281, "floor": 5, "price": 12576212 } ]} ``` -------------------------------- ### GET projects filtered by sale_status=On Sale Source: https://docs.reelly.ai/docs/list-projects Request example for filtering projects by sale status using the human-readable value 'On Sale' (URL-encoded as On%20Sale). The response is truncated and shows a project with sale_status 'on_sale' in snake_case. ```HTTP GET /api/v2/clients/projects?sale_status=On%20Sale ``` ```JSON { "count": 123, "next": "https://api-reelly.up.railway.app/api/v2/clients/projects?sale_status=On%20Sale&limit=20&offset=20", "previous": null, "results": [ { "id": 1, "name": "Sample Project", "developer": "Sample Developer", "construction_status": "under_construction", "sale_status": "on_sale", "location": { "id": 382, "region": "Dubai", "district": "Al Furjan", "latitude": 25.0189777, "longitude": 55.1441793 }, "min_price": 0, "max_price": 0, "price_currency": "AED", "area_unit": "sqft", "is_published": true } ] } ``` -------------------------------- ### GET projects with search_query=Beach Source: https://docs.reelly.ai/docs/list-projects Request example for performing a free-text search across project name, developer name, and area name using the query 'Beach'. The response shows a matching project with name 'Beachfront Residences'. ```HTTP GET /api/v2/clients/projects?search_query=Beach ``` ```JSON { "count": 3, "next": null, "previous": null, "results": [ { "id": 501, "name": "Beachfront Residences", "developer": "Example Developer", "construction_status": "under_construction", "sale_status": "on_sale", "location": { "id": 100, "region": "Dubai", "district": "Dubai Harbour", "latitude": 25.089, "longitude": 55.144 }, "price_currency": "AED", "area_unit": "sqft", "is_published": true } ] } ``` -------------------------------- ### Response for GET /api/v2/clients/regions?language=fr Source: https://docs.reelly.ai/docs/metadata-apis Example JSON response showing regions with translated names (e.g., 'Dubaï' and 'Abou Dabi') and bounding box coordinates. ```json [ { "id": 2, "name": "Dubaï", "sw_latitude": 24.620369, "sw_longitude": 54.782523, "ne_latitude": 25.446058, "ne_longitude": 56.205636 }, { "id": 5, "name": "Abou Dabi", "sw_latitude": 22.631514, "sw_longitude": 51.421236, "ne_latitude": 25.249089, "ne_longitude": 56.018126 }] ``` -------------------------------- ### Request and Response for Map Markers Source: https://docs.reelly.ai/docs/projects-map-markers Example of a GET request to retrieve markers within a specific viewport and the corresponding JSON response fragment. ```http GET /api/v2/clients/projects/markers?bbox_ne_lat=25.30&bbox_ne_lng=55.40&bbox_sw_lat=25.10&bbox_sw_lng=55.20 ``` ```json [ { "id": 791, "name": "48 Parkside", "location": { "latitude": 25.0559388, "longitude": 55.23998939 }, "sale_status": "on_sale", "status": "under_construction", "min_price": 1159000.0149 }] ``` -------------------------------- ### GET /api/v2/clients/districts - Response with default language Source: https://docs.reelly.ai/docs/metadata-apis Example response for the default language request. Shows a list of districts with id and name fields. ```json [ { "id": 2, "name": "Abu Al Habel Island" }, { "id": 5, "name": "Academic City" }, { "id": 17, "name": "Al Barsha" }, { "id": 187, "name": "Business Bay" }, { "id": 308, "name": "Palm Jumeirah" }] ``` -------------------------------- ### GET /projects/markers Source: https://docs.reelly.ai/docs Retrieves lightweight map-optimized project markers. ```APIDOC ## GET /projects/markers ### Description Lightweight map-optimized project markers. ### Method GET ### Endpoint /projects/markers ### Parameters #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. ### Response #### Success Response (200) List of project markers. #### Response Example ```json [{"id": 1, "lat": 25.2048, "lng": 55.2708}] ``` ``` -------------------------------- ### Get the second page Source: https://docs.reelly.ai/docs Fetches the second page of projects by specifying limit and offset parameters. ```http GET /api/v2/clients/projects?limit=20&offset=20 ``` -------------------------------- ### Example Marker Response Fragment Source: https://docs.reelly.ai/docs/projects-map-markers A sample JSON response fragment for a project marker. ```json [ { "id": 791, "name": "48 Parkside", "developer": { "id": 222, "name": "Tabeer Real Estate Development LLC" }, "location": { "latitude": 25.05593881164199, "longitude": 55.239989393880585, "country": 219, "region": "Dubai", "district": "Arjan" }, "completion_datetime": "2025-11-30T01:00:00Z", "cover_image": { "url": "https://api.reelly.io/vault/ZZLvFZFt/shSUd9OwqGaN7UWSGbid_fkhXnI/oFtoWw../6.jpg" }, "sale_status": "on_sale", "min_price": 1159000.0149, "status": "under_construction", "is_partner_project": false }] ``` -------------------------------- ### Example response for districts filter Source: https://docs.reelly.ai/docs/projects-map-markers Example JSON response fragment for the districts filter. Shows a marker object with id, name, developer, location, completion_datetime, cover_image, sale_status, min_price, status, and is_partner_project fields. ```json [ { "id": 766, "name": "555 Park Views", "developer": { "id": 223, "name": "Serene Developments" }, "location": { "id": 308, "latitude": 25.034080619854226, "longitude": 55.17409039107837, "country": 219, "region": "Dubai", "district": "JVT (Jumeirah Village Triangle)", "sector": "Jumeirah Village Circle", "village": null }, "completion_datetime": "2024-06-30T00:00:00Z", "cover_image": { "url": "https://api.reelly.io/vault/ZZLvFZFt/eQP-LhaGMgXH_AFLGx0S26CCIgo/sBI2Ag../8.jpg" }, "sale_status": "out_of_stock", "min_price": 0, "status": "completed", "is_partner_project": false }] ``` -------------------------------- ### Example response for has_escrow filter Source: https://docs.reelly.ai/docs/projects-map-markers Example JSON response fragment for the has_escrow filter. Shows a marker object with id, name, location, sale_status, min_price, and status fields. Note that escrow data is not included in the marker payload. ```json [ { "id": 2353, "name": "77 Boulevard", "location": { "latitude": 25.047261, "longitude": 55.199750, "country": 219, "region": "Dubai", "district": "JVC (Jumeirah Village Circle)" }, "sale_status": "out_of_stock", "min_price": 0, "status": "presale" }] ``` -------------------------------- ### List projects with updated_at_before filter Source: https://docs.reelly.ai/docs/list-projects Example request and response for filtering projects by an updated_at timestamp. ```http GET /api/v2/clients/projects?updated_at_before=2025-05-01T00:00:00Z ``` ```json { "count": 310, "next": null, "previous": null, "results": [ { "id": 501, "name": "Beachfront Residences", "updated_at": "2025-04-12T14:22:10.901233Z", "construction_status": "under_construction", "sale_status": "on_sale", "price_currency": "AED", "area_unit": "sqft", "is_published": true } ] } ``` -------------------------------- ### English localized response excerpt Source: https://docs.reelly.ai/docs/available-units Example response showing English values for layout fields. ```json { "id": 663014, "name": "DDA/2/216", "status": "available", "unit_type": "apartments", "layout": { "id": 88915, "name": "1 BR Type A" }, "layout_type": "1 BR Type A"} ``` -------------------------------- ### Request prices in AED Source: https://docs.reelly.ai/docs/list-projects Example request for project prices in AED, the base currency. ```json { "count": 123, "next": "...", "previous": null, "results": [ { "id": 2211, "name": "Jacob and Co Beachfront Living", "price_currency": "AED", "min_price": 4011000.017375, "max_price": 20166999.98885 } ] } ``` -------------------------------- ### GET /projects Source: https://docs.reelly.ai/docs Main endpoint for retrieving the full list of projects with extensive filtering. ```APIDOC ## GET /projects ### Description Main endpoint: full list with extensive filtering. ### Method GET ### Endpoint /projects ### Parameters #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. - **country** (string) - Optional - Filter by country. Example: `country=Dubai`. ### Request Example ``` GET /projects?country=Dubai&format=json ``` ### Response #### Success Response (200) List of projects. #### Response Example ```json [{"id": 1, "name": "Project A", "country": "Dubai"}] ``` ``` -------------------------------- ### Project markers response fragment Source: https://docs.reelly.ai/docs/projects-map-markers Example JSON response for a project markers request. ```json [ { "id": 791, "name": "48 Parkside", "sale_status": "on_sale", "status": "under_construction", "min_price": 1159000.0149 }, { "id": 1866, "name": "4B Living", "sale_status": "out_of_stock", "status": "under_construction", "min_price": 0 }] ``` -------------------------------- ### Search response fragment Source: https://docs.reelly.ai/docs/projects-map-markers Example JSON response fragment for a project marker search. ```json [ { "id": 791, "name": "48 Parkside", "developer": { "name": "Tabeer Real Estate Development LLC" }, "location": { "district": "Arjan" }, "sale_status": "on_sale" }, { "id": 766, "name": "555 Park Views", "developer": { "name": "Serene Developments" }, "location": { "district": "JVT (Jumeirah Village Triangle)" } }] ``` -------------------------------- ### Filtering Units by Layout Source: https://docs.reelly.ai/docs/available-units Examples of using the layout query parameter to filter units within a project. ```http GET /api/v2/clients/projects/1147/units?layout=7754GET /api/v2/clients/projects/1147/units?layout=null ``` -------------------------------- ### Handle unsupported currency error Source: https://docs.reelly.ai/docs/list-projects Example response when an unsupported currency value like 'ABC' is provided. ```json { "detail": "Server Error (500)" } ``` -------------------------------- ### GET /api/v2/clients/projects?unit_bedrooms=1,2.5,3 Source: https://docs.reelly.ai/docs/dictionaries-enums Filters projects by multiple bedroom configurations (1, 2.5, and 3). ```APIDOC ## GET /api/v2/clients/projects?unit_bedrooms=1,2.5,3 ### Description Filters projects to include those that have at least one unit matching any of the specified bedroom values (1, 2.5, or 3). ### Method GET ### Endpoint /api/v2/clients/projects ### Parameters #### Query Parameters - **unit_bedrooms** (string) - Required - Comma-separated numeric values representing bedroom configurations. For this example, values are 1, 2.5, and 3. ### Request Example GET /api/v2/clients/projects?unit_bedrooms=1,2.5,3 ### Response #### Success Response (200) - **projects** (array) - List of projects matching the filter. #### Response Example { "projects": [] } ``` -------------------------------- ### Common Usage - Filter Projects by Country Source: https://docs.reelly.ai/docs/metadata-apis Examples of using the country parameter in project and markers endpoints. ```http GET /api/v2/clients/projects?country=CyprusGET /api/v2/clients/projects/markers?country=United Arab Emirates ``` -------------------------------- ### Filter projects by criteria Source: https://docs.reelly.ai/docs/list-projects Examples of filtering the project list by country, region, location IDs, or status. ```text GET /api/v2/clients/projects?country=Cyprus GET /api/v2/clients/projects?region=Dubai GET /api/v2/clients/projects?location_ids=300,302 GET /api/v2/clients/projects?status=Under%20Construction ``` -------------------------------- ### First request: Projects List Source: https://docs.reelly.ai/docs Example of the first request to the Projects List endpoint. Replace `your_api_key_here` with your actual API key. The endpoint returns a list of real estate projects. ```http GET https://api.reelly.io/apiv2/clients/projectsHeaders: X-API-Key: your_api_key_here ``` -------------------------------- ### Get the first page (default pagination) Source: https://docs.reelly.ai/docs Fetches the first page of projects using the default pagination settings. ```http GET /api/v2/clients/projects ``` -------------------------------- ### GET /api/v2/clients/districts?language=fr - Response with translated descriptions Source: https://docs.reelly.ai/docs/metadata-apis Example response for the French language request. The description field is translated, while id and name are not translated. ```json [ { "id": 269, "name": "JVC (Jumeirah Village Circle)", "description": "Jumeirah Village Circle JVC est un quartier confortable et dynamique au cœur de Dubaï, alliant la tranquillité des banlieues et la commodité de la métropole..." }, { "id": 318, "name": "Reem", "description": "Reem est la premiere commune fermee a Dubai et constitue une oasis moderne..." }] ``` -------------------------------- ### Projects Map Markers Response Example Source: https://docs.reelly.ai/docs/projects-map-markers A sample JSON response containing the marker object structure, including location coordinates, developer details, and project status. ```json [ { "id": 478, "name": "320 Riverside Crescent", "developer": { "id": 56, "name": "Sobha", "logo": { "url": "https://api.reelly.io/vault/ZZLvFZFt/2ICnZvNCBrZuhI218X9zNa2ZE8I/JfqF7w../1537869753264.jpeg", "metadata": { "mime": "image/jpeg", "size": 280428, "width": 200, "height": 200 } } }, "location": { "id": 300, "latitude": 25.17710834882133, "longitude": 55.325266620021395, "country": 219, "region": "Dubai", "city": null, "district": "Sobha Hartland 2", "sector": "Meydan", "village": null }, "completion_datetime": "2027-07-31T00:00:00Z", "cover_image": { "url": "https://api.reelly.io/vault/ZZLvFZFt/ltB0PeYqF9paqGXLd4gTttDk-pU/1bO6CA../119.jpg", "metadata": { "mime": "image/jpeg", "size": 373377, "width": 1500, "height": 1033 } }, "sale_status": "on_sale", "min_price": 2257081.99535, "status": "under_construction", "is_partner_project": false }] ``` -------------------------------- ### Retrieve project details via GET request Source: https://docs.reelly.ai/docs/list-projects Request to fetch specific details for a project, including escrow information. ```http GET /api/v2/clients/projects/1147 ``` -------------------------------- ### GET /api/v2/clients/projects/languages Source: https://docs.reelly.ai/docs Retrieves the current list of supported language codes for the Reelly API. Use this endpoint to get valid language codes instead of hardcoding them. ```APIDOC ## GET /api/v2/clients/projects/languages ### Description Retrieves the current list of supported language codes for the Reelly API. Use this endpoint to get valid language codes instead of hardcoding them. ### Method GET ### Endpoint /api/v2/clients/projects/languages ### Response #### Success Response (200) - **language codes** (array of strings) - List of supported language codes (e.g., `en-us`, `ar`, `fr`). #### Response Example ```json { "languages": ["en-us", "ar", "fr", "de", "he", "hi", "it", "pl", "ru", "tr", "zh"] } ``` ``` -------------------------------- ### Project details response fragment Source: https://docs.reelly.ai/docs/list-projects Example response fragment for the project details endpoint, showing escrow-related data. ```json { "id": 1147, "name": "Example Project With Escrow", "has_escrow": true, "buildings": [ { "id": 2001, "name": "Tower A", "escrow": "1234567890" // ... } ] // ... } ``` -------------------------------- ### Response fragment for post_handover filter Source: https://docs.reelly.ai/docs/projects-map-markers Example JSON response fragment showing a marker object with id, name, sale_status, status, and min_price. Payment plan data is not included in marker responses. ```json [ { "id": 791, "name": "48 Parkside", "sale_status": "on_sale", "status": "under_construction", "min_price": 1159000.0149 }] ``` -------------------------------- ### GET /api/v2/clients/projects/sale-statuses?language=fr - Request and Response Source: https://docs.reelly.ai/docs/metadata-apis Request with the language parameter set to 'fr' to get status names in French, followed by the response array containing translated status names. ```http GET /api/v2/clients/projects/sale-statuses?language=fr ``` ```json [ "Annoncé", "En vente", "Épuisé", "Prévente (EOI)", "Début des ventes"] ``` -------------------------------- ### Filter projects by price type Source: https://docs.reelly.ai/docs/list-projects Example response structure for project list queries filtered by price type. ```json { "count": 3, "next": null, "previous": null, "results": [ { "id": 2211, "name": "Jacob and Co Beachfront Living", "min_price": 3044499.0, "max_price": 82499999.99, "price_currency": "AED", "min_size": 548.96, "max_size": 23196.41, "area_unit": "sqft", "...": "..." } ] } ``` -------------------------------- ### GET /projects/languages Source: https://docs.reelly.ai/docs Retrieves the supported languages. ```APIDOC ## GET /projects/languages ### Description Supported languages. ### Method GET ### Endpoint /projects/languages ### Parameters #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. ### Response #### Success Response (200) List of supported languages. #### Response Example ```json ["en", "ar", "ru"] ``` ``` -------------------------------- ### GET /api/v2/clients/projects/markers?unit_bedrooms=1 Source: https://docs.reelly.ai/docs/dictionaries-enums Filters markers by 1-bedroom units. ```APIDOC ## GET /api/v2/clients/projects/markers?unit_bedrooms=1 ### Description Filters markers to include only those that have at least one unit with exactly 1 bedroom. ### Method GET ### Endpoint /api/v2/clients/projects/markers ### Parameters #### Query Parameters - **unit_bedrooms** (string) - Required - Comma-separated numeric values representing bedroom configurations. For this example, value is 1. ### Request Example GET /api/v2/clients/projects/markers?unit_bedrooms=1 ### Response #### Success Response (200) - **markers** (array) - List of markers matching the filter. #### Response Example { "markers": [] } ``` -------------------------------- ### Response fragment for preferred_currency=USD Source: https://docs.reelly.ai/docs/projects-map-markers Example response fragment showing min_price converted to USD and price_currency set to 'USD'. ```json { "id": 791, "name": "48 Parkside", "min_price": 315000.55, "price_currency": "USD", "sale_status": "on_sale", "status": "under_construction"} ``` -------------------------------- ### GET /units/types Source: https://docs.reelly.ai/docs Retrieves the list of available unit types. ```APIDOC ## GET /units/types ### Description List of available unit types (Apartment, Villa, etc.). ### Method GET ### Endpoint /units/types ### Parameters #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. ### Response #### Success Response (200) List of unit types. #### Response Example ```json ["Apartment", "Villa", "Penthouse"] ``` ``` -------------------------------- ### Map Markers response fragment Source: https://docs.reelly.ai/docs/projects-map-markers Example JSON response fragment showing the structure of a project marker, including the min_price field. ```json [ { "id": 2211, "name": "Jacob and Co Beachfront Living", "developer": { "id": 500, "name": "Sample Developer" }, "location": { "id": 309, "country": 219, "region": "Dubai", "district": "JVC (Jumeirah Village Circle)", "latitude": 25.047261, "longitude": 55.199750 }, "completion_datetime": "2026-09-30T00:00:00Z", "cover_image": { "url": "https://api.reelly.io/vault/..." }, "sale_status": "on_sale", "min_price": 3044499.0, "status": "under_construction", "is_partner_project": false }] ``` -------------------------------- ### GET /developers/id/logo Source: https://docs.reelly.ai/docs Retrieves the logo and metadata for a specific developer. ```APIDOC ## GET /developers/id/logo ### Description Logo and metadata for a developer. ### Method GET ### Endpoint /developers/{id}/logo ### Parameters #### Path Parameters - **id** (integer) - Required - The developer ID. #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. ### Response #### Success Response (200) Logo and metadata for the developer. #### Response Example ```json {"id": 1, "name": "Emaar", "logo": "https://example.com/logo.png"} ``` ``` -------------------------------- ### Projects list response fragment Source: https://docs.reelly.ai/docs/list-projects Example response fragment for the projects list endpoint, showing that escrow fields are not included in the list results. ```json { "count": 4, "next": null, "previous": null, "results": [ { "id": 1147, "name": "Example Project With Escrow", "location": { "country": "United Arab Emirates", "region": "Dubai Emirate" }, "construction_status": "under_construction", "sale_status": "on_sale" // ... other list fields, but no escrow field here } ] } ``` -------------------------------- ### GET /developers/logos Source: https://docs.reelly.ai/docs Retrieves a lightweight list of developers with logos. ```APIDOC ## GET /developers/logos ### Description Lightweight list of developers + logos. ### Method GET ### Endpoint /developers/logos ### Parameters #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. ### Response #### Success Response (200) List of developers with logos. #### Response Example ```json [{"id": 1, "name": "Emaar", "logo": "https://example.com/logo.png"}] ``` ``` -------------------------------- ### GET /projects/sale-statuses Source: https://docs.reelly.ai/docs Retrieves a list of project sale statuses. ```APIDOC ## GET /projects/sale-statuses ### Description List of project sale statuses. ### Method GET ### Endpoint /projects/sale-statuses ### Parameters #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. ### Response #### Success Response (200) List of project sale statuses. #### Response Example ```json ["For Sale", "Sold Out", "Coming Soon"] ``` ``` -------------------------------- ### GET /projects/statuses Source: https://docs.reelly.ai/docs Retrieves a list of project lifecycle statuses. ```APIDOC ## GET /projects/statuses ### Description List of project lifecycle statuses. ### Method GET ### Endpoint /projects/statuses ### Parameters #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. ### Response #### Success Response (200) List of project lifecycle statuses. #### Response Example ```json ["Planned", "Under Construction", "Completed"] ``` ``` -------------------------------- ### GET /regions Source: https://docs.reelly.ai/docs Retrieves a list of regions with active projects. ```APIDOC ## GET /regions ### Description List of regions with active projects. ### Method GET ### Endpoint /regions ### Parameters #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. ### Response #### Success Response (200) List of regions. #### Response Example ```json ["Dubai Marina", "Downtown Dubai"] ``` ``` -------------------------------- ### Common Usage - Filter Projects by Status Source: https://docs.reelly.ai/docs/metadata-apis Example requests for filtering projects and markers by status using query parameters. ```http GET /api/v2/clients/projects?status=Under%20ConstructionGET /api/v2/clients/projects/markers?status=Completed ``` -------------------------------- ### GET /developers Source: https://docs.reelly.ai/docs Retrieves the full list of developers with updated structure. ```APIDOC ## GET /developers ### Description Full list of developers (updated structure). ### Method GET ### Endpoint /developers ### Parameters #### Query Parameters - **format** (string) - Optional - Supported values: `json`, `xml`. Default is `json`. ### Response #### Success Response (200) List of developers. #### Response Example ```json [{"id": 1, "name": "Emaar"}] ``` ```