Skip to main content
GET
/
{apiVersion}
/
{apiProvince}
/
similar_listings
Get Similar Listings
curl --request GET \
  --url https://api.getbuildify.com/{apiVersion}/{apiProvince}/similar_listings \
  --header 'x-api-key: <api-key>'
{
  "results": [
    {
      "_score": 52.27,
      "contactForPricing": true,
      "coverPhoto": {
        "name": "cover",
        "url": "https://storage.googleapis.com/precon-app.appspot.com/a8e6df7d-3161-42fe-a3f4-25d58fa4170e.png"
      },
      "createdAt": "2023-01-02T19:39:06.490Z",
      "endPrice": "<unknown>",
      "exposures": [
        "<string>"
      ],
      "floorPlans": [
        "<string>"
      ],
      "fullAddress": "",
      "geographicAddress": "",
      "hasLocker": false,
      "hasParking": false,
      "listingId": "DC6NO5",
      "maxBaths": "<unknown>",
      "maxBeds": "<unknown>",
      "maxSize": "<unknown>",
      "minBaths": "<unknown>",
      "minBeds": "<unknown>",
      "minSize": "<unknown>",
      "mode": "live",
      "name": "TEST LISTING",
      "objectID": "DC6NO5",
      "path": "Listings/DC6NO5",
      "sellingStatus": "Selling Now",
      "startPrice": "<unknown>",
      "updatedAt": "2023-01-02T19:39:06.495Z"
    }
  ],
  "perPage": 5,
  "total": 5,
  "pages": 1,
  "page": 0
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
apiVersion
enum<string>
required
Available options:
v1-sandbox,
v1
​
apiProvince
enum<string>
default:on
required
Available options:
all,
on,
bc,
ab,
mb,
nb,
nl,
ns,
pe,
qc,
sk

Query Parameters

​
id
string
required

Listing id for which similar listings needs to be fetched.

​
retrieveAttributes
string

Attributes to retrieve. For example: name, summary, builders, etc. It should be comma separated. See more info.

​
referrences
string

Fields to attach referrences. For example: builders, marketers, etc. It should be comma separated. See more info.

​
minScore
integer<int32>

Listings minimum similarity score.

​
maxRecommendations
integer<int32>

Maximum number of recommendations/results.

Response

200

​
results
object[]
​
perPage
integer
default:0
Example:

5

​
total
integer
default:0
Example:

5

​
pages
integer
default:0
Example:

1

​
page
integer
default:0
Example:

0