Introduction

Welcome to the Real Estate Projects API documentation.
This REST API provides a robust and secure programming interface for integrating, retrieving, and managing data related to real estate projects, including projects, floorplans, pricing, locations, developers, and associated companies.
It is designed to support seamless integration with external systems and partner solutions.

This documentation contains details about available endpoints, request and response formats, authentication, and practical usage examples.

Key Features

Architecture: RESTful, with resources accessed using HTTP GET requests.
Data Format: All requests and responses use standard JSON.
Authentication: Secure access using Team Command Tokens. All endpoints require authentication. See the Authenticating requests section for details.
Comprehensive Data: Provides access to projects, floorplans, cities, districts, neighbourhoods, developers, architects, interior designers, prices, documents, sales & marketing companies, and special incentives.
Rate Limiting: Up to 60 requests per minute per team. Exceeding this limit results in a 429 Too Many Requests response.
Error Handling: Standardized JSON error responses for common issues such as authentication failures (401 Unauthenticated), missing resources, and rate limits.
Centralized Database: The API interacts with a centralized and regularly updated database of real estate projects.

404 Not Found responses

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "message": "Resource not found"
}

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "message": "Project not found"
}

The API returns clear and consistent 404 responses in two main cases:

Resource not found: If you request a non-existent endpoint (for example, a typo in the URL), you will receive:

{Model} not found: If you request a valid endpoint but the specific resource (like a Project, Developer, etc.) does not exist, you will receive: The model name in the message will match the type of resource you requested (e.g., "Developer not found").

How to Use

Obtain your team command token from your team administrator or team management dashboard.
Include your team token in the Authorization header of every request:
Authorization: Bearer {YOUR_TEAM_TOKEN}
Explore the available endpoints below to find the data you need.

If you have any questions or need support, please contact your API administrator.

200Successful response

401Unauthenticated