Sign in

v1

latestOpenAPI 3.0.02026-07-26190104.7 KB
Listings

Get all the listings included in the booking engine

This call returns the list of listings connected to the requester Booking Engine API instance in Guesty and filtered by given parameters.

get/api/listings

Query parameters

minOccupancyinteger
Example:1

The minimum value of listing occupancy

numberOfBedroomsinteger
Example:1

The minimum amount of listing bedrooms

numberOfBathroomsinteger
Example:1

The minimum amount of listing bathrooms

propertyType'APARTMENT' | 'HOUSE' | 'LOFT' | 'BOAT' | 'CAMPER_RV' | 'CONDOMINIUM' | 'CHALET' | 'BED_Breakfast' | 'VILLA' | 'TENT' | 'OTHER' | 'CABIN' | 'TOWNHOUSE' | 'BUNGALOW' | 'HUT' | 'DORM' | 'PARKING_SPACE' | 'PLANE' | 'TREEHOUSE' | 'YURT' | 'TIPI' | 'IGLOO' | 'EARTH_HOUSE' | 'ISLAND' | 'CAVE' | 'CASTLE' | 'STUDIO'
Example:APARTMENT

The listing property type.

listingType'SINGLE' | 'MTL' | 'MTL_CHILD'
Example:SINGLE

The listing type.

roomType'PRIVATE_ROOM' | 'ENTIRE_HOME_APT' | 'SHARED_ROOM'
Example:PRIVATE_ROOM

The listing room type.

minPricenumber
Example:10

Minimum value of listing price. If it provided, the response will have listings which price is great or equal. Should be passed with currency query parameter

maxPricenumber
Example:10

Maximum value of listing price. If it provided, the response will have listings which price is less or equal. Should be passed with currency query parameter

currency'USD' | 'EUR' | 'AUD' | 'CAD' | 'JPY' | 'ILS' | 'GBP' | 'HKD' | 'NOK' | 'CZK' | 'BRL' | 'CHF' | 'THB' | 'ZAR' | 'MYR' | 'KRW' | 'IDR' | 'PHP' | 'INR' | 'NZD' | 'TWD' | 'PLN' | 'SGD' | 'TRY' | 'SEK' | 'VND' | 'ARS' | 'CNY' | 'DKK' | 'MXN'
Example:EUR

Listing price currency. Should be provided with minPrice query parameter

includeAmenities'ACCESSIBLE_HEIGHT_BED' | 'ACCESSIBLE_HEIGHT_TOILET' | 'AIR_CONDITIONING' | 'BABYSITTER_RECOMMENDATIONS' | 'BABY_BATH' | 'BABY_MONITOR' | 'BATHTUB' | 'BBQ_GRILL' | 'BEACH_ESSENTIALS' | 'BED_LINENS' | 'BREAKFAST' | 'CABLE_TV' | 'CARBON_MONOXIDE_DETECTOR' | 'CATS' | 'CHANGING_TABLE' | 'CHILDREN_BOOKS_AND_TOYS' | 'CHILDREN_DINNERWARE' | 'CLEANING_BEFORE_CHECKOUT' | 'COFFEE_MAKER' | 'COOKING_BASICS' | 'CRIB' | 'DISABLED_PARKING_SPOT' | 'DISHES_AND_SILVERWARE' | 'DISHWASHER' | 'DOGS' | 'DOORMAN' | 'DRYER' | 'ELEVATOR_IN_BUILDING' | 'ESSENTIALS' | 'ETHERNET_CONNECTION' | 'EV_CHARGER' | 'EXTRA_PILLOWS_AND_BLANKETS' | 'FIREPLACE_GUARDS' | 'FIRE_EXTINGUISHER' | 'FIRM_MATTRESS' | 'FIRST_AID_KIT' | 'FLAT_SMOOTH_PATHWAY_TO_FRONT_DOOR' | 'FREE_PARKING_ON_PREMISES' | 'GAME_CONSOLE' | 'GARDEN_OR_BACKYARD' | 'GRAB_RAILS_FOR_SHOWER_AND_TOILET' | 'GYM' | 'HAIR_DRYER' | 'HANGERS' | 'HEATING' | 'HIGH_CHAIR' | 'HOT_TUB' | 'HOT_WATER' | 'INDOOR_FIREPLACE' | 'INTERNET' | 'IRON' | 'KITCHEN' | 'LAPTOP_FRIENDLY_WORKSPACE' | 'LONG_TERM_STAYS_ALLOWED' | 'LUGGAGE_DROPOFF_ALLOWED' | 'MICROWAVE' | 'OTHER_PET' | 'OUTLET_COVERS' | 'OVEN' | 'PACK_N_PLAY_TRAVEL_CRIB' | 'PATH_TO_ENTRANCE_LIT_AT_NIGHT' | 'PATIO_OR_BALCONY' | 'PETS_ALLOWED' | 'PETS_LIVE_ON_THIS_PROPERTY' | 'POCKET_WIFI' | 'PRIVATE_ENTRANCE' | 'REFRIGERATOR' | 'ROLL_IN_SHOWER_WITH_SHOWER_BENCH_OR_CHAIR' | 'ROOM_DARKENING_SHADES' | 'SHAMPOO' | 'SINGLE_LEVEL_HOME' | 'SMOKE_DETECTOR' | 'SMOKING_ALLOWED' | 'STAIR_GATES' | 'STEP_FREE_ACCESS' | 'STOVE' | 'SUITABLE_FOR_CHILDREN' | 'SUITABLE_FOR_INFANTS' | 'TABLE_CORNER_GUARDS' | 'TUB_WITH_SHOWER_BENCH' | 'TV' | 'WASHER' | 'WIDE_CLEARANCE_TO_BED' | 'WIDE_CLEARANCE_TO_SHOWER_AND_TOILET' | 'WIDE_DOORWAY' | 'WIDE_HALLWAY_CLEARANCE' | 'WINDOW_GUARDS' | 'WIRELESS_INTERNET' | 'OUTDOOR_POOL' | 'COMMUNAL_POOL' | 'SWIMMING_POOL' | 'PRIVATE_POOL' | 'INDOOR_POOL'
Example:PETS_ALLOWED,SMOKING_ALLOWED,SUITABLE_FOR_INFANTS,SUITABLE_FOR_CHILDREN

