These docs are for v2.0. Click to read the latest docs for v3.1.

/propertiesql

GraphQL endpoint for properties

GraphQL schema:

schema {
    query: propertyQuery
}

type PropertyBedTypesTO {
    airMattress: Int
    bunkBed: Int
    crib: Int
    doubleBed: Int
    floorMattress: Int
    futonBed: Int
    hammockBed: Int
    kingBed: Int
    queenBed: Int
    singleBed: Int
    sofaBed: Int
    toddlerBed: Int
    waterBed: Int
}

type PropertyExternalCalendarTO {
    name: String
    source: String
    url: String
}

type PropertyGraphQLTO {
    UID: String
    acceptBookingRequest: Boolean
    acceptInstantBook: Boolean
    address1: String
    address2: String
    airBnBID: String
    areaSize: Int
    areaSizeUnit: AreaSizeUnitType
    availabilityCalendarUrl: String
    baseDailyRate: Float
    baseGuests: Int
    bathrooms: String
    bedCount: Int
    bedTypes: PropertyBedTypesTO
    bedrooms: Int
    bookingLeadTime: Int
    bookingWindow: Int
    bookingWindowAfterCheckout: Int
    cancellationPolicy: String
    city: String
    cleaningFeeAmount: Float
    countryCode: CountryCode
    createdDate: String
    currency: Currency
    currencySymbol: String
    defaultCheckinTime: Int
    defaultCheckoutTime: Int
    externalCalendars: [PropertyExternalCalendarTO]
    externalID: String
    extraGuestFee: Float
    flipkeyID: String
    floor: Int
    fullPaymentTiming: Int
    guideBookUrl: String
    homeAwayID: String
    isActive: Boolean
    latitude: Float
    longitude: Float
    maximumGuests: Int
    maximumStay: Int
    minimumStay: Int
    minimumWeekendStay: Int
    name: String
    panoramicDataUrl: String
    percentUponReservation: Int
    photos: [PropertyPhotoTO]
    picture: String
    postalCode: String
    pricingRules: PropertyPricingRulesTO
    propertyURL: String
    rentalCondition: String
    rentalConditions: [PropertyRentalConditionTO]
    rentalLicenseNumber: String
    rentalLicenseNumberExpirationDate: String
    reviews: PropertyReviewTO
    securityDepositAmount: Float
    state: String
    taxationRate: Float
    turnOverDays: Int
    type: Type
    webLink: String
    weekEndRatePercentAdjustment: Float
    wifiNetwork: String
    wifiPassword: String
}

type PropertyPhotoTO {
    description: String
    displayOrder: Int
    uid: String
    url: String
}

type PropertyPricingRulesTO {
    decreaseRate: Int
    decreaseRateHigherBound: Int
    increaseRate: Int
    increaseRateLowerBound: Int
}

type PropertyRentalConditionTO {
    description: String
}

type PropertyReviewTO {
    average: Float
    total: Long
}

type propertyQuery {
    properties(agencyUid: String): [PropertyGraphQLTO]
    property(uid: String): PropertyGraphQLTO
}

enum AreaSizeUnitType {
    "SQUARE_FEET"
    SQUARE_FEET
    "SQUARE_METERS"
    SQUARE_METERS
}

