Matchai Docs

Get one published listingComing soon

Returns one published listing with its photos. Returns 404 for a draft or an archived listing.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/professionals/{username}/listings/{listing_id}

Coming soon. Returns one published listing with its photos. Returns 404 for a draft or an archived listing.

Scopes: none — public. An API key or token is optional and raises your rate limit.

Pricing: Free. No connection needed.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Path Parameters

username*string

The professional’s public handle.

Match^[a-z0-9][a-z0-9_-]{1,38}$
listing_id*string

Listing id, or its slug.

Length1 <= length <= 200

Query Parameters

locale?string

Return text in this language when a translation exists, the original text otherwise.

Value in"en-US""fr-CA""es"

Response Body

The listing.

application/json
  1. response

A published listing, as anyone can see it.

id*string

Listing id.

Length1 <= length <= 64
slug*string

URL-friendly name.

url*string

Public listing page.

Formaturi
title?|

Headline.

description?|

Description.

highlights*array<string>

Selling points.

availability*ListingAvailability

Where the property stands on the market.

Value in"available""sold""rented""withdrawn"
transaction_types*array<>

How it is offered.

price?|null
address?|null
coordinates?|null
neighbourhood?|

Neighbourhood.

neighbourhood_summary?|

About the area.

property*

The building facts. Areas are in square feet; convert square metres (1 m² = 10.7639 ft²).

virtual_tour_url?|

Virtual tour.

Formaturi
images*array<>

Photos, in gallery order.

professional*
listed_on?|

On the market since.

Formatdate
updated_at*string

Last changed.

Formatdate-time
Example Request
curl -X GET 'https://api.matchai.co/v1/professionals/string/listings/string'
Example Response
{  "id": "string",  "slug": "string",  "url": "http://example.com",  "title": "string",  "description": "string",  "highlights": [    "string"  ],  "availability": "available",  "transaction_types": [    "for_sale"  ],  "price": {    "amount": 1,    "currency": "string"  },  "address": {    "formatted": "string",    "street": "string",    "unit": "string",    "city": "string",    "region": "string",    "postal_code": "string",    "country": "string"  },  "coordinates": {    "latitude": -90,    "longitude": -180  },  "neighbourhood": "string",  "neighbourhood_summary": "string",  "property": {    "property_type": "house",    "building_type": "detached",    "categories": [      "residential"    ],    "bedrooms": 0,    "bathrooms": 0,    "living_area_sqft": 0,    "lot_size_sqft": 0,    "year_built": 1600,    "parking_spaces": 0,    "stories": 0  },  "virtual_tour_url": "http://example.com",  "images": [    {      "url": "http://example.com",      "zone": "gallery"    }  ],  "professional": {    "username": "string",    "display_name": "string"  },  "listed_on": "2019-08-24",  "updated_at": "2019-08-24T14:15:22Z"}