CalryOTA Docs
Search

Search for listings with flexible dates

Search for available listings based on specified criteria such as flexible dates, location, and amenities

GET
/api/v1/search/flexible

Authorization

x-calry-api-key
x-calry-api-key<token>

In: header

Query Parameters

location?string

Location coordinates in format "latitude,longitude"

radius?number

Search radius in kilometers from the specified location

Range0 <= value
guests?number

Number of guests

Range1 <= value
page?number

Page number for pagination

Default1
Range1 <= value
limit?number

Number of results per page

Default50
Range1 <= value <= 100
displayCurrency?string

Currency to display prices in (ISO 4217 currency code)

minPrice?number

Minimum price per night

Range0 <= value
maxPrice?number

Maximum price per night

Range0 <= value
bedroomCount?number

Minimum number of bedrooms

Range0 <= value
bathroomCount?number

Minimum number of bathrooms

Range0 <= value
amenities?array<string>

Array of amenity IDs to filter by

petFriendly?boolean

Filter for pet-friendly listings

promotionID?string

Filter by promotion ID

promoted?boolean

Filter for promoted listings only

zoom?number

Map zoom level for location-based searches

listingIDs?array<string>

Array of listing IDs to filter the search results

tags?array<string>

Array of tag IDs to filter listings

propertyType?array<>

Type of the property (single or multiple values, comma-separated)

flexibility*object

Flexible date option. Format: "_DAY|WEEK|WEEKEND|MONTH|YEAR"

searchRange*array<string>

Array of date ranges in format "YYYY-MM-DD_YYYY-MM-DD"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/search/flexible?searchRange=2025-09-01_2025-09-07&searchRange=2025-09-10_2025-09-12"
{
  "checkInDate": "2025-06-15",
  "checkOutDate": "2025-06-22",
  "location": "37.7749,-122.4194",
  "radius": 10,
  "guests": 2,
  "amenities": [
    "wifi",
    "pool",
    "kitchen"
  ],
  "promotionID": "123e4567-e89b-12d3-a456-426614174000",
  "listings": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "providerID": "3827197",
      "integrationAccountID": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Cozy Apartment with Ocean View",
      "description": "This beautiful apartment offers stunning ocean views...",
      "address": {
        "city": "San Francisco",
        "line1": "123 Main St",
        "line2": "Apt 1",
        "state": "CA",
        "country": "United States",
        "postal_code": "94101"
      },
      "thumbnailURL": "https://example.com/images/listing_thumbnail.jpg",
      "pictures": [
        {
          "url": "https://example.com/images/listing_1.jpg",
          "description": "Living room with ocean view"
        }
      ],
      "rating": {
        "count": 42,
        "average": 4.8
      },
      "maxOccupancy": 4,
      "currency": "USD",
      "latitude": 37.7749,
      "longitude": -122.4194,
      "bedroomCount": 2,
      "bathroomCount": 1.5,
      "avgNightlyPrice": 150,
      "distance": 3.5,
      "tags": [
        {
          "id": "a1111111-1111-1111-1111-111111111111",
          "name": "Beachfront"
        },
        {
          "id": "b2222222-2222-2222-2222-222222222222",
          "name": "Pet Friendly"
        }
      ],
      "isPromoted": true,
      "promotionValue": 20,
      "amenities": {
        "categories": {
          "Common Amenities": {
            "categoryID": "common",
            "values": [
              {
                "name": "Wifi",
                "id": "amenity-123"
              },
              {
                "name": "Kitchen",
                "id": "amenity-123"
              },
              {
                "name": "Iron",
                "id": "amenity-123"
              },
              {
                "name": "Pet friendly",
                "id": "amenity-123"
              },
              {
                "name": "Bed linens",
                "id": "amenity-123"
              }
            ]
          },
          "Outdoor": {
            "categoryID": "outdoor",
            "values": [
              {
                "name": "Smoking allowed",
                "id": "amenity-123"
              }
            ]
          }
        }
      },
      "priceModifications": {
        "defaultDiscount": {
          "percentage": 10,
          "value": 15
        },
        "markup": {
          "percentage": 5,
          "value": 7.5
        },
        "promotionDiscount": {
          "percentage": 15,
          "value": 22.5,
          "promotionID": "123e4567-e89b-12d3-a456-426614174000",
          "promotionName": "Summer Sale"
        }
      }
    }
  ],
  "meta": {
    "count": 120,
    "limit": 20,
    "previous": 1,
    "current": 2,
    "next": 3,
    "pages": 6
  }
}
Empty
{
  "timestamp": "2025-03-05T11:45:49.631Z",
  "path": "<URL_PATH>",
  "message": "Authentication failed",
  "details": []
}