Properties

Find properties that match given search criteria. The response is an array of properties sorted by distance (nearest to furthest) unless otherwise specified. Each property includes a recommended package of the best available non-deal room rate. If deal codes are included, the best available deal room rate for each supported deal code will also be provided.

get

/properties

Query parameters

pageinteger · min: 1 · default: 1

The page number of the results to fetch

perPageinteger · max: 100 · default: 20

The number of results per page

latitudenumber · min: -90 · max: 90required

Specify a longitude (as well as a latitude and radius) to do searches around a specific location.

longitudenumber · min: -180 · max: 180required

Specify a longitude (as well as a latitude and radius) to do searches around a specific location.

radiusnumber · min: 15 · max: 100 · default: 15

The radius in Km to search around the specified latitude and longitude. The minimum value (and the default) is 15 and the maximum is 100.

checkinstring · daterequired

The arrival date. Must be within 500 days in the future and in the format yyyy-mm-dd.

checkoutstring · daterequired

The departure date. Must be later than checkin. Must be between 1 and 30 days after checkin. Must be within 500 days in the future and in the format yyyy-mm-dd.

roomsobject[]

totalAdultsinteger

Specify the total number of adults, must also specify totalRooms field. Do not use this if searching with occupants rooms list.

totalChildreninteger

Specify the total number of children, must also specify totalRooms field. Do not use this if searching with occupants rooms list.

totalRoomsinteger · min: 1 · max: 10

Specify the total number of rooms, must also specify totalAdults and/or totalChildren fields. Do not use this if searching with occupants rooms list.

sortBystring · enum · default: distance

Specify the sorting criteria for the results.

Options: distance, name

sortDirectionstring · enum · default: asc

Specify the sorting direction for the results.

Options: asc, desc

minStarRatingnumber · enum

Minimum star rating for properties in the results.

Options: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, 5.5, 6

maxStarRatingnumber · enum

Maximum star rating for properties in the results.

Options: 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, 5.5, 6

propertyTypestring · max: 255

Limit search criteria to properties of a specific type.

swimmingPoolAvailableboolean

Only return rates for properties that have a swimming pool.

breakfastIncludedboolean

Only return rates with breakfast included.

freeCancellationboolean

Only return rates with free cancellation periods.

dealCodesstring[]

dealOnlyboolean

exclude properties that are not on the deal with the given dealCode

languagestring · enum

used to specify is preferred language to return and fallback to property's default language

Options: de, en, es, fr, id, it, pt, th

Header parameters

x-sm-api-idstringrequired

The api id for channel

x-sm-api-keystringrequired

The api key for channel

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/properties?latitude=1&longitude=1&checkin=2025-02-28&checkout=2025-02-28' \
  --header 'x-sm-api-id: text' \
  --header 'x-sm-api-key: text'

200

400

401

404

429

500

200

[
  {
    "uuid": "text",
    "name": "text",
    "propertyType": {
      "text": "text",
      "language": "text"
    },
    "description": {
      "text": "text",
      "language": "text"
    },
    "address": "text",
    "suburb": "text",
    "state": "text",
    "country": "text",
    "email": "text",
    "phoneNumber": "text",
    "language": "text",
    "latitude": 1,
    "longitude": 1,
    "checkinStartTime": "text",
    "checkinEndTime": "text",
    "checkoutEndTime": "text",
    "starRating": 1,
    "currency": "text",
    "photo": {
      "url": "https://example.com",
      "captions": "text"
    },
    "totalCommissionPercentage": 1,
    "siteminderCommissionPercentage": 1,
    "channelCommissionPercentage": 1,
    "specialConditions": {
      "taxExemptions": [
        {
          "name": "is-nz-gst-opt-out"
        }
      ]
    },
    "amenities": [
      {
        "text": "text",
        "language": "text"
      }
    ],
    "acceptedCardTypes": [
      "AX"
    ],
    "rooms": [
      {
        "roomRateUuid": "text",
        "roomTypeName": {
          "text": "text",
          "language": "text"
        },
        "roomTypeDescription": {
          "text": "text",
          "language": "text"
        },
        "ratePlanName": "text",
        "breakfastIncluded": true,
        "roomArea": "text",
        "photo": {
          "url": "https://example.com",
          "captions": "text"
        },
        "adults": 1,
        "children": 1,
        "cancellationPolicy": {
          "freeCancellationUntilDays": 1,
          "policyType": "non-refundable"
        },
        "lowInventory": true,
        "amenities": [
          {
            "text": "text",
            "language": "text"
          }
        ],
        "views": [
          {
            "text": "text",
            "language": "text"
          }
        ],
        "bedConfigurations": [
          {
            "bedCode": {
              "text": "text",
              "language": "text"
            },
            "quantity": 1
          }
        ],
        "prices": [
          {
            "totalPrice": 1,
            "dealCode": "text",
            "totalCommissionPercentage": 1,
            "siteminderCommissionPercentage": 1,
            "channelCommissionPercentage": 1
          }
        ]
      }
    ]
  }
]

successful