removedInput schema / properties / accommodation_type
Removed value: -{
- "description": "What the guest rents. Homes whose type is not recorded are left out and counted in accommodation_type_unknown.",
- "enum": [
- "entire_home",
- "private_room",
- "shared_room"
- ],
- "type": "string"
-}
changedInput schema / properties / amenities / description
Previous value: -"Amenities every returned home has, as recorded by the property manager. The same hard filter as amenities_required, except a home with no amenity data is left out without being counted."New value: +"Amenities every returned home has, as recorded by the property manager."
removedInput schema / properties / amenities_preferred
Removed value: -{
- "description": "Amenities that order homes when the requested sort ties, and appear in match_reasons. Homes lacking them stay in the results.",
- "items": {
- "enum": [
- "pool",
- "hot_tub",
- "parking",
- "wifi",
- "kitchen",
- "washer",
- "pets"
- ],
- "type": "string"
- },
- "type": "array"
-}
removedInput schema / properties / amenities_required
Removed value: -{
- "description": "Amenities every returned home has. A home whose amenity data is unavailable fails the filter and is counted in amenities_unknown.",
- "items": {
- "enum": [
- "pool",
- "hot_tub",
- "parking",
- "wifi",
- "kitchen",
- "washer",
- "pets"
- ],
- "type": "string"
- },
- "type": "array"
-}
removedInput schema / properties / bedrooms_exact
Removed value: -{
- "description": "Exactly this many bedrooms; 0 is a studio. Cannot be sent together with bedrooms_min.",
- "maximum": 100,
- "minimum": 0,
- "type": "integer"
-}
removedInput schema / properties / budget
Removed value: -{
- "additionalProperties": false,
- "description": "A spending limit. scope total compares amount with each home's stay total including cleaning, fees and taxes, and needs check_in and check_out. scope nightly compares it with each home's starting nightly rate, which excludes cleaning, fees and taxes. amount, currency and scope are all required.",
- "properties": {
- "amount": {
- "description": "The limit, in the stated currency.",
- "exclusiveMinimum": 0,
- "maximum": 1000000,
- "type": "number"
- },
- "currency": {
- "description": "Only USD is supported.",
- "enum": [
- "USD"
- ],
- "type": "string"
- },
- "scope": {
- "description": "total: the whole stay, with dates. nightly: the starting nightly rate, excluding fees and taxes.",
- "enum": [
- "total",
- "nightly"
- ],
- "type": "string"
- }
- },
- "required": [
- "amount",
- "currency",
- "scope"
- ],
- "type": "object"
-}
removedInput schema / properties / cursor
Removed value: -{
- "description": "The next_cursor value of the previous response, valid only with the same other inputs. Returns the page after it.",
- "type": "string"
-}
changedInput schema / properties / guests / description
Previous value: -"Everyone staying, including children and infants."New value: +"Number of guests, including children."
removedInput schema / properties / page
Removed value: -{
- "description": "Page number, starting at 1, counted in units of page_size. Cannot be sent together with cursor.",
- "minimum": 1,
- "type": "integer"
-}
removedInput schema / properties / page_size
Removed value: -{
- "description": "Results per page, up to 20. Takes the place of limit when both are sent.",
- "maximum": 20,
- "minimum": 1,
- "type": "integer"
-}
changedInput schema / properties / pets / description
Previous value: -"How many pets the guest is bringing, 0 to 4; 0 or leave out for none. true means one pet and false none. Results are limited to pet-friendly homes, dated totals include the pet fee for that many pets, and booking links keep the number of pets."New value: +"The guest is bringing a pet. Results are limited to pet-friendly homes, dated totals include the pet fee, and booking links keep the pet selection."
removedInput schema / properties / pets / maximum
Removed value: -4
removedInput schema / properties / pets / minimum
Removed value: -0
changedInput schema / properties / pets / type
Previous value: -[
- "integer",
- "boolean"
-]New value: +"boolean"
changedInput schema / properties / query / description
Previous value: -"Free text place, e.g. 'Tampa', a neighbourhood, or a landmark such as 'near McCormick Place, Chicago'. A known Chicago landmark or area (McCormick Place, Navy Pier, Wrigley Field, O'Hare Airport, the South Loop and others) returns homes within radius_miles, nearest first, with a straight-line distance. Text that names no city, state, neighbourhood or landmark is refused with INVALID_INPUT; it is not answered as an empty, complete result."New value: +"Free text place, e.g. 'Tampa', 'near Chicago downtown', a neighbourhood or a landmark."
removedInput schema / properties / radius_miles
Removed value: -{
- "description": "How far from a named landmark or area to search, in whole miles, 1 to 25. Homes are included by the distance they state, to the nearest half mile. Defaults to 5 for a landmark and 3 for an area. Ignored for any other place.",
- "maximum": 25,
- "minimum": 1,
- "type": "integer"
-}
changedInput schema / properties / sort / description
Previous value: -"total_price_* needs dates and orders by the stay total; from_price_asc orders by a starting rate that is not returned, and with dates by the stay total; sleeps_desc puts the largest homes first."New value: +"total_price_* needs dates and orders by the stay total; from_price_asc orders by starting nightly rate; sleeps_desc puts the largest homes first."
removedOutput schema / properties / accommodation_type_unknown
Removed value: -{
- "description": "Otherwise matching homes left out of an accommodation_type search because no type is recorded for them. They are not confirmed to be another type. 0 when the filter was not sent.",
- "type": "integer"
-}
removedOutput schema / properties / amenities_unknown
Removed value: -{
- "description": "Otherwise matching homes left out of an amenities_required search because no amenity data is available for them. They are not confirmed to lack the amenity. 0 when the filter was not sent.",
- "type": "integer"
-}
removedOutput schema / properties / budget_applied
Removed value: -{
- "description": "Only returned when a budget was sent: what it was compared with.",
- "properties": {
- "amount": {
- "type": "number"
- },
- "compared_to": {
- "description": "stay_total includes cleaning, fees and taxes; from_price_per_night is a starting nightly rate that excludes them.",
- "enum": [
- "stay_total",
- "from_price_per_night"
- ],
- "type": "string"
- },
- "currency": {
- "type": "string"
- },
- "homes_not_checked": {
- "description": "Matching homes the budget could not be checked against: unpriced for a total budget, no starting rate for a nightly one.",
- "type": "integer"
- },
- "includes_fees_and_taxes": {
- "type": "boolean"
- },
- "note": {
- "type": "string"
- },
- "scope": {
- "enum": [
- "total",
- "nightly"
- ],
- "type": "string"
- }
- },
- "required": [
- "scope",
- "amount",
- "currency",
- "compared_to",
- "includes_fees_and_taxes",
- "note"
- ],
- "type": "object"
-}
removedOutput schema / properties / budget_unverified
Removed value: -{
- "description": "Otherwise matching homes left out of a nightly budget search because no starting nightly rate is on record. 0 when the budget was not sent or was a total budget.",
- "type": "integer"
-}
removedOutput schema / properties / budget_unverified_property_ids
Removed value: -{
- "description": "The property_id of up to 30 of the homes counted in budget_unverified; each can be priced for specific dates with a live quote.",
- "items": {
- "type": "integer"
- },
- "maxItems": 30,
- "type": "array"
-}
removedOutput schema / properties / completeness
Removed value: -{
- "description": "complete: no matching home is unpriced, and none was left out for an unknown pet policy, accommodation type, amenity data, starting rate or position. partial: at least one is, so the results may omit a home that matches.",
- "enum": [
- "complete",
- "partial"
- ],
- "type": "string"
-}
removedOutput schema / properties / distance_unknown
Removed value: -{
- "description": "Only on a landmark or area search: otherwise matching homes left out because no position is recorded for them, so their distance is unknown. They are not confirmed to be outside the radius.",
- "type": "integer"
-}
removedOutput schema / properties / has_more
Removed value: -{
- "description": "True when more results follow this page in the same ordering, within the priced sample. Homes counted in unpriced_in_time are not part of any page and have no effect on this.",
- "type": "boolean"
-}
removedOutput schema / properties / next_cursor
Removed value: -{
- "description": "The value to send as cursor, with every other input unchanged, to get the next page. Null when has_more is false.",
- "type": [
- "string",
- "null"
- ]
-}
removedOutput schema / properties / offset
Removed value: -{
- "description": "How many results precede this page in the full ordering.",
- "type": "integer"
-}
removedOutput schema / properties / page_size
Removed value: -{
- "description": "How many results this page asked for.",
- "type": "integer"
-}
removedOutput schema / properties / properties / items / properties / accommodation_type
Removed value: -{
- "description": "What the guest rents: an entire home, a private room in a shared building or a shared room. A private room or shared room is not an entire home. unknown means the type is not recorded for this home.",
- "enum": [
- "entire_home",
- "private_room",
- "shared_room",
- "unknown"
- ],
- "type": "string"
-}
removedOutput schema / properties / properties / items / properties / availability_status
Removed value: -{
- "description": "available: confirmed available for the requested dates when this answer was produced. not_checked: no dates were given, so availability was not checked.",
- "enum": [
- "available",
- "not_checked"
- ],
- "type": "string"
-}
removedOutput schema / properties / properties / items / properties / bathroom_sharing
Removed value: -{
- "description": "Whether the guest has a private bathroom or shares one. unknown means it is not recorded for this home.",
- "enum": [
- "private",
- "shared",
- "unknown"
- ],
- "type": "string"
-}
removedOutput schema / properties / properties / items / properties / content_updated_at
Removed value: -{
- "description": "When the property manager's record of this home last changed, ISO 8601, as the provider states it. Omitted when the provider gives no such time.",
- "type": "string"
-}
removedOutput schema / properties / properties / items / properties / data_checked_at
Removed value: -{
- "description": "When this home's availability and price were fetched, ISO 8601. Only present on a row whose stay was priced.",
- "type": "string"
-}
removedOutput schema / properties / properties / items / properties / distance_miles
Removed value: -{
- "description": "Only on a landmark or area search: how far this home is from it, in miles, rounded to the nearest 0.5 (0.5 means under 0.5 mile), as a straight line over the ground, not a driving or walking route.",
- "type": "number"
-}
removedOutput schema / properties / properties / items / properties / distance_type
Removed value: -{
- "description": "Only with distance_miles: how the distance was measured. straight_line is the direct distance, shorter than any route.",
- "enum": [
- "straight_line"
- ],
- "type": "string"
-}
changedOutput schema / properties / properties / items / properties / from_price_note / description
Previous value: -"Deprecated, no longer returned along with from_price_per_night."New value: +"Only present when from_price_per_night is null: what is and is not visible about this home's calendar. A null starting rate means neither that the home is booked out nor that it is ready to book."
changedOutput schema / properties / properties / items / properties / from_price_per_night / description
Previous value: -"Deprecated, no longer returned: only a row with a confirmed stay_total carries a price. Kept in this schema so existing clients still validate."New value: +"Starting nightly rate, used to order results. It excludes cleaning, fees and taxes, so it is not the price of any stay. Only present on a row without stay_total. Null means no starting rate is published for this home, not that it is free or cheap; from_price_note says why."
removedOutput schema / properties / properties / items / properties / match_reasons
Removed value: -{
- "description": "Short statements of why this home passed the filters that were sent, e.g. \"2 bedrooms (exact)\" or \"has parking\". On a landmark search the first is the distance, e.g. \"1.5 mi from McCormick Place (straight line)\" or \"under 0.5 mi from McCormick Place (straight line)\". Empty when no filter was sent.",
- "items": {
- "type": "string"
- },
- "type": "array"
-}
removedOutput schema / properties / properties / items / properties / missing_or_unverified
Removed value: -{
- "description": "Facts about this home that could not be verified, drawn from: pet policy, amenities, accommodation type.",
- "items": {
- "type": "string"
- },
- "type": "array"
-}
changedOutput schema / properties / properties / items / required
Previous value: -[
- "property_id",
- "name",
- "city",
- "top_amenities",
- "review_count",
- "review_sources",
- "highlights",
- "booking_url",
- "match_reasons",
- "availability_status",
- "missing_or_unverified"
-]New value: +[
+ "property_id",
+ "name",
+ "city",
+ "top_amenities",
+ "review_count",
+ "review_sources",
+ "highlights",
+ "booking_url"
+]
removedOutput schema / properties / search_scope
Removed value: -{
- "description": "The place actually searched and how it was read.",
- "properties": {
- "place": {
- "description": "The place searched; null when no place was given and every home was searched.",
- "type": [
- "string",
- "null"
- ]
- },
- "radius_miles": {
- "description": "How far from its centre or point homes are included; given for a metro, landmark or area.",
- "type": "number"
- },
- "type": {
- "description": "metro: the metro area around the named city, within radius_miles. state: the whole state. city: homes in the named city. nearby_or_text: homes near the place or whose listing text matches it. landmark: homes within radius_miles of a named landmark, nearest first, by straight-line distance. area: the same, measured from the centre of a named area such as the South Loop.",
- "enum": [
- "all_homes",
- "metro",
- "state",
- "city",
- "nearby_or_text",
- "landmark",
- "area"
- ],
- "type": "string"
- }
- },
- "required": [
- "place",
- "type"
- ],
- "type": "object"
-}
removedOutput schema / properties / status
Removed value: -{
- "description": "NO_MATCHES: nothing matched and nothing is unknown (unpriced_in_time and pet_policy_unknown are both 0). It is a normal answer, not an error. Any other search is OK, even with no results, and unpriced_in_time and pet_policy_unknown say what is still unknown.",
- "enum": [
- "OK",
- "NO_MATCHES"
- ],
- "type": "string"
-}
changedOutput schema / properties / unpriced_in_time / description
Previous value: -"Matching homes whose availability was not established for these dates, because their pet policy could not be verified, a quote failed, the request ran out of budget, or it did not reach them. They are unknown, not unavailable. `price_all_matches`, a higher `limit`, or a narrower place establishes more of them. These counts cover the whole search, not one page, and the homes they count are not part of any page. A later page quotes more homes, so the count can fall."New value: +"Matching homes whose availability was not established for these dates, because their pet policy could not be verified, a quote failed, the request ran out of budget, or it did not reach them. They are unknown, not unavailable. `price_all_matches`, a higher `limit`, or a narrower place establishes more of them."
removedOutput schema / properties / unpriced_property_ids
Removed value: -{
- "description": "The property_id of up to 30 of the homes counted in unpriced_in_time; each can be priced individually with a live quote. Homes whose quote failed or timed out come first, then homes the request did not reach. A home listed here is unknown, not unavailable.",
- "items": {
- "type": "integer"
- },
- "maxItems": 30,
- "type": "array"
-}
changedOutput schema / required
Previous value: -[
- "matches",
- "total_matching",
- "total_matching_groups",
- "unpriced_in_time",
- "unpriced_property_ids",
- "dates_checked",
- "availability_note",
- "properties",
- "completeness",
- "search_scope",
- "has_more",
- "next_cursor"
-]New value: +[
+ "matches",
+ "total_matching",
+ "total_matching_groups",
+ "unpriced_in_time",
+ "dates_checked",
+ "availability_note",
+ "properties"
+]