API Reference

Match listings to floor plans

post
https://api.redbricks.ca/api/v1/floorplan-matches

Match a batch of 1–100 MLS listings to Red Bricks floor plans. Each item must supply either project_id or address. Per-item: one bad item does not fail the batch. Requires the floorplan-match scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
matches
array of objects
required
length between 1 and 100
matches*

Must include either project_id or address.

integer
≥ 1

Required unless address is given. Wins if both are sent.

string
length ≤ 500

Required unless project_id is given.

string
length ≤ 255

Your own ID; echoed back in the result.

listing
object
required

Listing attributes. May be empty; more fields → better matches.

Responses

429

Rate limit exceeded (see Retry-After header).

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?