enum CountryCode {
    "AD"
    AD
    "AE"
    AE
    "AF"
    AF
    "AG"
    AG
    "AI"
    AI
    "AL"
    AL
    "AM"
    AM
    "AO"
    AO
    "AR"
    AR
    "AS"
    AS
    "AT"
    AT
    "AU"
    AU
    "AW"
    AW
    "AZ"
    AZ
    "BA"
    BA
    "BB"
    BB
    "BD"
    BD
    "BE"
    BE
    "BF"
    BF
    "BG"
    BG
    "BH"
    BH
    "BI"
    BI
    "BJ"
    BJ
    "BM"
    BM
    "BN"
    BN
    "BO"
    BO
    "BR"
    BR
    "BS"
    BS
    "BT"
    BT
    "BW"
    BW
    "BY"
    BY
    "BZ"
    BZ
    "CA"
    CA
    "CC"
    CC
    "CF"
    CF
    "CG"
    CG
    "CH"
    CH
    "CI"
    CI
    "CK"
    CK
    "CL"
    CL
    "CM"
    CM
    "CN"
    CN
    "CO"
    CO
    "CR"
    CR
    "CU"
    CU
    "CV"
    CV
    "CW"
    CW
    "CX"
    CX
    "CY"
    CY
    "CZ"
    CZ
    "DE"
    DE
    "DJ"
    DJ
    "DK"
    DK
    "DM"
    DM
    "DO"
    DO
    "DZ"
    DZ
    "EC"
    EC
    "EE"
    EE
    "EG"
    EG
    "EH"
    EH
    "ER"
    ER
    "ES"
    ES
    "ET"
    ET
    "FI"
    FI
    "FJ"
    FJ
    "FM"
    FM
    "FR"
    FR
    "GA"
    GA
    "GB"
    GB
    "GD"
    GD
    "GE"
    GE
    "GF"
    GF
    "GH"
    GH
    "GI"
    GI
    "GL"
    GL
    "GM"
    GM
    "GN"
    GN
    "GQ"
    GQ
    "GR"
    GR
    "GT"
    GT
    "GU"
    GU
    "GW"
    GW
    "GY"
    GY
    "HK"
    HK
    "HN"
    HN
    "HR"
    HR
    "HT"
    HT
    "HU"
    HU
    "ID"
    ID
    "IE"
    IE
    "IL"
    IL
    "IM"
    IM
    "IN"
    IN
    "IQ"
    IQ
    "IR"
    IR
    "IS"
    IS
    "IT"
    IT
    "JE"
    JE
    "JM"
    JM
    "JO"
    JO
    "JP"
    JP
    "KE"
    KE
    "KG"
    KG
    "KH"
    KH
    "KI"
    KI
    "KM"
    KM
    "KN"
    KN
    "KP"
    KP
    "KR"
    KR
    "KW"
    KW
    "KY"
    KY
    "KZ"
    KZ
    "LA"
    LA
    "LB"
    LB
    "LI"
    LI
    "LK"
    LK
    "LR"
    LR
    "LS"
    LS
    "LT"
    LT
    "LU"
    LU
    "LV"
    LV
    "LY"
    LY
    "MA"
    MA
    "MC"
    MC
    "MD"
    MD
    "ME"
    ME
    "MG"
    MG
    "MH"
    MH
    "MK"
    MK
    "ML"
    ML
    "MM"
    MM
    "MN"
    MN
    "MO"
    MO
    "MQ"
    MQ
    "MR"
    MR
    "MS"
    MS
    "MT"
    MT
    "MU"
    MU
    "MV"
    MV
    "MW"
    MW
    "MX"
    MX
    "MY"
    MY
    "MZ"
    MZ
    "NA"
    NA
    "NC"
    NC
    "NE"
    NE
    "NF"
    NF
    "NG"
    NG
    "NI"
    NI
    "NL"
    NL
    "NO"
    NO
    "NP"
    NP
    "NR"
    NR
    "NU"
    NU
    "NZ"
    NZ
    "OM"
    OM
    "PA"
    PA
    "PE"
    PE
    "PG"
    PG
    "PH"
    PH
    "PK"
    PK
    "PL"
    PL
    "PM"
    PM
    "PR"
    PR
    "PS"
    PS
    "PT"
    PT
    "PW"
    PW
    "PY"
    PY
    "QA"
    QA
    "RE"
    RE
    "RO"
    RO
    "RS"
    RS
    "RU"
    RU
    "RW"
    RW
    "SA"
    SA
    "SB"
    SB
    "SC"
    SC
    "SE"
    SE
    "SG"
    SG
    "SI"
    SI
    "SJ"
    SJ
    "SK"
    SK
    "SL"
    SL
    "SM"
    SM
    "SN"
    SN
    "SO"
    SO
    "SR"
    SR
    "SV"
    SV
    "SZ"
    SZ
    "TD"
    TD
    "TG"
    TG
    "TH"
    TH
    "TJ"
    TJ
    "TM"
    TM
    "TN"
    TN
    "TO"
    TO
    "TR"
    TR
    "TT"
    TT
    "TW"
    TW
    "TZ"
    TZ
    "UA"
    UA
    "UG"
    UG
    "US"
    US
    "UY"
    UY
    "UZ"
    UZ
    "VA"
    VA
    "VE"
    VE
    "VG"
    VG
    "VI"
    VI
    "VN"
    VN
    "VU"
    VU
    "WF"
    WF
    "WS"
    WS
    "YE"
    YE
    "YT"
    YT
    "YU"
    YU
    "ZA"
    ZA
    "ZM"
    ZM
    "ZW"
    ZW
}

