> ## Documentation Index
> Fetch the complete documentation index at: https://docs.proptyerp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Propty API docs

> Pull real estate data from Odoo using the External API

# Propty API

Use Odoo’s [External API](https://www.odoo.com/documentation/18.0/developer/reference/external_api.html) to read (and write) records from model **`real_estate.real_estate`**.

These pages follow the **18.0** Propty codebase (`real_estate`, plus `immoweb`, `immoscoop`, `ots_whise_odoo_migration` when installed).

## What this documents

| Item | Value |
| - | - |
| Odoo model | `real_estate.real_estate` |
| Protocol | JSON-RPC or XML-RPC |
| Endpoint (JSON-RPC) | `https://<your-odoo-host>/jsonrpc` |
| Auth | `authenticate` → `uid` + `password` / API key |

## Quick path

<Steps>
  <Step title="Authenticate">
    Get a `uid` with database name, login, and password (or API key).
  </Step>

  <Step title="search_read">
    Call `execute_kw` on `real_estate.real_estate` with domain + field list.
  </Step>

  <Step title="Map fields">
    Use the technical names in the field reference (e.g. `estate_asking_price`, not the Dutch UI label).
  </Step>
</Steps>

## Next

* [Authentication](/docs/guides/authentication)
* [Pull properties](/docs/guides/pull-properties)
* [WHISE import](/docs/guides/whise-import)
* [Model overview](/docs/api-reference/overview)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.