Properties

get

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.

Query parameters

pageinteger · min: 1Optional

The page number of the results to fetch

Default: 1

perPageinteger · max: 100Optional

The number of results per page

Default: 20

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: 100Optional

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.

Default: 15

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.

totalAdultsintegerOptional

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

totalChildrenintegerOptional

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: 10Optional

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 · enumOptional

Specify the sorting criteria for the results.

Default: distancePossible values:

sortDirectionstring · enumOptional

Specify the sorting direction for the results.

Default: ascPossible values:

minStarRatingnumber · enumOptional

Minimum star rating for properties in the results.

Possible values:

maxStarRatingnumber · enumOptional

Maximum star rating for properties in the results.

Possible values:

propertyTypestring · max: 255Optional

Limit search criteria to properties of a specific type.

swimmingPoolAvailablebooleanOptional

Only return rates for properties that have a swimming pool.

breakfastIncludedbooleanOptional

Only return rates with breakfast included.

freeCancellationbooleanOptional

Only return rates with free cancellation periods.

dealCodesstring[]Optional

return deal rate for properties that participates in the given deal

dealOnlybooleanOptional

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

languagestring · enumOptional

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

Possible values:

excludeSelfRatedbooleanOptional

Exclude self-rated properties from the response

Header parameters

x-sm-api-idstringRequired

The api id for channel

x-sm-api-keystringRequired

The api key for channel

Responses

200

successful

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

404

The specified resource was not found

application/json

429

The number of requests for the last 5 minutes window has reached the limit for the given channel

application/json

500

Unexpected error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /properties?latitude=1&longitude=1&checkin=2025-05-13&checkout=2025-05-13 HTTP/1.1
Host: 
x-sm-api-id: text
x-sm-api-key: text
Accept: */*

[
  {
    "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"
    },
    "amenities": [
      {
        "text": "text",
        "language": "text"
      }
    ],
    "acceptedCardTypes": [
      "AX"
    ],
    "totalCommissionPercentage": 1,
    "siteminderCommissionPercentage": 1,
    "channelCommissionPercentage": 1,
    "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"
        },
        "amenities": [
          {
            "text": "text",
            "language": "text"
          }
        ],
        "views": [
          {
            "text": "text",
            "language": "text"
          }
        ],
        "bedConfigurations": [
          {
            "bedCode": {
              "text": "text",
              "language": "text"
            },
            "quantity": 1
          }
        ],
        "adults": 1,
        "children": 1,
        "cancellationPolicy": {
          "policyType": "non-refundable",
          "freeCancellationUntilDays": 1
        },
        "prices": [
          {
            "totalPrice": 1,
            "dealCode": "text",
            "totalCommissionPercentage": 1,
            "siteminderCommissionPercentage": 1,
            "channelCommissionPercentage": 1
          }
        ],
        "lowInventory": true
      }
    ],
    "specialConditions": {
      "taxExemptions": [
        {
          "name": "is-nz-gst-opt-out"
        }
      ]
    },
    "selfRated": true
  }
]