enum Currency {
    "AED"
    AED
    "ARS"
    ARS
    "AUD"
    AUD
    "BGN"
    BGN
    "BRL"
    BRL
    "CAD"
    CAD
    "CHF"
    CHF
    "CLP"
    CLP
    "CNY"
    CNY
    "COP"
    COP
    "CZK"
    CZK
    "DKK"
    DKK
    "EUR"
    EUR
    "GBP"
    GBP
    "HKD"
    HKD
    "IDR"
    IDR
    "ILS"
    ILS
    "INR"
    INR
    "JPY"
    JPY
    "KRW"
    KRW
    "LEU"
    LEU
    "MXN"
    MXN
    "MYR"
    MYR
    "NOK"
    NOK
    "NZD"
    NZD
    "PEN"
    PEN
    "PHP"
    PHP
    "RUB"
    RUB
    "SEK"
    SEK
    "SGD"
    SGD
    "THB"
    THB
    "TWD"
    TWD
    "USD"
    USD
    "UYU"
    UYU
    "VEF"
    VEF
    "VND"
    VND
    "ZAR"
    ZAR
}

enum Type {
    "APARTHOTEL"
    APARTHOTEL
    "APARTMENT"
    APARTMENT
    "BEDANDBREAKFAST"
    BEDANDBREAKFAST
    "BOAT"
    BOAT
    "BOUTIQUE_HOTEL"
    BOUTIQUE_HOTEL
    "BUNGALOW"
    BUNGALOW
    "CABIN"
    CABIN
    "CAMPGROUND"
    CAMPGROUND
    "CAVE"
    CAVE
    "CHALET"
    CHALET
    "CHATEAU"
    CHATEAU
    "CONDO"
    CONDO
    "COTTAGE"
    COTTAGE
    "COUNTRYHOUSE"
    COUNTRYHOUSE
    "DOME_HOUSE"
    DOME_HOUSE
    "DORM"
    DORM
    "DUPLEX"
    DUPLEX
    "EARTHHOUSE"
    EARTHHOUSE
    "FARMHOUSE"
    FARMHOUSE
    "FOURPLEX"
    FOURPLEX
    "GUESTHOUSE"
    GUESTHOUSE
    "HOMESTAY"
    HOMESTAY
    "HOSTEL"
    HOSTEL
    "HOTEL"
    HOTEL
    "HOUSE"
    HOUSE
    "HOUSEBOAT"
    HOUSEBOAT
    "HUT"
    HUT
    "IGLOO"
    IGLOO
    "ISLAND"
    ISLAND
    "LIGHTHOUSE"
    LIGHTHOUSE
    "LODGE"
    LODGE
    "LOFT"
    LOFT
    "MOTELROOM"
    MOTELROOM
    "OTHER"
    OTHER
    "PENTHOUSE"
    PENTHOUSE
    "PLANE"
    PLANE
    "RESORT"
    RESORT
    "ROOM"
    ROOM
    "RV"
    RV
    "SAMPLE"
    SAMPLE
    "SERVICED_APARTMENT"
    SERVICED_APARTMENT
    "STUDIO"
    STUDIO
    "TENT"
    TENT
    "TINY_HOUSE"
    TINY_HOUSE
    "TIPI"
    TIPI
    "TOWNHOUSE"
    TOWNHOUSE
    "TRAIN"
    TRAIN
    "TREEHOUSE"
    TREEHOUSE
    "TRIPLEX"
    TRIPLEX
    "VILLA"
    VILLA
    "YURT"
    YURT
}


"Long type"
scalar Long
Language
Credentials
Header
Click Try It! to start a request and see the response here!