Documentation

Get started

Build across the property journey.

Use the Homejourney Platform API or AI Connect MCP endpoint to connect organizations, property journeys, professional workspaces, and compatible AI clients.

Create API keyAI Connect guideAPI reference

AI Connect

Connect any compatible AI client.

Homejourney exposes one standards-based MCP endpoint for AI clients. Tool access is governed by OAuth scopes and the user's authorized Homejourney workspace, not by host-specific integrations.

Hosted Streamable HTTP MCP endpoint

https://ai-apps.homejourney.sg/mcp

Authorize with OAuth

Authorization code, dynamic client registration, and S256 PKCE for public clients. Bearer tokens carry the approved scopes.

Keep access proportional

Public-safe reads can remain unauthenticated. Private reads and writes require the matching account, role, workspace, and consent.

Confirm consequential work

Write tools declare their behavior and retain Homejourney confirmation, idempotency, audit, and owned handoff controls.

Connection sequence

  1. 1.Add the hosted MCP endpoint to any compatible AI client.
  2. 2.The client discovers Homejourney OAuth and registers as a public PKCE client.
  3. 3.Homejourney requests only the scopes needed for protected tools.
  4. 4.The client calls tools within their read, write, and confirmation annotations.
  5. 5.Users can review and revoke connected AI access from Homejourney settings.

Discovery documents

Protected resource metadataAuthorization server metadataPlatform status

Access and safety boundaries

  • Public discovery returns public-safe Singapore property, service, finance, and news data.
  • Private data and workspace tools require a signed-in Homejourney account and matching OAuth scopes.
  • Consequential actions require explicit confirmation, idempotency, and Homejourney audit controls.
  • Identity checks, sensitive consent, and payments continue on Homejourney-owned pages.

Integration and review support: [email protected]

Quickstart

Make your first request

Create a sandbox key in the API Console, then request the organization attached to that credential. Sandbox and live credentials are always isolated.

curl https://sandbox-platform-api.homejourney.sg/v1/organizations/current \
  -H "Authorization: Bearer hjp_test_your_key" \
  -H "Accept: application/json"

Authentication

Use scoped bearer credentials

Send your platform API key in the Authorization header. Never expose a live key in client-side code or commit it to your repository.

Authorization header

Authorization: Bearer hjp_test_your_key

Environments

Develop safely in the sandbox

Sandbox credentials use deterministic test fixtures and cannot authenticate against live hosts. Move to live access only after integration review.

Sandbox

hjp_test_
https://sandbox-platform-api.homejourney.sg/v1

Live

hjp_live_
https://platform-api.homejourney.sg/v1

Platform APIs

One API for connected property operations

Start with the surface closest to your product, then follow its scopes and related workflows in the REST reference.

Organizations

Start with account context

Resolve the organization, credential environment, scopes, products, and onboarding readiness for an integration.

GET /organizations/current

Property products

Connect real estate workflows

Build on listings, partner sites, official-source datasets, viewings, mortgage journeys, and service operations.

GET /products

Agents and agencies

Power professional workspaces

Read sandbox-safe listings, teams, analytics, viewings, distribution, and integration readiness.

GET /agents/current

Developer inventory

Publish and coordinate projects

Work with projects, unit types, inventory batches, price lists, media, showflat slots, and lead routing.

GET /developers/current/projects

Webhooks

React to platform events

Register endpoints, inspect delivery evidence, create sandbox test events, and safely replay deliveries.

GET /webhooks/endpoints

Valuation widget

Show home value estimates on your website.

Visitors search an address, postal code or condo and get the same sale or rent estimate as the Homejourney valuation page, with recent comparable transactions. To build your own interface instead, call the valuation routes with a key holding valuations.read.

Paste where the widget should appear

<div data-homejourney-valuation data-embed-key="hje_test_your_widget_key"></div>
<script src="https://www.homejourney.sg/embed/valuation.js" async></script>
  • Create a widget key in the API Console under Valuation widget, listing each website that will show it as an exact origin such as https://www.example.com. A key works only on those websites.
  • Widget keys are publishable, not secrets: they identify your website and never authenticate the Platform API. Each key allows 2,000 estimates a day.
  • Add data-theme="dark" to the container on a dark page. The widget renders in its own shadow root, so your styles and its styles do not affect each other.
  • The widget is a Homejourney-branded panel. If your site sets a Content Security Policy, allow https://www.homejourney.sg in script-src, connect-src, img-src and font-src, which load its script, estimates, logo and fonts.
  • The estimate is free. The widget always shows "Estimate by Homejourney" with a link and the disclaimer.
  • Showing estimates means accepting the valuation partner terms, Part C of our Terms of Service: keep the attribution, no resale, keep an estimate no longer than 30 days, and no bulk collection.

Ready to go deeper?

Explore every operation.

The interactive reference is generated from the same OpenAPI contract used by our SDK, CLI, and platform adapters.

Open REST API reference