Build on Matchai

Real estate professionals publish their listings, their website (a Matchai Site) and a one-page profile (a Matchai Page) on Matchai. Everything they publish can be read by software, and that part works today with no account, no API key and no approval.

The next step is letting software work inside a professional's account, with their permission: keep their listings current, add their leads, book their visits. That part is planned. This section documents both, and marks what is not live yet.

What is live todayCopy link to this section

The OpenAPI file at /openapi.json describes these public, read-only endpoints and nothing else. The planned API has its own contract, described below.

Try itCopy link to this section

This request searches every published listing on Matchai and returns up to 10 matches as JSON:

curl "https://matchai.co/ask?query=3+bedroom+condo+in+Laval+under+600k"

The listing search page explains the request, the response and the limits.

Ground rules for the public surfacesCopy link to this section

• Read-only and public. Nothing here changes data, and nothing is tied to a user account.
• Published data only. Listings, sites and pages a professional has not published are never returned. Phone numbers and email addresses appear only where the professional chose to publish them on their business card.
• Fair-use limits. Each public endpoint limits how many requests one caller can make per minute. The limits are on one page.
• Results are not for sale. Results are ordered by relevance to the request and by how recently the listing was updated. No broker can pay to change the order or to be included.
• Link back. When you show a listing, link to its listing page. That page is the source for the current price, status and details.

What is comingCopy link to this section

The Matchai API lets an app act for one Matchai account: read and edit its listings, keep its contacts, send messages, book visits, file documents and hear about changes. It can do what the account holder can do in Matchai, under the same rules and permissions, and nothing more. None of it is open yet. The pages below describe how it will work, so you can plan.

Four rules shape all of it:

• One credential, one account. A key or token never reaches another account's data. An app that serves three professionals holds three connections.
• Final actions ask first. Sending, publishing, paying and deleting wait for the account holder's approval unless they chose Allowed for your app.
• Public reads stay free. Reading what a professional has already published needs no connection. Connecting an app to an account is a paid Matchai Connector, and an app connected only to its developer's own account is in free test mode.
• Energy is a state, never a number. Actions that use AI or send messages by text spend Matchai Energy, like they do in the app.

Start with the quickstart, then read authentication.

Who this is forCopy link to this section

• Developers building with AI assistants. Connect the MCP server to your own assistant or script, or call listing search directly. Both work today.
• Website builders. If you host a broker's website on Matchai, every AI-readable page is already there. When the API opens, you will be able to read a broker's listings, send their website leads into their Matchai contacts, book viewings against their real availability, and hear about changes with webhooks. A broker connects their account to your product with Connect with Matchai.
• Brokers and teams who script their own tools. Use an API key to work with your own account from your own code.
• People who want their own assistant to know Matchai listings. Add the MCP server to Claude or ChatGPT in a few minutes. The steps are in the MCP server guide.