Skip to main content
GET
/
{apiVersion}
/
{apiProvince}
/
search_listings
Search Listings
curl --request GET \
  --url https://api.getbuildify.com/{apiVersion}/{apiProvince}/search_listings \
  --header 'x-api-key: <api-key>'
{
  "results": [
    {
      "estimatedCompletionYear": 2024,
      "firstOccupancyDateTBD": false,
      "country": "Canada",
      "numberOfUnits": "354",
      "constructionStartedTBD": false,
      "state": "Ontario",
      "isFeatured": false,
      "logo": {
        "name": "logo",
        "url": "https://storage.googleapis.com/precon-app.appspot.com/74ea744b-0ec8-413d-9df3-9573c759a250.png"
      },
      "maxBaths": 2,
      "_geoloc": {
        "lat": 43.25477892843521,
        "lng": -79.86067799088214
      },
      "minBaths": 1,
      "assignmentFee": "<unknown>",
      "developmentLevies": "$8,000 for 1 Bedroom Den and smaller $10,000 for 2 Bedrooms and larger",
      "ccOrMaintFeeIncluded": false,
      "brokerages": [
        "<string>"
      ],
      "endPricePerSqFeet": 373990,
      "developmentLeviesIncluded": false,
      "long": "-79.86067799088214",
      "lockerMaintainance": 0,
      "sellingStatus": "Sold Out",
      "floorPlans": [
        {
          "contactForPricing": true,
          "exposure": [
            "<string>"
          ],
          "id": "32c908a2-b785-43ef-b4f8-59f816f06532",
          "floorPlanType": [
            "Condo"
          ],
          "image": {
            "name": "photo",
            "url": "https://storage.googleapis.com/precon-app.appspot.com/1347ce54-d9e6-4eed-bb3e-2b530ce0bd8e.png"
          },
          "name": "Glass",
          "numberOfBathrooms": 1,
          "numberOfBedrooms": 1,
          "planCategory": "floorPlan",
          "squareFeet": "431",
          "startPrice": "",
          "status": "Sold Out"
        }
      ],
      "constructionStatus": "Construction",
      "lockerMaintainanceIncluded": false,
      "streetName": "Jarvis Street",
      "completionDate": "",
      "virtualShowing": "",
      "builders": [
        "Builders/XAY63U2xQ7JTngGVRffU"
      ],
      "moveInReady": "<unknown>",
      "listingId": "NE9QFQ",
      "architects": [
        "Architects/NmHokKSx4TeTkuiaAzew"
      ],
      "parkingCostIncluded": false,
      "meteringIncluded": false,
      "maxSize": 840,
      "numberOfFloorPlans": 73,
      "salesCompanies": [
        "SalesCompanies/ungNkdpl44K3O5Cc5aRq"
      ],
      "hasParking": false,
      "estimatedCompletionDate": "Jan 2024",
      "photos": [
        {
          "createdAt": "2022-12-06T21:08:15.168Z",
          "name": "2.jpg",
          "tags": [
            "Exterior"
          ],
          "type": "image/jpeg",
          "url": "https://storage.googleapis.com/precon-app.appspot.com/a1916cee-a4a1-4f57-b12d-8a1dcde55f38"
        }
      ],
      "storageCostIncluded": false,
      "maxBeds": 3,
      "estimatedCompletionDateTBD": false,
      "averagePricePerSqFeet": 760,
      "startPrice": "<unknown>",
      "parkingCost": 60000,
      "minBeds": 1,
      "marketingCompanies": [
        "Marketers/58bBz696X7ry4FnN9VHX"
      ],
      "storageCost": 6000,
      "endPrice": "<unknown>",
      "contactForPricing": true,
      "region": "Toronto",
      "assignmentFeeFree": true,
      "interiorDesigners": [
        "InteriorDesigners/7cqJvviYNIxwHZowfBZK"
      ],
      "firstOccupancyDate": "Jan 2024",
      "owners": [
        "<string>"
      ],
      "hasLocker": false,
      "startPricePerSqFeet": 631,
      "numberOfIncentives": 0,
      "summary": "Be a part of the transformation as Hamilton becomes one of the best places to live in Canada. The downtown core pulses with life around the clock. It’s where you’ll find many live music venues, late-night eateries, top attractions and places where people go to shop and hang out.\n",
      "ccOrMaintFee": 0.56,
      "geographicAddress": "1 Jarvis Street, Toronto",
      "fullAddress": "1 Jarvis Street, Toronto",
      "name": "1 Jarvis",
      "streetNumber": 1,
      "minSize": 431,
      "exposures": [
        "<string>"
      ],
      "coverPhoto": {
        "name": "cover",
        "url": "https://storage.googleapis.com/precon-app.appspot.com/dbc75004-fe49-49b8-888e-04f729c0cc65.png"
      },
      "salesStarted": "Winter/Spring 2021",
      "parkingMaintainance": 0,
      "type": [
        "Condo"
      ],
      "paymentStructures": [
        {
          "milestones": [
            {
              "amount": 5000,
              "prefix": "",
              "suffix": "on signing",
              "text": "$5000 on signing",
              "type": "fixed"
            }
          ],
          "totalDeposit": 20,
          "type": "Standard"
        }
      ],
      "neighbourhood": [
        "Beasley"
      ],
      "completionDateTBD": false,
      "ceilingHeights": "From 8'6\" to 9'9\"",
      "postalCode": "L8R 3J2",
      "amenities": [
        "Co Working Lounge"
      ],
      "cityOrDistrict": "Toronto",
      "parkingRestriction": "",
      "finishes": "",
      "municipalities": [
        "Hamilton"
      ],
      "incentives": [
        "<string>"
      ],
      "metering": "",
      "storageRestriction": "",
      "parkingMaintainanceIncluded": false,
      "lat": "43.25477892843521",
      "videos": [
        "<string>"
      ],
      "path": "Listings/NE9QFQ",
      "isPreLaunch": false,
      "objectID": "NE9QFQ"
    }
  ],
  "total": 1091,
  "page": 0,
  "pages": 55,
  "perPage": 20
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

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

Query Parameters

​
search
string

The given search string is searched from listing's name, summary, amenities, cityOrDistrict, streetName, country, neighbourhood. See more info.

​
page
string

Fetch the given page of the results, starts from 0. See more info.

​
perPage
string

Number of results to be fetched per page.

​
facets
string

Facets to fetch, possible values can be amenities, builders, marketers, etc. It should be comma separated. See more info.

​
filterQuery
string

Query to filter the listings. This parameter will work if the retrieveAttributes is also filled in. See more info.

​
retrieveAttributes
string

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

​
highlightResults
boolean

Highlight the strings matching the search.

​
nearby
string

Fetch listings nearby to the given coordinates. See more info.

​
radius
integer<int32>

Listings under the given radius. See more info.

​
referrences
string

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

​
sortBy
string

Sort by either name, price or sellingStatusUpdateTimestamp

​
sortOrder
string

asc for ascending, dsc for descending

​
searchWithin
string

Comma separated list of values to be used for searching, by default all the values are used. Only acceptable values are from name, summary, amenities, cityOrDistrict, streetName, country, neighbourhood, fullAddress, listingId

Response

200

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

1091

​
page
integer
default:0
Example:

0

​
pages
integer
default:0
Example:

55

​
perPage
integer
default:0
Example:

20