Listing amenities separated by coma which should have listings. Possible values are listed in the enum.

excludeAmenities'ACCESSIBLE_HEIGHT_BED' | 'ACCESSIBLE_HEIGHT_TOILET' | 'AIR_CONDITIONING' | 'BABYSITTER_RECOMMENDATIONS' | 'BABY_BATH' | 'BABY_MONITOR' | 'BATHTUB' | 'BBQ_GRILL' | 'BEACH_ESSENTIALS' | 'BED_LINENS' | 'BREAKFAST' | 'CABLE_TV' | 'CARBON_MONOXIDE_DETECTOR' | 'CATS' | 'CHANGING_TABLE' | 'CHILDREN_BOOKS_AND_TOYS' | 'CHILDREN_DINNERWARE' | 'CLEANING_BEFORE_CHECKOUT' | 'COFFEE_MAKER' | 'COOKING_BASICS' | 'CRIB' | 'DISABLED_PARKING_SPOT' | 'DISHES_AND_SILVERWARE' | 'DISHWASHER' | 'DOGS' | 'DOORMAN' | 'DRYER' | 'ELEVATOR_IN_BUILDING' | 'ESSENTIALS' | 'ETHERNET_CONNECTION' | 'EV_CHARGER' | 'EXTRA_PILLOWS_AND_BLANKETS' | 'FIREPLACE_GUARDS' | 'FIRE_EXTINGUISHER' | 'FIRM_MATTRESS' | 'FIRST_AID_KIT' | 'FLAT_SMOOTH_PATHWAY_TO_FRONT_DOOR' | 'FREE_PARKING_ON_PREMISES' | 'GAME_CONSOLE' | 'GARDEN_OR_BACKYARD' | 'GRAB_RAILS_FOR_SHOWER_AND_TOILET' | 'GYM' | 'HAIR_DRYER' | 'HANGERS' | 'HEATING' | 'HIGH_CHAIR' | 'HOT_TUB' | 'HOT_WATER' | 'INDOOR_FIREPLACE' | 'INTERNET' | 'IRON' | 'KITCHEN' | 'LAPTOP_FRIENDLY_WORKSPACE' | 'LONG_TERM_STAYS_ALLOWED' | 'LUGGAGE_DROPOFF_ALLOWED' | 'MICROWAVE' | 'OTHER_PET' | 'OUTLET_COVERS' | 'OVEN' | 'PACK_N_PLAY_TRAVEL_CRIB' | 'PATH_TO_ENTRANCE_LIT_AT_NIGHT' | 'PATIO_OR_BALCONY' | 'PETS_ALLOWED' | 'PETS_LIVE_ON_THIS_PROPERTY' | 'POCKET_WIFI' | 'PRIVATE_ENTRANCE' | 'REFRIGERATOR' | 'ROLL_IN_SHOWER_WITH_SHOWER_BENCH_OR_CHAIR' | 'ROOM_DARKENING_SHADES' | 'SHAMPOO' | 'SINGLE_LEVEL_HOME' | 'SMOKE_DETECTOR' | 'SMOKING_ALLOWED' | 'STAIR_GATES' | 'STEP_FREE_ACCESS' | 'STOVE' | 'SUITABLE_FOR_CHILDREN' | 'SUITABLE_FOR_INFANTS' | 'TABLE_CORNER_GUARDS' | 'TUB_WITH_SHOWER_BENCH' | 'TV' | 'WASHER' | 'WIDE_CLEARANCE_TO_BED' | 'WIDE_CLEARANCE_TO_SHOWER_AND_TOILET' | 'WIDE_DOORWAY' | 'WIDE_HALLWAY_CLEARANCE' | 'WINDOW_GUARDS' | 'WIRELESS_INTERNET' | 'OUTDOOR_POOL' | 'COMMUNAL_POOL' | 'SWIMMING_POOL' | 'PRIVATE_POOL' | 'INDOOR_POOL'
Example:SMOKING_ALLOWED

