Guides
Start typing to search…

Reelly API v2.0: Getting Started

About Reelly

Reelly is a digital platform for real estate professionals, developers, and marketplaces. It provides access to a unified catalogue of real estate projects, developers, and related data through a simple and consistent API. The API is designed for integration into CRM systems, marketplaces, or partner platforms that need to display or analyze real estate information in real time.

Reelly's API is built around read-only endpoints (GET requests only), giving partners secure and structured access to the platform's data without altering source information.

What You'll Achieve

  • build property catalogs
  • power search and filter interfaces
  • integrate project listings into websites and CRM systems
  • fetch map-optimized markers
  • access dynamic dictionaries (countries, regions, statuses, etc.)

The API is fully read-only (GET-only). This ensures safety, consistency, and prevents unauthorized changes.

Key Features

GET-only API: No write operations. Secure and stable.

Stable entities: Projects, Developers, Locations, Regions, Countries, Markers.

Dynamic lookup tables: Sale statuses, project statuses, languages, etc.

Advanced filtering & sorting: Country, region, location, developer, price range, size, status.

Map-optimized endpoints: /projects/markers returns lightweight marker payloads.

Geodata support: Polygons, LineStrings, latitude/longitude for mapping.

Environments & Base URL:

Protocol: HTTP/1.1 (REST)

Production (used for all queries): https://api-reelly.up.railway.app/api/v2/clients

Sandbox: Not provided

Authentication

Header Name: X-API-Key

Value: Your unique API key provided by the Reelly sales team.

Your API Key is secret. Do not expose it in client-side code (frontend), do not publish it in public repositories, and do not share it with unauthorized third parties.

To obtain your API key, please contact Reelly Sales Department or your account manager. The key is unique for each client and must be included in every request header.

No IP or domain restrictions.

Authentication errors:

401 Unauthorized: Missing API key.

403 Forbidden: Invalid / expired API key.

Rate Limits

Reelly enforces soft rate-limits to protect infrastructure.

Typical limits: 300–600 requests/minute (varies per contract).

If limits are exceeded: HTTP 429 Too Many Requests

Recommended:

  • cache dictionary endpoints
  • avoid unnecessary loops
  • use pagination (recommended pattern described below)

Request Format

JSON is the primary and fully supported format, and it is used by default. When format=xml is provided, the response is returned in XML, but the XML representation is simplified and may not reflect the full structure available in JSON.

Field name: format

Type: string

Required: no

Default: json

Notes: Supported values: json, xml. JSON is the main and complete format.

Example: GET /projects?country=Dubai&format=json

Response Structure & Conventions

JSON Structure Responses may include:

  • primitives (string, int, float, boolean)
  • arrays
  • nested objects

Geodata Projects may include:

  • polygon (LineString)
  • latitude, longitude

Media Image metadata follows a consistent structure:

{
  "url": "https://...",
  "metadata": {
    "mime": "image/png",
    "size": 689825,
    "width": 500,
    "height": 500
  }
}

Pagination

All list endpoints in the Reelly Clients API use a consistent offset-based pagination model.

Pagination Parameters

limit

Field name: limit

Type: integer

Required: No

Default: 20

Notes: Defines how many items are returned per page.

offset

Field name: offset

Type: integer

Required: No

Default: 0

Notes: Number of items to skip before starting the page.

Pagination Fields in Responses

All paginated endpoints return the same envelope:

{
  "count": 1906,
  "next": "https://api-reelly.up.railway.app/api/v2/clients/projects?limit=20&offset=20",
  "previous": null,
  "results": [
    { "...": "..." }
  ]
}

count- Total number of matching records across all pages.

next - Full URL for the next page, including updated offset.

previous - Full URL for the previous page.

results - Items for the current page.

Typical Usage

Get the first page (default pagination): GET /api/v2/clients/projects

Get the second page: GET /api/v2/clients/projects?limit=20&offset=20

Increase or decrease page size: GET /api/v2/clients/projects?limit=50

Jump to an arbitrary offset (example: page 10 with 20 items per page): GET /api/v2/clients/projects?limit=20&offset=180

Endpoint Overview

Metadata / Dictionaries

GET /countries - List of countries where active projects exist.

GET /regions - List of regions with active projects.

GET /locations - List of available project locations.

GET /projects/statuses - List of project lifecycle statuses.

GET /projects/sale-statuses - List of project sale statuses.

GET /projects/languages - Supported languages.

Developers

GET /developers - Full list of developers (updated structure).

GET /developers/logos - Lightweight list of developers + logos.

GET /developers/{id}/logo - Logo and metadata for a developer.

Projects

GET /projects - Main endpoint: full list with extensive filtering.

GET /projects/{id} - Full detailed project card.

GET /projects/markers - Lightweight map-optimized project markers.

Units

GET /units/types - List of available unit types (Apartment, Villa, etc.).

First Request

To get started, try the Projects List endpoint — it returns the list of real estate projects available through the Reelly platform.

GET https://api-reelly.up.railway.app/api/v2/clients/projects Headers: X-API-Key: your_api_key_here

Error Handling

Standard HTTP Codes

200 OK - Successful response

400 Bad Request - Invalid parameters

401 Unauthorized - Missing API key

403 Forbidden - Invalid/expired API key

404 Not Found - Resource does not exist

429 Too Many Requests - Rate limit exceeded

500 Internal Server Error - Platform error

Support and Contact

For API support, questions, or feedback:

Email: [email protected]

Documentation site: https://reelly-oixr.readme.io/

Updated 2 months ago