KW Worldwide Listings Search API

{"openapi":"3.0.1","info":{"title":"KW Listings Search","description":"The Listings service returns all Keller Williams Listing Service listings specific to an agent. This is not a substitution for or tied to any Multiple Listings Services database records.","contact":{"name":"Kellerwilliams","url":"https://kw.com"},"version":"2"},"servers":[{"url":"https://partners.api.kw.com/v2","description":"Production"},{"url":"https://sandbox.partners.api.kw.com/v2","description":"Sandbox"}],"paths":{"/listings":{"get":{"tags":["Search"],"summary":"Listings search","description":"This endpoint returns listings.","operationId":"listings-read","parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic token is created by base 64 encoding your credentials: <Basic base64Encode(API_KEY:API_SECRET)>","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"number"},"description":"Could be Ascendant or Descendant (-). Visit [Filtering and Sorting](/filtering-and-sorting) for more details."},{"name":"page[offset]","in":"query","required":false,"schema":{"type":"number","default":1},"description":"Page Number you would like to retrieve. Offset defaults to 1. Requesting an offset less than 1 will default to 1 as this is the starting set of listings.\n`GET ?page[offset]=2&page[limit]=12`.- **[Page](http://jsonapi.org/format/#fetching-pagination)\n\n  This retreives the second page.\n  `GET ?page[offset]=2"},{"name":"limit","in":"query","required":false,"schema":{"type":"number","default":10},"description":"Number of listings return size. `GET ?limit=10`.  Limit should be 100 or less and use offset get the next set of listings"},{"name":"offset","in":"query","required":false,"schema":{"type":"number","default":1},"description":"The next set of listings number you would like to retrieve. Offset defaults to 1. Requesting an offset less than 1 will default to 1 as this is the starting set of listings.\n`GET ?offset=2&limit]=10`.- **[Page](http://jsonapi.org/format/#fetching-pagination)\n\n  This retreives the second set of listings from 11-20.\n  `GET ?offset=2"},{"name":"page[limit]","in":"query","required":false,"schema":{"type":"number","default":10},"description":"Page size. [Size](http://jsonapi.org/format/#fetching-pagination)\n  `GET ?page[limit]=12`.  Page limit should be 100 or less and use offset get the next set of listings"},{"in":"query","name":"filter[:attribute_name][:operator]=:value","schema":{"type":"string"},"description":"Dynamic filtering. Visit [Filtering and Sorting](/filtering-and-sorting) for more details."},{"in":"query","name":"scroll_id","schema":{"type":"string"},"description":"Scroll ID of the search. `GET ?scroll=1m&scroll_id=FGluY2x1ZGVfY29udGV4dF91dWlkDnF1ZXJ5VGhlbkZldGNoBRR6c0ZfTzNjQmppWDR5MjB6azI1aQAAAAAAMeioFnpRQTVMVHdTVEVXeVZkT3Zfc0Jld2cUNVh0X08zY0JuSF9zWmtIY2t3MWkAAAAAADHa0hY5M1VrWkM0dlRHYWUyLUtsZXczQ0RRFFBYZF9PM2NCdEZiektwOW5rM0poAAAAAAAx4SUWZnNoTzVEQzBSZFdldGFaY01vVTJkURRObGxfTzNjQjlSaU40a2JaazdKagAAAAAAMca2FmVuS3dpSXNQU3o2ZUFlZnBwNjREM2cUTjFsX08zY0I5UmlONGtiWms3Sm0AAAAAADHGtxZlbkt3aUlzUFN6NmVBZWZwcDY0RDNn`\n\t\nUse this parameter in conjunction with scroll."},{"in":"query","name":"scroll","schema":{"type":"string","default":"1m"},"description":"Period to retain the search context for scrolling. `GET ?scroll=1m`"}],"responses":{"200":{"$ref":"#/components/responses/ListingsResponse"},"400":{"$ref":"#/components/responses/BadRequestErrorResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"},"502":{"$ref":"#/components/responses/UnhandledErrorResponse"}}},"post":{"tags":["Search"],"summary":"Create Listings","description":"This endpoint creates listings.  Note: Avoid using special charater like % in the listing description which will create problems.","operationId":"listings-create","parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic token is created by base 64 encoding your credentials: <Basic base64Encode(API_KEY:API_SECRET)>","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ListingsCreate"},"responses":{"201":{"$ref":"#/components/responses/ListingsCreated"},"400":{"$ref":"#/components/responses/BadRequestErrorResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"},"502":{"$ref":"#/components/responses/UnhandledErrorResponse"}}}},"/listings/{list_uuid}":{"delete":{"tags":["Search"],"summary":"Delete Listings","description":"This endpoint removes listings.","operationId":"listings-details-delete","parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic token is created by base 64 encoding your credentials: <Basic base64Encode(API_KEY:API_SECRET)>","schema":{"type":"string"}},{"name":"list_uuid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/DeleteResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"},"502":{"$ref":"#/components/responses/UnhandledErrorResponse"}}},"patch":{"tags":["Search"],"summary":"Update Listings","description":"This endpoint updates listings.","operationId":"listings-details-update","parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic token is created by base 64 encoding your credentials: <Basic base64Encode(API_KEY:API_SECRET)>","schema":{"type":"string"}},{"name":"list_uuid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ListingsUpdate"},"responses":{"200":{"$ref":"#/components/responses/ListingsCreated"},"400":{"$ref":"#/components/responses/BadRequestErrorResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"},"502":{"$ref":"#/components/responses/UnhandledErrorResponse"}}}},"/listings/lookup-table":{"get":{"tags":["Search"],"summary":"Find table","description":"This endpoint returns table","operationId":"listings-read-by-table","parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic token is created by base 64 encoding your credentials: <Basic base64Encode(API_KEY:API_SECRET)>","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/LookupTableResponse"},"400":{"$ref":"#/components/responses/BadRequestErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"},"502":{"$ref":"#/components/responses/UnhandledErrorResponse"}}}},"/listings/region/{regionId}":{"get":{"tags":["Search"],"summary":"Region details by ID","description":"This endpoint returns region details by ID.","operationId":"listings-region-details-read","parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic token is created by base 64 encoding your credentials: <Basic base64Encode(API_KEY:API_SECRET)>","schema":{"type":"string"}},{"name":"regionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/ListingsResponse"},"400":{"$ref":"#/components/responses/BadRequestErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"},"502":{"$ref":"#/components/responses/UnhandledErrorResponse"}}}},"/listings/orgs/{orgId}/people":{"get":{"tags":["Search"],"summary":"People Orgs","operationId":"listings-region-people-read","description":"This endpoint returns People Orgs by ID.","parameters":[{"name":"Authorization","in":"header","required":true,"description":"Basic token is created by base 64 encoding your credentials: <Basic base64Encode(API_KEY:API_SECRET)>","schema":{"type":"string"}},{"name":"orgId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/OrgsPeople"},"400":{"$ref":"#/components/responses/BadRequestErrorResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorResponse"},"502":{"$ref":"#/components/responses/UnhandledErrorResponse"}}}}},"components":{"schemas":{"OrgsPeople":{"type":"object","properties":{"meta":{"type":"object","properties":{"query":{"type":"object","properties":{"limit":{"type":"integer"},"offset":{"type":"integer"},"cache":{"type":"boolean"},"is_org_legacy_team":{"type":"boolean"},"is_org_legacy_id":{"type":"boolean"},"include_inactive":{"type":"boolean"},"include_active":{"type":"boolean"},"include_person_kwid":{"type":"boolean"}}},"total":{"type":"integer"}}},"data":{"type":"array","items":{"type":"object","properties":{"kw_uid":{"type":"integer"},"username":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"kw_email":{"type":"string"},"default_org_id":{"type":"integer"},"recovery_email":{"type":"string"},"email":{"type":"string"},"marketing_email":{"type":"string"},"kw_start_dt":{"type":"string"},"re_start_dt":{"type":"string"},"photo":{"type":"string"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"address_1":{"type":"string"},"address_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postal_code":{"type":"string"},"country":{"type":"string"},"luxury":{"type":"integer"},"luxury_dt":{"type":"string"},"commercial":{"type":"integer"},"land":{"type":"integer"},"kwyp":{"type":"integer"},"gps":{"type":"integer"},"maps_client":{"type":"integer"},"maps_coach":{"type":"integer"},"maps_mastery_client":{"type":"integer"},"active":{"type":"integer"},"km_active":{"type":"integer"},"kww":{"type":"integer"},"military":{"type":"integer"},"designations":{"type":"string"},"vested":{"type":"integer"},"birth_dt":{"type":"string"},"service_areas":{"type":"string"},"org_start_dt":{"type":"string"},"recruit_id":{"type":"integer"},"languages":{"type":"array","items":{}},"license":{"type":"array","items":{}},"teams":{"type":"array","items":{}},"person_role_orgs":{"type":"array","items":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"legacy_role_id":{"type":"integer"}}},"end_dt":{"type":"string"},"kw_uid":{"type":"integer"},"org_id":{"type":"integer"},"org_key":{"type":"string"},"role_id":{"type":"integer"},"start_dt":{"type":"string"},"legacy_org_id":{"type":"integer"},"legacy_team_id":{"type":"integer"}}}}}}}},"description":"Orgs people object"},"Error":{"type":"object","properties":{"success":{"type":"string"},"errorCode":{"type":"string"},"message":{"type":"string"}},"description":"Error object. If an error occurred, 'success' field will be 'false.'"},"ListingsCreate":{"type":"object","required":["mls_id","source_system_name","mls_number","current_list_price","list_status_id","list_category","list_category_id","prop_type","prop_type_id","prop_subtype","prop_subtype_id"],"properties":{"list_kw_uid":{"type":"number"},"list_desc":{"type":"string"},"co_list_kw_uid":{"type":"number"},"list_type":{"type":"string"},"source_system_name":{"type":"string"},"version":{"type":"string"},"list_type_id":{"type":"number"},"kwls_status":{"type":"string"},"current_list_price":{"type":"number"},"list_status_id":{"type":"number"},"list_category":{"type":"string"},"list_category_id":{"type":"number"},"prop_type":{"type":"string"},"prop_type_id":{"type":"number"},"prop_subtype":{"type":"string"},"prop_subtype_id":{"type":"number"},"list_status":{"type":"string"},"mls_id":{"type":"string"},"mls_number":{"type":"string"}}},"ListingsResponse":{"type":"object","properties":{"took":{"type":"integer"},"timed_out":{"type":"boolean"},"_shards":{"type":"object","properties":{"total":{"type":"integer"},"successful":{"type":"integer"},"skipped":{"type":"integer"},"failed":{"type":"integer"}}},"hits":{"type":"object","properties":{"total":{"type":"object","properties":{"value":{"type":"integer"},"relation":{"type":"string"}}},"max_score":{"type":"number"},"hits":{"type":"array","items":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string"},"_score":{"type":"string"},"_source":{"type":"object","properties":{"brokerage":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}}},"close_dt":{"type":"string"},"close_price":{"type":"string"},"co_list_agent_office":{"type":"string"},"co_list_kw_uid":{"type":"string"},"co_sell_agent_office":{"type":"string"},"commissions":{"type":"string"},"contract_expiry_dt":{"type":"string"},"contract_expiry_dt_lock":{"type":"boolean"},"currency_code":{"type":"string"},"current_list_price":{"type":"integer"},"expenses":{"type":"string"},"full_bath":{"type":"integer"},"geo":{"type":"object","properties":{"address_id":{"type":"array","items":{"type":"integer"}},"city":{"type":"array","items":{"type":"integer"}},"county":{"type":"array","items":{"type":"integer"}},"mcd":{"type":"array","items":{"type":"integer"}},"neighborhood":{"type":"array","items":{"type":"integer"}},"postal_code":{"type":"array","items":{"type":"integer"}},"property_id":{"type":"integer"},"school_attendance":{"type":"array","items":{"type":"integer"}},"school_district":{"type":"array","items":{"type":"integer"}},"state":{"type":"array","items":{"type":"integer"}}}},"green_home":{"type":"string"},"half_bath":{"type":"integer"},"history":{"type":"string"},"hoa":{"type":"array","items":{"type":"object","properties":{"assoc_amenities":{"type":"array","items":{"type":"string"}},"assoc_fee":{"type":"integer"},"assoc_fee_freq":{"type":"string"},"assoc_fee_freq_search":{"type":"string"},"assoc_fee_includes":{"type":"array","items":{"type":"string"}},"assoc_fee_search":{"type":"string"},"assoc_req":{"type":"string"},"has_assoc":{"type":"boolean"}}}},"is_deleted":{"type":"boolean"},"is_kww_listing":{"type":"boolean"},"kw_agent":{"type":"boolean"},"kw_attribute":{"type":"string"},"kw_created_at":{"type":"string"},"kw_expiry_dt":{"type":"string"},"kw_expiry_dt_lock":{"type":"boolean"},"kw_listing":{"type":"boolean"},"kw_mc":{"type":"boolean"},"kw_updated_at":{"type":"string"},"kw_updated_by":{"type":"string"},"kwls_status":{"type":"string"},"kww_region":{"type":"string"},"lease_price":{"type":"string"},"list_address":{"type":"object","properties":{"address":{"type":"string"},"city":{"type":"string"},"coordinates_gp":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"}}},"coordinates_gs":{"type":"object","properties":{"coordinates":{"type":"array","items":{"type":"number"}},"type":{"type":"string"}}},"country":{"type":"string"},"full_street_address":{"type":"string"},"postal_code":{"type":"string"},"state_prov":{"type":"string"},"street_direction":{"type":"string"},"street_name":{"type":"string"},"street_number":{"type":"string"},"street_post_dir":{"type":"string"},"street_suffix":{"type":"string"},"unit_number":{"type":"string"},"zip_4":{"type":"string"}}},"list_agent_office":{"type":"object","properties":{"list_agent_email":{"type":"string"},"list_agent_fax":{"type":"string"},"list_agent_first_name":{"type":"string"},"list_agent_full_name":{"type":"string"},"list_agent_key":{"type":"string"},"list_agent_key_2":{"type":"string"},"list_agent_last_name":{"type":"string"},"list_agent_mls_id":{"type":"string"},"list_agent_mls_id_2":{"type":"string"},"list_agent_office_phone":{"type":"string"},"list_agent_preferred_phone":{"type":"string"},"list_agent_url":{"type":"string"},"list_office_address":{"type":"string"},"list_office_email":{"type":"string"},"list_office_fax":{"type":"string"},"list_office_key":{"type":"string"},"list_office_key_2":{"type":"string"},"list_office_mls_id":{"type":"string"},"list_office_mls_id_2":{"type":"string"},"list_office_name":{"type":"string"},"list_office_phone":{"type":"string"},"list_office_url":{"type":"string"}}},"list_category":{"type":"string"},"list_category_id":{"type":"integer"},"list_desc":{"type":"string"},"list_desc_en":{"type":"string"},"list_desc_lock":{"type":"boolean"},"list_dt":{"type":"string"},"list_id":{"type":"integer"},"list_key":{"type":"string"},"list_kw_uid":{"type":"string"},"list_status":{"type":"string"},"list_status_id":{"type":"integer"},"list_status_lock":{"type":"boolean"},"list_type":{"type":"string"},"list_type_id":{"type":"integer"},"list_uuid":{"type":"string"},"living_area":{"type":"integer"},"living_area_units":{"type":"string"},"location":{"type":"object","properties":{"county":{"type":"string"},"municipality":{"type":"string"},"neighborhoods":{"type":"string"},"prop_directions":{"type":"string"},"region":{"type":"string"},"schools":{"type":"string"},"subdivision":{"type":"string"},"township":{"type":"string"},"zoning":{"type":"string"}}},"lot_depth_area":{"type":"string"},"lot_depth_units":{"type":"string"},"lot_front_area":{"type":"string"},"lot_front_units":{"type":"string"},"lot_size_area":{"type":"number"},"lot_size_units":{"type":"string"},"luxury_home":{"type":"boolean"},"manual_entry":{"type":"boolean"},"market_center":{"type":"string"},"marketing_info":{"type":"object","properties":{"courtesy_label":{"type":"string"},"courtesy_location":{"type":"string"},"courtesy_of_detail":{"type":"string"},"courtesy_of_list":{"type":"string"},"display_address":{"type":"boolean"},"display_internet":{"type":"boolean"},"display_list_price":{"type":"boolean"},"display_listing":{"type":"boolean"},"display_photo":{"type":"boolean"},"legal_accept_disclaimer":{"type":"boolean"},"legal_description":{"type":"string"},"legal_exclusive_rights":{"type":"boolean"},"living_area_display":{"type":"string"},"photo_courtesy_required":{"type":"boolean"},"vow":{"type":"boolean"}}},"mls_id":{"type":"string"},"mls_name":{"type":"string"},"mls_number":{"type":"string"},"mls_source_id":{"type":"integer"},"mls_updated_at":{"type":"string"},"office_size":{"type":"string"},"office_size_units":{"type":"string"},"one_quarter_bath":{"type":"integer"},"open_houses":{"type":"string"},"open_houses_lock":{"type":"boolean"},"original_list_category":{"type":"string"},"original_list_category_id":{"type":"integer"},"original_list_price":{"type":"integer"},"other_area_size":{"type":"string"},"other_area_size_units":{"type":"string"},"partial_bath":{"type":"integer"},"photos":{"type":"array","items":{"type":"object","properties":{"kw_ph_url":{"type":"string"},"ph_label":{"type":"string"},"ph_order":{"type":"number"},"ph_short_desc":{"type":"string"},"ph_tags":{"type":"string"},"ph_updated_at":{"type":"string"},"ph_url":{"type":"string"}}}},"photos_lock":{"type":"boolean"},"price_history":{"type":"array","items":{"type":"object","properties":{"current_list_price":{"type":"integer"},"in_use":{"type":"boolean"},"percent_change":{"type":"integer"},"previous_list_price":{"type":"integer"},"price_updated_at":{"type":"string"}}}},"price_tax_suffix":{"type":"boolean"},"prop_subtype":{"type":"string"},"prop_subtype_id":{"type":"integer"},"prop_subtype_lock":{"type":"boolean"},"prop_type":{"type":"string"},"prop_type_id":{"type":"integer"},"prop_type_lock":{"type":"boolean"},"property_address":{"type":"object","properties":{"address":{"type":"string"},"city_long":{"type":"string"},"city_short":{"type":"string"},"coordinates_gp":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"}}},"coordinates_gs":{"type":"object","properties":{"coordinates":{"type":"array","items":{"type":"number"}},"type":{"type":"string"}}},"country_long":{"type":"string"},"country_short":{"type":"string"},"county":{"type":"string"},"county_fips":{"type":"string"},"full_street_address":{"type":"string"},"habitation_name":{"type":"string"},"level_number":{"type":"string"},"postal_code_long":{"type":"string"},"postal_code_short":{"type":"string"},"rural_address":{"type":"string"},"state_prov_short":{"type":"string"},"street_direction":{"type":"string"},"street_long":{"type":"string"},"street_number":{"type":"string"},"street_suffix_short":{"type":"string"},"unit_number":{"type":"string"},"unit_type":{"type":"string"},"zip_4":{"type":"string"}}},"raw":{"type":"object","properties":{"co_list_kw_uid":{"type":"string"},"co_list_market_center":{"type":"string"},"display_listing":{"type":"string"},"lambda_updated_at":{"type":"string"},"list_kw_uid":{"type":"string"},"list_status":{"type":"string"},"list_status_id":{"type":"string"},"market_center":{"type":"string"},"parking_total":{"type":"string"},"prop_type":{"type":"string"},"prop_type_id":{"type":"string"},"signature_id":{"type":"string"},"source_list_id":{"type":"string"},"trace_id":{"type":"string"}}},"retail_size":{"type":"string"},"retail_size_units":{"type":"string"},"sell_agent_office":{"type":"string"},"sell_kw_uid":{"type":"string"},"source_system_name":{"type":"string"},"special_list_condition":{"type":"string"},"structure":{"type":"object","properties":{"appliances":{"type":"array","items":{"type":"string"}},"architectural_styles":{"type":"string"},"basement_desc":{"type":"string"},"building_name":{"type":"string"},"construction_materials":{"type":"array","items":{"type":"string"}},"dining_room_desc":{"type":"string"},"exterior_features":{"type":"object","properties":{"has_barbecue_area":{"type":"boolean"},"has_deck":{"type":"boolean"},"has_disabled_access":{"type":"boolean"},"has_dock":{"type":"boolean"},"has_garden":{"type":"boolean"},"has_gated_entry":{"type":"boolean"},"has_green_house":{"type":"boolean"},"has_hot_tub_spa":{"type":"boolean"},"has_patio":{"type":"boolean"},"has_pond":{"type":"boolean"},"has_pool":{"type":"boolean"},"has_porch":{"type":"boolean"},"has_rv_parking":{"type":"boolean"},"has_sports_court":{"type":"boolean"},"has_sprinkler_system":{"type":"boolean"},"is_water_front":{"type":"boolean"}}},"fireplace_desc":{"type":"string"},"fireplaces_total":{"type":"string"},"floorings":{"type":"string"},"foundation_details":{"type":"array","items":{"type":"string"}},"has_garage":{"type":"boolean"},"has_parking":{"type":"boolean"},"heating_cooling":{"type":"array","items":{"type":"string"}},"interior_features":{"type":"object","properties":{"has_ceiling_fan":{"type":"boolean"},"has_fireplace":{"type":"boolean"},"has_jetted_bath_tub":{"type":"boolean"},"has_mother_in_law":{"type":"boolean"},"has_sauna":{"type":"boolean"},"has_security_system":{"type":"boolean"},"has_skylight":{"type":"boolean"},"has_vaulted_ceiling":{"type":"boolean"},"has_wet_bar":{"type":"boolean"},"is_cable_ready":{"type":"boolean"},"is_wired":{"type":"boolean"}}},"is_new_construction":{"type":"boolean"},"parking_features":{"type":"array","items":{"type":"string"}},"parking_total":{"type":"integer"},"roof_types":{"type":"array","items":{"type":"string"}},"rooms_total":{"type":"string"},"stories":{"type":"string"},"total_buildings":{"type":"string"},"total_units":{"type":"string"},"unit_level":{"type":"string"},"utilities":{"type":"string"},"views":{"type":"string"},"water_source":{"type":"array","items":{"type":"string"}}}},"syndicate":{"type":"object","properties":{"all_kw_apps":{"type":"boolean"},"brokerage_id":{"type":"string"},"command_only":{"type":"boolean"},"consumer_only":{"type":"boolean"},"list_org_id":{"type":"string"},"list_team_id":{"type":"string"}}},"system":{"type":"object","properties":{"processed_by":{"type":"string"},"reprocessed":{"type":"boolean"}}},"taxes":{"type":"array","items":{"type":"object","properties":{"tax_amt":{"type":"integer"},"tax_id":{"type":"string"},"tax_year":{"type":"string"}}}},"three_quarter_bath":{"type":"integer"},"total_bath":{"type":"integer"},"total_bed":{"type":"integer"},"version":{"type":"string"},"virtual_tours":{"type":"array","items":{"type":"object","properties":{"vt_short_desc":{"type":"string"},"vt_updated_at":{"type":"string"},"vt_url":{"type":"string"},"vt_url_branded":{"type":"boolean"}}}},"virtual_tours_lock":{"type":"boolean"},"warehouse_size":{"type":"string"},"warehouse_size_units":{"type":"string"},"year_built":{"type":"integer"},"days_on_market":{"type":"integer"},"lot_size_units_transkey":{"type":"string"},"living_area_units_transkey":{"type":"string"},"list_status_transkey":{"type":"string"},"prop_type_transkey":{"type":"string"},"list_type_transkey":{"type":"string"},"kwls_status_transkey":{"type":"string"},"list_category_transkey":{"type":"string"}}},"sort":{"type":"array","items":{"type":"integer"}}}}}}}}},"LookupTableResponse":{"type":"object","properties":{"took":{"type":"integer"},"timed_out":{"type":"boolean"},"_shards":{"type":"object","properties":{"total":{"type":"integer"},"successful":{"type":"integer"},"skipped":{"type":"integer"},"failed":{"type":"integer"}}},"hits":{"type":"object","properties":{"total":{"type":"object","properties":{"value":{"type":"integer"},"relation":{"type":"string"}}},"max_score":{"type":"integer"},"hits":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/LookupTableHitListType"},{"$ref":"#/components/schemas/LookupTableHitCurrency"},{"$ref":"#/components/schemas/LookupTableHitCountry"},{"$ref":"#/components/schemas/LookupTableHitUnit"},{"$ref":"#/components/schemas/LookupTableHitKWLSStatus"},{"$ref":"#/components/schemas/LookupTableHitAppliance"},{"$ref":"#/components/schemas/LookupTableHitListCategory"},{"$ref":"#/components/schemas/LookupTableHitExpenseType"},{"$ref":"#/components/schemas/LookupTableHitOhStatus"},{"$ref":"#/components/schemas/LookupTableHitFlooring"},{"$ref":"#/components/schemas/LookupTableHitSyndicate"},{"$ref":"#/components/schemas/LookupTableHitFrequency"},{"$ref":"#/components/schemas/LookupTableHitArchStyle"},{"$ref":"#/components/schemas/LookupTableHitParkingFeature"},{"$ref":"#/components/schemas/LookupTableHitConstructionMaterial"},{"$ref":"#/components/schemas/LookupTableHitRoofType"},{"$ref":"#/components/schemas/LookupTableHitSpecialCondition"},{"$ref":"#/components/schemas/LookupTableHitStateProvince"},{"$ref":"#/components/schemas/LookupTableHitPropType"},{"$ref":"#/components/schemas/LookupTableHitPropSupType"},{"$ref":"#/components/schemas/LookupTableHitListStatus"}]}}}}}},"LookupTableHitPropSupType":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["prop_sub_type"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"prop_sub_type":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"},"value_transkey":{"type":"string"},"sa_mapping":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}}}},"LookupTableHitListStatus":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["list_status"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"list_status":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"},"value_transkey":{"type":"string"},"sa_mapping":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}}}},"LookupTableHitPropType":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["prop_type"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"prop_type":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"},"value_transkey":{"type":"string"},"sa_mapping":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}}}},"LookupTableHitStateProvince":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["state_province"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"state_province":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"value":{"type":"string"}}}}}}}},"LookupTableHitSpecialCondition":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["special_condition"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"special_condition":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitRoofType":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["roof_type"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"roof_type":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitConstructionMaterial":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["construction_material"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"construction_material":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitParkingFeature":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["parking_feature"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"parking_feature":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitArchStyle":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["arch_style"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"arch_style":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitFrequency":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["frequency"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"frequency":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitSyndicate":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["syndicate"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"syndicate":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitFlooring":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["flooring"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"flooring":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitOhStatus":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["oh_status"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"oh_status":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitExpenseType":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["expense_type"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"expense_type":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitListCategory":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["list_category"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"list_category":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"},"sa_mapping":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}},"value_transkey":{"type":"string"}}}}}}}},"LookupTableHitAppliance":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["appliance"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"appliance":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value":{"type":"string"}}}}}}}},"LookupTableHitKWLSStatus":{"type":"object","properties":{"_index":{"type":"string"},"_type":{"type":"string"},"_id":{"type":"string","enum":["kwls_status"]},"_score":{"type":"integer"},"_source":{"type":"object","properties":{"kwls_status":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"value

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/keller-williams/refs/heads/main/openapi/keller-williams-listings-search-openapi.json