Properties
Search for properties within a specified radius of a location, with optional filters for amenities, star ratings, property type, and deals etc.
Key Features:
Location-based search using latitude, longitude, and radius
Support for deal codes and deal-only filtering
Guest group allocation to match rooms with occupancy requirements
Optional filters for breakfast, free cancellation, swimming pool, and more
Sorting by distance or property name
Multi-language content support
Response: Returns an array of properties with their best available rates. Each property includes one or more room options with pricing. If deal codes are specified, the best available deal room rate for each supported deal code will also be provided. Properties without available inventory for the specified dates will be excluded.
Note: Results are paginated. Properties are sorted by distance (nearest first) by default.
The page number of the results to fetch
1The number of results per page. Must be a multiple of 10 (10, 20, 30, etc.). Use smaller values for faster response times, larger values to reduce API calls. Default: 20, Maximum: 100.
20Latitude coordinate for the center of the search area. Used with longitude and radius to define a geospatial search circle. Valid range: -90 to 90 degrees.
Longitude coordinate for the center of the search area. Used with latitude and radius to define a geospatial search circle. Valid range: -180 to 180 degrees.
The search radius in kilometers around the specified latitude and longitude. Properties within this distance from the center point will be included in results. Results are sorted by distance (nearest first) by default. Minimum: 15km, Maximum: 100km, Default: 15km.
15The arrival date. Must be within 500 days in the future and in the format yyyy-mm-dd.
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.
Specify total adults across all rooms when exact per-room allocation is not needed. Must be used together with totalRooms. The system will distribute guests across rooms.
Use Case: When you know the total guest count but not the specific room allocation.
Example: totalAdults=4, totalChildren=2, totalRooms=2 could match any room configuration that accommodates 4 adults and 2 children across 2 rooms.
Mutually exclusive with the rooms parameter.
Total number of children across all rooms. Must be used with totalRooms. Mutually exclusive with the rooms parameter.
Total number of rooms needed. Must be used with totalAdults and/or totalChildren. The system will find room configurations that can accommodate the total guest count. Mutually exclusive with the rooms parameter.
Specify the sorting criteria for the results.
distancePossible values: Specify the sorting direction for the results.
ascPossible values: Minimum star rating for properties in the results.
Maximum star rating for properties in the results.
Filter results to only include properties of a specific type. Common property types include: Hotel, Resort, Apartment, Guest House, Hostel, Motel, Villa, Bed & Breakfast, etc. This field is case-sensitive and must match the exact property type string configured in the system.
Only return rates for properties that have a swimming pool.
Only return rates with breakfast included.
Only return rates with free cancellation periods.
Return deal rates for properties participating in the specified deals. Provide one or more deal codes to include deal-specific pricing in the response. The API will validate that deals are active and applicable for the requested stay period.
Important Notes:
- When deal codes are provided, the response includes both standard rates and deal rates for each property
- Each property may support different deal codes
- Deal rates appear in the
pricesarray within each room, with thedealCodefield populated - Standard (non-deal) rates will have
dealCodeas null
When set to true, only return properties that have active rates for the specified deal codes. Properties without the deal or without available deal inventory will be excluded from results. This parameter requires dealCodes to be specified.
Specify the preferred language for returned content (property descriptions, room types, amenities). Falls back to the property's default language if the requested language is not available. Supported: de (German), en (English), es (Spanish), fr (French), id (Indonesian), it (Italian), pt (Portuguese), th (Thai).
Exclude self-rated properties from the response. Self-rated properties have star ratings assigned by the property owner rather than an official rating authority. Set to true to only include officially rated properties.
The api id for channel
The api key for channel
successful
Invalid request
Unauthorized
The specified resource was not found
The number of requests for the last 5 minutes window has reached the limit for the given channel
Unexpected error occurred
GET /properties?latitude=1&longitude=1&checkin=2026-01-01&checkout=2026-01-01 HTTP/1.1
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
}
],
"rateType": "sell",
"lowInventory": true
}
],
"specialConditions": {
"taxExemptions": [
{
"name": "is-nz-gst-opt-out"
}
]
},
"selfRated": true
}
]Still have questions?
Use the Ask button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues.
If you need more support, visit Integration Support.
Last updated
Was this helpful?