Listing amenities separated by coma which should not have listings. Possible values are listed in the enum.

minLngnumber
Example:24.052472

Minimum longitude

maxLngnumber
Example:24.05687

Maximum longitude

minLatnumber
Example:49.830034

Minimum latitude

maxLatnumber
Example:49.8366506

Maximum latitude

citystring
Example:Houston

City name from the listings address

countrystring
Example:United States

Country name from the listings address

statestring
Example:Texas

State name from the listings address

neighborhoodstring
Example:Harrisburg

neighborhood from the listings address

fieldsstring
Example:_id address.city title accommodates reviews

The list of the listing fields to return separated by spaces. The fields should be taken from Listing object definition. To include bed arrangements to a response, please add bedArrangements to the fields in query params.

checkInstring
Example:2021-12-20

checkin day in format YYYY-MM-DD

checkOutstring
Example:2021-12-25

checkout day in format YYYY-MM-DD

limitinteger
Example:15

Limit the number of results within a subset. Default value is 20, max value is 100

tagsstring[]

Limit results to listings with specific tag, can be used multiple times for and function

kingBedinteger
Example:2

one of bed types

queenBedinteger
Example:2

one of bed types

doubleBedinteger
Example:2

one of bed types

singleBedinteger
Example:2

one of bed types

sofaBedinteger
Example:2

one of bed types

airMattressinteger
Example:2

one of bed types

bunkBedinteger
Example:2

one of bed types

floorMattressinteger
Example:2

one of bed types

waterBedinteger
Example:2

one of bed types

toddlerBedinteger
Example:2

one of bed types

cribinteger
Example:2

one of bed types

petsAllowedboolean
Example:true

Limit results to listings' unit type house rules

smokingAllowedboolean
Example:true

Limit results to listings' unit type house rules

suitableForEventsboolean
Example:true

Limit results to listings' unit type house rules

suitableForChildrenboolean
Example:true

Limit results to listings' unit type house rules

suitableForInfantsboolean
Example:true

Limit results to listings' unit type house rules

cursorstring
Example:eyJuZXh0Q3Vyc29yIjp7Imxpc3RpbmdJZCI6IjYwOWQ2YWI0MjU5ZWQxMDAyZDFlYWRjYiJ9fQ==

Provide cursor received from the response to iterate over pages

Response

successful operation

Example response

{
  "results": [
    {
      "prices": {
        "basePrice": 1
      },
      "allotment": {
        "2021-12-30": 2,
        "2021-12-31": 2
      },
      "nightlyRates": {
        "2022-03-25": 100,
        "2022-03-26": 200
      },
      "bedArrangements": {
        "bedrooms": [
          {
            "roomNumber": 1,
            "beds": {
              "KING_BED": 1,
              "QUEEN_BED": 1,
              "DOUBLE_BED": 1,
              "SINGLE_BED": 1,
              "SOFA_BED": 1,
              "AIR_MATTRESS": 1,
              "BUNK_BED": 1,
              "FLOOR_MATTRESS": 1,
              "WATER_BED": 1,
              "TODDLER_BED": 1,
              "CRIB": 1
            }
          }
        ],
        "bathrooms": {
          "BEDROOM": 1,
          "PRIVATE": 1
        }
      }
    }
  ]
}
All 19 operations