Matchai Docs

Search addressesComing soon

Suggests real addresses for what someone typed.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/addresses

Coming soon. Suggests real addresses for what someone typed. Pass the chosen address_id to create a listing, move one, or set an appointment’s place. An address you type yourself is never stored: Matchai looks up the official address and its location from the id.

Scopes: listings:write or calendar:write

Pricing: Included with the connection.

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.

Scope: listings:write

Query Parameters

query*string

What was typed, for example "4521 rue Fabre".

Length3 <= length <= 200
near?string

Favour results near latitude,longitude.

Match^-?[0-9.]+,-?[0-9.]+$

Response Body

Suggestions, best first.

application/json
  1. response
data*array<>

Best match first.

Itemsitems <= 10
Example Request
curl -X GET 'https://api.matchai.co/v1/addresses?query=string'
Example Response
{  "data": [    {      "address_id": "string",      "description": "string",      "main_text": "string",      "secondary_text": "string"    }  ]}