Matchai Docs

List a professional’s published listingsComing soon

Returns the listings a professional has published, newest first.

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

Coming soon. Returns the listings a professional has published, newest first. Drafts and archived listings never appear. This is the same information as their public listing pages, so it is free.

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}$

Query Parameters

limit?integer

How many results per page.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor of the previous page. Cursors expire after 24 hours.

Lengthlength <= 512
locale?string

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

Value in"en-US""fr-CA""es"
availability?string

Only listings in this state.

Value in"available""sold""rented""withdrawn"
transaction_type?string

Only listings offered this way.

Value in"for_sale""for_rent""short_term_rental""sublet""auction""foreclosure""fractional_ownership""pre_construction""private_sale"

Response Body

One page of published listings.

application/json
  1. response

One page of results. Pass next_cursor as cursor to get the next page; it is null on the last page.

data*array<>
next_cursor*|

Cursor for the next page, or null when there are no more results.

Example Request
curl -X GET 'https://api.matchai.co/v1/professionals/string/listings'
Example Response
{  "data": [    {      "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"    }  ],  "next_cursor": "string"}