{ "network":{ "type":"object", "id":"network", "required":true, "description":"Information about the network calling the API", "properties":{ "network_id":{ "type":"integer", "id":"network_id", "required":true, "description":"Unique Rightmove reference for this network" } }, "additionalProperties":false }, "branch":{ "type":"object", "id":"branch", "required":true, "description":"Information about the branch loading this property", "properties":{ "branch_id":{ "type":"integer", "id":"branch_id", "required":true, "description":"Unique Rightmove reference for this branch" } }, "additionalProperties":false }, "property":{ "type":"object", "id":"property", "required":true, "description":"Information about the property being sent", "properties":{ "agent_ref":{ "type":"string", "id":"agent_ref", "required":true, "minLength": 1, "maxLength": 80, "description":"Agent's unique reference for this property" }, "published":{ "type":"boolean", "id":"published", "required":true, "description":"Defines whether this property should be visible on Rightmove" }, "property_type":{ "type":"integer", "id":"property_type", "required":true, "enum":[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 56, 59, 62, 65, 68, 71, 74, 77, 80, 83, 86, 92, 95, 101, 104, 107, 110, 113, 116, 117, 118, 119, 120, 121, 125, 128, 131, 134, 137, 140, 141, 142, 143, 144, 178, 181, 184, 187, 190, 193, 196, 199, 202, 205, 208, 211, 214, 217, 220, 223, 226, 229, 232, 235, 238, 241, 244, 247, 250, 253, 256, 259, 262, 265, 268, 271, 274, 277, 280, 283, 298, 301, 304, 307, 310, 511, 512, 535, 538, 541], "description":"The type of the property being sent in this message: 0 Not Specified, 1 Terraced House, 2 End of terrace house, 3 Semi-detached house, 4 Detached house, 5 Mews house, 6 Cluster house, 7 Ground floor flat, 8 Flat, 9 Studio flat, 10 Ground floor maisonette, 11 Maisonette, 12 Bungalow, 13 Terraced bungalow, 14 Semi-detached bungalow, 15 Detached bungalow, 16 Mobile home, 20 Land, 21 Link detached house, 22 Town house, 23 Cottage, 24 Chalet, 25 Character Property, 26 House (unspecified), 27 Villa, 28 Apartment, 29 Penthouse, 30 Finca, 43 Barn Conversion, 44 Serviced apartment, 45 Parking, 46 Sheltered Housing, 47 Reteirment property, 48 House share, 49 Flat share, 50 Park home, 51 Garages, 52 Farm House, 53 Equestrian facility, 56 Duplex, 59 Triplex, 62 Longere, 65 Gite, 68 Barn, 71 Trulli, 74 Mill, 77 Ruins, 80 Restaurant, 83 Cafe, 86 Mill, 92 Castle, 95 Village House, 101 Cave House, 104 Cortijo, 107 Farm Land, 110 Plot, 113 Country House, 116 Stone House, 117 Caravan, 118 Lodge, 119 Log Cabin, 120 Manor House, 121 Stately Home, 125 Off-Plan, 128 Semi-detached Villa, 131 Detached Villa, 134 Bar/Nightclub, 137 Shop, 140 Riad, 141 House Boat, 142 Hotel Room, 143 Block of Apartments, 144 Private Halls, 178 Office, 181 Business Park, 184 Serviced Office, 187 Retail Property (High Street), 190 Retail Property (Out of Town), 193 Convenience Store, 196 Garages, 199 Hairdresser/Barber Shop, 202 Hotel, 205 Petrol Station, 208 Post Office, 211 Pub, 214 Workshop & Retail Space, 217 Distribution Warehouse, 220 Factory, 223 Heavy Industrial, 226 Industrial Park, 229 Light Industrial, 232 Storage, 235 Showroom, 238 Warehouse, 241 Land, 244 Commercial Development, 247 Industrial Development, 250 Residential Development, 253 Commercial Property, 256 Data Centre, 259 Farm, 262 Healthcare Facility, 265 Marine Property, 268 Mixed Use, 271 Research & Development Facility, 274 Science Park, 277 Guest House, 280 Hospitality, 283 Leisure Facility, 298 Takeaway, 301 Childcare Facility, 304 Smallholding, 307 Place of Worship, 310 Trade Counter, 511 Coach House, 512 House of Multiple Occupation, 535 Sports facilities, 538 Spa, 541 Campsite & Holiday Village" }, "os_status":{ "type":"integer", "id":"os_status", "required":true, "enum":[1, 2, 4, 5], "description":"The current transaction status for this property: 1 Available, 2 SSTC, 4 Under Offer, 5 Reserved" }, "new_home":{ "type":["boolean", "null"], "id":"new_home", "required":false, "description":"Defines whether this property is a new build" }, "create_date":{ "type":["string", "null"], "id":"create_date", "required":false, "description":"Date this property was created in the format: dd-MM-yyyy HH:mm:ss" }, "update_date":{ "type":["string", "null"], "id":"update_date", "required":false, "description":"Date this property was last updated in the feed provider's software, in the format: dd-MM-yyyy HH:mm:ss" }, "address":{ "type":"object", "id":"address", "required":true, "description":"Information about the address of the property being sent", "properties":{ "country_code":{ "type":"string", "id":"country_code", "required":true, "maxLength":2, "description":"The ISO-3316 two letter code for the country the property is located in: AD Andorra, AE United Arab Emirates, AF Afghanistan, AG Antigua And Barbuda, AI Anguilla, AL Albania, AM Armenia, AN Netherlands Antilles, AO Angola, AR Argentina, AS American Samoa, AT Austria, AU Australia, AW Aruba, AZ Azerbaijan, BA Bosnia-Herzegovina, BB Barbados, BD Bangladesh, BE Belgium, BF Burkina, BG Bulgaria, BH Bahrain, BI Burundi, BJ Benin, BM Bermuda, BN Brunei, BO Bolivia, BR Brazil, BS The Bahamas, BT Bhutan, BV Bouvetoya, BW Botswana, BY Belarus, BZ Belize, CA Canada, CB Canouan Island, CC Cocos Islands, CD Democratic Republic of the Congo, CF Central African Republic, CG Congo, CH Switzerland, CI Cote d'Ivoire, CK Cook Islands, CL Chile, CM Cameroon, CN China, CO Colombia, CR Costa Rica, CS Serbia and Montenegro, CU Cuba, CV Cape Verde, CX Christmas Island, CY Cyprus, CZ Czech Republic, DE Germany, DJ Djibouti, DK Denmark, DM Dominica, DO Dominican Republic, DU Dubai, DZ Algeria, EC Ecuador, EE Estonia, EG Egypt, ER Eritrea, ES Spain, ET Ethiopia, FI Finland, FJ Fiji, FK Falkland Islands, FM Federated States of Micronesia, FO Faroe Islands, FR France, GA Gabon, GD Grenada, GE Georgia, GF French Guiana, GH Ghana, GI Gibraltar, GL Greenland, GM The Gambia, GN Guinea, GO Goa, GP Guadeloupe, GQ Equatorial Guinea, GR Greece, GS South Georgia and South Sandwich Islands, GT Guatemala, GU Guam, GW Guinea-Bissau, GY Guyana, HM Heard and McDonald Islands, HN Honduras, HR Croatia, HT Haiti, HU Hungary, ID Indonesia, IE Ireland, IL Israel, IM Margarita Island, IN India, IO British Indian Ocean Territory, IQ Iraq, IR Iran, IS Iceland, IT Italy, JM Jamaica, JO Jordan, JP Japan, KE Kenya, KG Kyrgyzstan, KH Cambodia, KI Kiribati, KM Comoros, KN St Kitts and Nevis, KP North Korea, KR South Korea, KW Kuwait, KY Cayman Islands, KZ Kazakhstan, LA Laos, LB Lebanon, LC St Lucia, LI Liechtenstein, LK Sri Lanka, LR Liberia, LS Lesotho, LT Lithuania, LU Luxembourg, LV Latvia, LY Libya, MA Morocco, MC Monaco, MD Moldova, ME Montenegro, MG Madagascar, MH Marshall Islands, MK Macedonia, ML Mali, MM Myanmar, MN Mongolia, MP Northern Mariana Islands, MQ Martinique, MR Mauritania, MS Montserrat, MT Malta, MU Mauritius, MV Maldives, MW Malawi, MX Mexico, MY Malaysia, MZ Mozambique, NA Namibia, NC New Caledonia, NE Niger, NF Norfolk Island, NG Nigeria, NI Nicaragua, NL Netherlands, NO Norway, NP Nepal, NR Nauru, NU Niue, NY Northern Cyprus, NZ New Zealand, OM Oman, PA Panama, PE Peru, PF French Polynesia, PG Papua New Guinea, PH Philippines, PK Pakistan, PL Poland, PM St Pierre and Miquelon, PN Pitcairn Islands, PR Puerto Rico, PT Portugal, PW Palau, PY Paraguay, QA Qatar, RE Reunion, RO Romania, RU Russian Federation, RW Rwanda, SA Saudi Arabia, SB Solomon Islands, SC Seychelles, SD Sudan, SE Sweden, SG Singapore, SH St Helena, SI Slovenia, SJ Svalbard, SK Slovakia, SL Sierra Leone, SM San Marino, SN Senegal, SO Somalia, SP Serbia, SR Suriname, ST Sao Tome and Principe, SV El Salvador, SY Syria, SZ Swaziland, TC Turks And Caicos Islands, TD Chad, TF French Southern and Antarctic Lands, TG Togo, TH Thailand, TJ Tajikistan, TK Tokelau, TL East Timor, TM Turkmenistan, TN Tunisia, TO Tonga, TR Turkey, TT Trinidad And Tobago, TV Tuvalu, TW Taiwan, TZ Tanzania, UA Ukraine, UG Uganda, US United States of America, UY Uruguay, UZ Uzbekistan, VC St Vincent and the Grenadines, VE Venezuela, VG British Virgin Islands, VI Virgin Islands (U.S.A.), VN Vietnam, VU Vanuatu, WF Wallis and Futuna Islands, WS Samoa, XB St Barthelemy, XM St Maarten, YE Yemen, YT Mayotte, ZA South Africa, ZM Zambia, ZW Zimbabwe" }, "region":{ "type":["string","null"], "id":"region", "required":false, "maxLength":100, "description":"The region that the property being sent is located in" }, "sub_region":{ "type":["string","null"], "id":"sub_region", "required":false, "maxLength":100, "description":"The sub region that the property being sent is located in" }, "town_city":{ "type":["string","null"], "id":"town_city", "required":false, "maxLength":100, "description":"The town or city that the property being sent is located in" }, "latitude":{ "type":["number", "null"], "id":"latitude", "required":false, "minimum":-90.0, "maximum":90.0, "description":"The exact latitude of the property" }, "longitude":{ "type":["number", "null"], "id":"longitude", "required":false, "minimum":-180.0, "maximum":180.0, "description":"The exact longitude of the property" } }, "additionalProperties":false }, "price_information":{ "type":"object", "id":"price", "required":true, "description":"Information about the price of the property being sent", "properties":{ "price":{ "type":"number", "id":"price", "minimum":1, "required":true, "description":"The price of the property being sent" }, "os_price_qualifier":{ "type":["integer", "null"], "id":"os_price_qualifier", "required":false, "enum":[0, 2, 4, 5, 16, null], "description":"The qualifier on the advertised price of the property being sent: 0 Default, 2 Guide Price, 4 Offers in Excess of, 5 Offers in the Region of, 16 Coming Soon" } }, "additionalProperties":false }, "details":{ "type":"object", "id":"details", "required":true, "description":"The details about the property being sent", "properties":{ "summary":{ "type":"string", "id":"summary", "required":true, "minLength":1, "maxLength": 1000, "description":"The summary description of the property being sent" }, "description":{ "type":"string", "id":"description", "required":true, "minLength":1, "maxLength": 32000, "description":"The full description of the property being sent" }, "features": { "type":["array", "null"], "id": "features", "required": false, "uniqueItems":true, "maxItems": 10, "description": "Features of the property being sent", "items": { "type": ["string"], "minLength": 1, "maxLength": 200 } }, "bedrooms":{ "type":"integer", "id":"bedrooms", "required":true, "minimum":0, "description":"The number of bedrooms for the property being sent" }, "bathrooms":{ "type":["integer", "null"], "id":"bathrooms", "required":false, "minimum":0, "description":"The number of bathrooms for the property being sent" }, "reception_rooms":{ "type":["integer", "null"], "id":"reception_rooms", "required":false, "minimum":0, "description":"The number of reception rooms for the property being sent" }, "parking":{ "type":["array", "null"], "items":{ "enum":[13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, null] }, "uniqueItems":true, "id":"parking", "required":false, "description":"Parking options available for the property being sent: 13 Allocated, 14 Communal, 15 Covered, 16 Garage, 17 Driveway, 18 Gated, 19 Off Street, 20 On Street, 21 Rear, 22 Permit, 23 Private, 24 Residents" }, "outside_space":{ "type":["array", "null"], "items":{ "enum":[29, 30, 31, 32, 33, 34, 35, 36, null] }, "uniqueItems":true, "id":"outside_space", "required":false, "description":"Outside spaces associated with the property being sent: 29 Back Garden, 30 Communal Garden, 31 Enclosed Garden, 32 Front Garden, 33 Private Garden, 34 Rear Garden, 35 Terrace, 36 Patio" }, "year_built":{ "type":["integer", "null"], "id":"year_built", "required":false, "minimum":0, "description":"The year in which the property being sent was built" }, "internal_area":{ "type":["number", "null"], "id":"internal_area", "required":false, "minimum":0, "description":"Total internal area of the property being sent" }, "internal_area_unit":{ "type":["integer", "null"], "id":"internal_area_unit", "required":false, "enum":[1, 2, 3, 4, null], "description":"Units which the internal area is sent in: 1 sq ft 2 sq m 3 acre 4 hectares" }, "land_area":{ "type":["number", "null"], "id":"land_area", "required":false, "minimum":0, "description":"Total land area of the property being sent" }, "land_area_unit":{ "type":["integer", "null"], "id":"land_area_unit", "required":false, "enum":[1, 2, 3, 4, null], "description":"Units which the land area is sent in: 1 sq ft 2 sq m 3 acre 4 hectares" }, "floors":{ "type":["integer", "null"], "id":"floors", "required":false, "minimum":0, "description":"Number of floors in the property being sent" }, "entrance_floor":{ "type":["integer", "null"], "id":"entrance_floor", "required":false, "enum":[1, 2, 3, 4, 5, 6, null], "description":"Floor which the entrance to the property being sent is on: 1 Basement, 2 Ground Floor, 3 1st Floor, 4 2nd Floor, 5 Higher than 2nd floor (no lift), 6 Higher than 2nd floor (with lift)" }, "condition":{ "type":["integer", "null"], "id":"condition", "required":false, "enum":[1, 2, 3, 4, null], "description":"Condition of the property being sent: 1 Good, 2 Some work needed, 3 Work required throughout, 4 Major renovation required" }, "accessibility":{ "type":["array", "null"], "items":{ "enum":[42, 37, 38, 39, 40, 41, null] }, "uniqueItems":true, "id":"accessibility", "required":false, "description":"Accessibility measures in place in the property being sent: 42 Not suitable for wheelchair users, 37 Level access, 38 Lift access, 39 Ramped access, 40 Wet room, 41 Wide doorways" }, "heating":{ "type":["array", "null"], "items":{ "enum":[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, null] }, "uniqueItems":true, "id":"heating", "required":false, "description":"Heating related features of the property being sent: 1 Air Conditioning, 2 Central, 3 Double Glazing, 4 Eco-Friendly, 5 Electric, 6 Gas, 7 Gas Central, 8 Night Storage, 9 Oil, 10 Solar, 11 Solar Water, 12 Under Floor" }, "golf_course_on_site_or_within_10_minutes_walk":{ "type":["boolean", "null"], "id":"golf_course_on_site_or_within_10_minutes_walk", "required":false, "description":"Is there a golf course within a ten minute walk of the property being sent" }, "golf_course_within_a_20_minute_drive":{ "type":["boolean", "null"], "id":"golf_course_within_a_20_minute_drive", "required":false, "description":"Is there a golf course within a twenty minute drive of the property being sent" }, "private_pool":{ "type":["boolean", "null"], "id":"private_pool", "required":false, "description":"Is there a private pool at the property being sent" }, "communal_pool":{ "type":["boolean", "null"], "id":"communal_pool", "required":false, "description":"Is there access to a communal pool at the property being sent" }, "at_beach_or_within_10_minute_walk":{ "type":["boolean", "null"], "id":"at_beach_or_within_10_minute_walk", "required":false, "description":"Is there a beach located at or within a ten minute walk of the property being sent" }, "beach_within_a_20_minute_drive":{ "type":["boolean", "null"], "id":"beach_within_a_20_minute_drive", "required":false, "description":"Is there a beach within a twenty minute drive of the property being sent" }, "private_beach":{ "type":["boolean", "null"], "id":"private_beach", "required":false, "description":"Is there a private beach at the property being sent" }, "sea_view":{ "type":["boolean", "null"], "id":"sea_view", "required":false, "description":"Is there a sea view at the property being sent" }, "at_ski_field_or_within_10_minutes_walk":{ "type":["boolean", "null"], "id":"at_ski_field_or_within_10_minutes_walk", "required":false, "description":"Is there a ski field at or within a ten minute walk of the property being sent" }, "ski_field_within_a_45_minute_drive":{ "type":["boolean", "null"], "id":"ski_field_within_a_45_minute_drive", "required":false, "description":"Is there a ski field within a 45 minute drive of the property being sent" }, "air_conditioning":{ "type":["boolean", "null"], "id":"air_conditioning", "required":false, "description":"Is there air conditioning at the property being sent" }, "security_system":{ "type":["boolean", "null"], "id":"security_system", "required":false, "description":"Is there a security system at the property being sent" }, "gated_entry":{ "type":["boolean", "null"], "id":"gated_entry", "required":false, "description":"Is there gated entry at the property being sent" }, "balcony":{ "type":["boolean", "null"], "id":"balcony", "required":false, "description":"Is there a balcony at the property being sent" }, "ground_floor_terrace":{ "type":["boolean", "null"], "id":"ground_floor_terrace", "required":false, "description":"Is there a ground floor terrace at the property being sent" }, "roof_terrace":{ "type":["boolean", "null"], "id":"roof_terrace", "required":false, "description":"Is there a roof terrace at the property being sent" }, "hot_tub":{ "type":["boolean", "null"], "id":"hot_tub", "required":false, "description":"Is there a hot tub at the property being sent" }, "log_fireplace":{ "type":["boolean", "null"], "id":"log_fireplace", "required":false, "description":"Is there a log fireplace at the property being sent" }, "business_for_sale":{ "type":["boolean", "null"], "id":"business_for_sale", "required":false, "description":"Is there a business for sale with the commercial property being sent" }, "comm_use_class":{ "type":["array", "null"], "items":{ "enum":[1, 4, 7, 10, 13, 16, 19, 22, 25, 28, 31, 34, 37, 40, 43, 46, null] }, "uniqueItems":true, "maxItems":6, "id":"comm_use_class", "required":false, "description":"The commercial use class(es) of the property being sent: 1 A1 Shops, 4 A2 Financial and Professional Services, 7 A3 Restaurants and Cafes, 10 A4 Drinking Establishments, 13 A5 Hot Food Take away, 16 B1 Business, 19 B2 General Industrial, 22 B8 Storage and Distribution, 25 C1 Hotels, 28 C2 Residential Institutions, 31 C2A Secure Residential Institution, 34 C3 Dwelling Houses, 37 D1 Non-Residential Institutions, 40 D2 Assembly and Leisure, 43 Sui_generis_1, 46 Sui_generis_2" }, "rooms": { "type":["array", "null"], "id": "rooms", "required": false, "uniqueItems":true, "maxItems": 99, "description": "Room data for the property being sent", "items": { "type": ["object", "null"], "properties": { "room_name": { "type": "string", "id": "room_name", "description": "The name of the room", "required": true, "minLength": 1, "maxLength": 120 }, "room_description": { "type": ["string", "null"], "id": "room_description", "required": false, "description": "The specific description of that room", "maxLength": 1000 }, "room_length":{ "type":["number", "null"], "id": "room_length", "required": false, "minimum":0, "description": "The length of the room" }, "room_width":{ "type":["number", "null"], "id": "room_width", "required": false, "minimum":0, "description": "The width of the room" }, "room_dimension_unit":{ "type":["integer", "null"], "id": "room_dimension_unit", "required": false, "enum": [5, 6, 7, 8, 9, null], "description":"The units which the length and width of the room have been provided in: 5 Metres, 6 Centimetres, 7 Millimetres, 8 Feet, 9 Inches" }, "room_dimension_text": { "type": ["string", "null"], "id": "room_dimension_text", "description": "Any additional description or clarification of the room dimensions", "required": false, "minLength": 1, "maxLength": 120 }, "room_photo_urls": { "type":["array", "null"], "id": "room_photo_urls", "required": false, "uniqueItems":true, "maxItems": 10, "description": "The URLs of images which should be associated with this room", "items": { "type": ["string", "null"], "maxLength": 250 } } }, "additionalProperties":false } } }, "additionalProperties":false }, "media":{ "type":["array", "null"], "id":"media", "description":"The media for the property being sent", "required":false, "uniqueItems":true, "maxItems":999, "items":{ "type":"object", "id":"media_detail", "required":true, "properties": { "media_type":{ "type":"integer", "id":"media_type", "required":true, "enum":[1, 2, 3, 4, 5, 6, 7], "description": "The type of media which is being sent: 1 Image, 2 Floorplan, 3 Brochure, 4 Virtual Tour, 5 Audio Tour, 6 EPC, 7 EPC Graph" }, "media_url":{ "type":"string", "minLength":1, "maxLength":250, "id":"media_url", "required":true, "description":"The URL to retrieve this piece of media from" }, "caption":{ "type":["string", "null"], "maxLength":20, "id":"caption", "required":false, "description":"The caption to be displayed for this piece of media" }, "sort_order":{ "type":["integer", "null"], "id":"sort_order", "required":false, "minimum":0, "description":"The display order for this piece of media" }, "media_update_date":{ "type":["string", "null"], "id":"media_update_date", "required":false, "description":"The date the media at this URL was last updated in the format: dd-MM-yyyy HH:mm:ss" } }, "additionalProperties":false } }, "principal":{ "type": ["object", "null"], "id":"principal", "required":false, "uniqueItems":true, "description":"Details of the principal for the property being sent", "properties": { "principal_email_address": { "type": ["string"], "minLength":6, "maxLength":200, "id": "principal_email_address", "required":true, "description": "The email address for the principal for this property" }, "auto_email_when_live": { "type": ["boolean", "null"], "id": "auto_email_when_live", "required":false, "description": "Should the principal be emailed when this property is live on Rightmove" }, "auto_email_updates": { "type": ["boolean", "null"], "id": "auto_email_updates", "required":false, "description": "Should the principal be emailed when this property is updated on Rightmove" } }, "additionalProperties":false } }, "additionalProperties":false } }