{"openapi":"3.1.0","info":{"title":"Zillow API — RealtyAPI","version":"1.0.0","description":"Zillow API endpoints All endpoints require an API key sent in the `x-realtyapi-key` header. Get a key and try every endpoint interactively at https://www.realtyapi.io/api/zillow.","contact":{"name":"RealtyAPI","url":"https://www.realtyapi.io","email":"support@realtyapi.io"}},"externalDocs":{"description":"Interactive API playground and docs","url":"https://www.realtyapi.io/api/zillow"},"servers":[{"url":"https://zillow.realtyapi.io"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Property Info - Advanced ⭐️","description":"Property Info - Advanced ⭐️ endpoints"},{"name":"Property Info - Minimal","description":"Property Info - Minimal endpoints"},{"name":"Search Zillow","description":"Search Zillow endpoints"},{"name":"Graphs and Charts (Estimates)","description":"Graphs and Charts (Estimates) endpoints"},{"name":"Property Info - Specific","description":"Property Info - Specific endpoints"},{"name":"Market Analytics","description":"Market Analytics endpoints"},{"name":"Find an Agent","description":"Find an Agent endpoints"},{"name":"Skip Tracing","description":"Skip Tracing endpoints"},{"name":"Mortgage"}],"paths":{"/pro/byaddress":{"get":{"operationId":"get_pro_byaddress","summary":"By Property Address","tags":["Property Info - Advanced ⭐️"],"parameters":[{"name":"propertyaddress","in":"query","required":true,"schema":{"type":"string"},"example":"1875 AVONDALE Circle, Jacksonville, FL 32205"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"The API will find its ZPID from the property address at the backend with 100% accuracy, then get you the property details.."}},"/byaddress":{"get":{"operationId":"get_byaddress","summary":"By Property Address","tags":["Property Info - Minimal"],"parameters":[{"name":"propertyaddress","in":"query","required":true,"schema":{"type":"string"},"example":"1875 AVONDALE Circle, Jacksonville, FL 32205"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Minimalistic and trimmed version of the /pro/byaddress endpoint for easier navigation."}},"/autocomplete":{"get":{"operationId":"get_autocomplete","summary":"autocomplete","tags":["Search Zillow"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"649 Keller St, Bay St Louis, MS 39520"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Provides Zillow search box autocomplete data."}},"/graph_charts":{"get":{"operationId":"get_graph_charts","summary":"Zestimate History (Home Values)","tags":["Graphs and Charts (Estimates)"],"parameters":[{"name":"recent_first","in":"query","required":true,"schema":{"type":"string","enum":["True","False"]}},{"name":"which","in":"query","required":true,"schema":{"type":"string","enum":["zestimate_history","rent_zestimate_history","listing_price","zestimate_percent_change","tax_assessment","tax_paid"]},"example":"zestimate_history"},{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"example":"30907787"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"example":"https://www.zillow.com/homedetails/3-W-Forest-Dr-Rochester-NY-14624/30907787_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"example":"3 W Forest Dr, Rochester, NY 14624"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get listing price chart data for last **TEN(10)** years..\n\n- If recent_first = **True**,\nChart data:  Current month(first) to previous months(last) \n- If recent_first = **False**, Chart data:  Previous months(first )to Current month(last)\n\nThis operation covers: Zestimate History (Home Values), Rent Zestimate History, Listing Price, Zestimate Percent Change, Tax Assessment History, Tax Paid History — select via the enum parameters."}},"/ownerinfo":{"get":{"operationId":"get_ownerinfo","summary":"owner-agent (listedby_info)","tags":["Property Info - Specific"],"parameters":[{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"Enter a property `zpid` value or you can use `byurl or byaddress` options below","example":"30696332"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"example":"https://www.zillow.com/homedetails/220-77th-St-Brooklyn-NY-11209/30696332_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"description":"Use any of the three options(zpid/url/address) to get the output.","example":"220 77th St, Brooklyn, NY 11209"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get owner information of a property by zpid/address/url."}},"/housing_market":{"get":{"operationId":"get_housing_market","summary":"housing_market (zhvi)","tags":["Market Analytics"],"parameters":[{"name":"search_query","in":"query","required":true,"schema":{"type":"string"},"description":"Search any city/state/zip code. To search for full country, put: `USA/United States`","example":"Austin, TX"},{"name":"home_type","in":"query","required":false,"schema":{"type":"string","enum":["All_Homes","Single_Family","Condo"]}},{"name":"exclude_rentalMarketTrends","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set it to `False` if you want to get rental market data too. \nCheck on the website: https://www.zillow.com/home-values/10221/austin-tx/","example":true},{"name":"exclude_neighborhoods_zhvi","in":"query","required":false,"schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Find the Zillow Home Value Index or housing market data."}},"/agent/search":{"get":{"operationId":"get_agent_search","summary":"agent/search","tags":["Find an Agent"],"parameters":[{"name":"location","in":"query","required":false,"schema":{"type":"string"},"description":"Enter city, neighborhood, or zip code. Ex. `Saint Louis, MO` or `30043`","example":"10001"},{"name":"agentName","in":"query","required":false,"schema":{"type":"string"},"description":"Enter an agent name(optional).","example":"Alex"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"example":1},{"name":"isBuying","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"isSelling","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"isTopAgent","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"priceRange","in":"query","required":false,"schema":{"type":"string"},"description":"Set the minimum and maximum price like this:\n- `300000,10000000`"},{"name":"specialties","in":"query","required":false,"schema":{"type":"string"},"description":"Set specialties one by one, no space, separated with commas:\n- `Possible Values`: first-time-home-buyers,foreclosure,investment-properties,lot-or-land,luxury-homes,military-or-veterans,new-construction,property-management,relocation,rentals,senior-communities,vacation-short-term-rentals"},{"name":"languages","in":"query","required":false,"schema":{"type":"string"},"description":"- Keeping it empty will set `English` by default.\n\nSet languages one by one, no space, separated with commas:\n- `Possible Values`: arabic,bengali,cantonese,farsi,filipino,french,german,greek,hebrew,hindi,\nhungarian,italian,japanese,korean,mandarin,polish,portuguese,russian,spanish,thai,turkish,vietnamese"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search Zillow Agents."}},"/skip/byaddress":{"get":{"operationId":"get_skip_byaddress","summary":"skip_trace/byaddress","tags":["Skip Tracing"],"parameters":[{"name":"street","in":"query","required":true,"schema":{"type":"string"},"example":"3828 Double Oak Ln"},{"name":"citystatezip","in":"query","required":true,"schema":{"type":"string"},"example":"Irving, TX 75061"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"Use pagination (1, 2, 3...) if records are **more than 10** in the previous page. \n\n\n### **Important:**\n- Skip tracing endpoints costs `6 requests/call`.\n- **For more requests and endpoints, use this API**: https://rapidapi.com/oneapiproject/api/skip-tracing-working-api","example":1}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get IDs of persons matching with the addresses. Use this ID in the other skip trace endpoint to get phone, email and more info."}},"/current_mortgage_rates":{"get":{"operationId":"get_current_mortgage_rates","summary":"current_mortgage_rates","tags":["Mortgage"],"parameters":[],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Find Zillow Current Mortgage Rates"}},"/pro/byzpid":{"get":{"operationId":"get_pro_byzpid","summary":"By Zpid","tags":["Property Info - Advanced ⭐️"],"parameters":[{"name":"zpid","in":"query","required":true,"schema":{"type":"string"},"example":"44471319"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"You can find the ZPID in the Zillow url.\n\nIf you can't find your ZPID, then use /byaddress endpoint. It works exactly the same."}},"/byzpid":{"get":{"operationId":"get_byzpid","summary":"By Zpid","tags":["Property Info - Minimal"],"parameters":[{"name":"zpid","in":"query","required":true,"schema":{"type":"string"},"example":"44471319"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"You can find the ZPID in the Zillow URL.\nMinimalistic and trimmed version of the /pro/zpid endpoint for easier navigation.\n\n"}},"/search/byaddress":{"get":{"operationId":"get_search_byaddress","summary":"search/byaddress","tags":["Search Zillow"],"parameters":[{"name":"location","in":"query","required":true,"schema":{"type":"string"},"description":"Enter an address, neighborhood, city, or ZIP code. \nFor Multi-inputs upto 5 (separate with a semicolon): `New York, NY; Seattle, WA; 78006`","example":"New York, NY"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"Zillow provides `1000` results on each search. This endpoint returns `200` results per call. So the maximum page number could be `5`. \n\n- `To collect all the data`:  Narrow down your search into smaller areas. (Search by zip code, Set different listPriceRange, try different homeTypes)","example":1},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Homes_for_you","Rental_Priority_Score","Price_High_to_Low","Price_Low_to_High","Newest","Bedrooms","Bathrooms","Square_Feet","Lot_Size","Year_Built"]},"description":"Select how you want to sort your search results. \n- Defaults:\n- For Sale : `Homes_for_you`\n- For Rent : `Rental_Priority_Score`\n- Sold : `Newest`"},{"name":"listingStatus","in":"query","required":true,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"Select which type of property data you want to find. "},{"name":"listPriceRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Price:  `min:5000`\n- For Maximum Price:  `max:500000`\n- For a Price Range:  `min:5000, max:500000`"},{"name":"monthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for **listingStatus**: `For_Sale`. \n**Possible Inputs:**\n- For Minimum Payment:  `min:5000`\n- For Maximum Payment:  `max:50000`\n- For a Payment Range:  `min:5000, max:50000`"},{"name":"downPayment","in":"query","required":false,"schema":{"type":"number"},"description":"Only used for **listingStatus**: `For_Sale`. Input a down payment (dollars). Example: `15000`. For *No Down Payment*,  do not input anything."},{"name":"bed_min","in":"query","required":false,"schema":{"type":"string","enum":["No_Min","Studio","1","2","3","4","5"]},"description":"Input the minimum number of bedrooms that should be present on the listings. For an **exact match**, use bed_min and bed_max equal. For example, to see properties with 3 bedrooms: `bed_min=3, bed_max=3`"},{"name":"bed_max","in":"query","required":false,"schema":{"type":"string","enum":["No_Max","Studio","1","2","3","4","5"]},"description":"Input the maximum number of bedrooms that could be present on the listings. "},{"name":"bathrooms","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","OneHalfPlus","TwoPlus","ThreePlus","FourPlus"]},"description":"Input Mapping Explanation:\n`Any` → Any\n`OnePlus` → 1+\n`OneHalfPlus` → 1.5+\n`TwoPlus` →  2+\n`ThreePlus` → 3+\n`FourPlus` →  4+"},{"name":"homeType","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n1. Possible values when **`listingStatus` = `For_Rent`**: \n- `Houses, Apartments/Condos/Co-ops, Townhomes`\n2. Possible values when **`listingStatus` = `For_Sale` or `Sold`**: \n- `Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured`\n","example":"Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured"},{"name":"space","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will `NOT` select any types.\n\n- Only used for `listingStatus` = `For_Rent`\n- Possible values: `Entire Place, Room`"},{"name":"maxHOA","in":"query","required":false,"schema":{"type":"string","enum":["Any","No_HOA_Fee","50_dollars_month","100_dollars_month","200_dollars_month","300_dollars_month","400_dollars_month","500_dollars_month","600_dollars_month","700_dollars_month","800_dollars_month","900_dollars_month","1000_dollars_month"]},"description":"Only used for **listingStatus**: `For_Sale` or `Sold`."},{"name":"incIncompleteHOA","in":"query","required":false,"schema":{"type":"boolean"},"description":"Include homes with incomplete HOA data. Only used for **listingStatus**: `For_Sale` or `Sold`."},{"name":"listingType","in":"query","required":false,"schema":{"type":"string","enum":["Any","By_Agent","By_Owner_and_Other"]},"description":"Only used for **listingStatus**: `For_Sale`.  Default: **Any**. Keep it Any to select all types."},{"name":"listingTypeOptions","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for **listingStatus**: `For_Sale`. For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n- All possible values: \n- `Owner Posted, Agent listed, New Construction, Fore-closures, Auctions, Foreclosed, Pre-foreclosures`","example":"Agent listed,New Construction,Fore-closures,Auctions"},{"name":"propertyStatus","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n- Only used for `listingStatus` = `For_Sale`\n- Possible values: `Coming soon, Accepting backup offers, Pending & under contract`"},{"name":"tours","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n1. Possible values when **`listingStatus` = `For_Rent`**: \n- `Must have 3D Tour`\n2. Possible values when **`listingStatus` = `For_Sale`**: \n- `Must have open house, Must have 3D Tour`\n"},{"name":"parkingSpots","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","TwoPlus","ThreePlus","FourPlus"]},"description":"- Only used for `listingStatus` = `For_Sale` or `Sold`\n- Where:  `Any` → Any\n`OnePlus` → 1+\n`TwoPlus` →  2+\n`ThreePlus` → 3+\n`FourPlus` →  4+"},{"name":"haveGarage","in":"query","required":false,"schema":{"type":"boolean"},"description":"- Only used for `listingStatus` = `For_Sale` or `Sold`\n"},{"name":"move_in_date","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for `listingStatus` = `For_Rent`"},{"name":"hideNoDateListings","in":"query","required":false,"schema":{"type":"boolean"},"description":"Hide listings with no move-in date provided. Only used: `For_Rent`"},{"name":"squareFeetRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Square Feet:  `min:500`\n- For Maximum Square Feet:  `max:5000`\n- For a Square Feet Range:  `min:500, max:5000`"},{"name":"lotSizeRange","in":"query","required":false,"schema":{"type":"string"},"description":"Values should be in **square feet**.  For acre-sqft calculation: `1 acre` = `43560 sqft`\n\n1. **Possible Inputs:**\n- For Minimum Lot Size:  `min:1000`\n- For Maximum Lot Size:  `max:7500`\n- For a Lot Size Range:  `min:1000, max:7500`"},{"name":"yearBuiltRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Year Built:  `min:2011`\n- For Maximum Year Built:  `max:2024`\n- For a Year Built Range:  `min:2011, max:2024`"},{"name":"mustHaveBasement","in":"query","required":false,"schema":{"type":"string","enum":["No","Yes_Finished","Yes_Unfinished","Yes_Both"]}},{"name":"singleStoryOnly","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hide55plusComm","in":"query","required":false,"schema":{"type":"boolean"},"description":"Senior Living: Hide 55+ communities\n- Only used for `listingStatus` = `For_Sale` or `Sold`\n"},{"name":"pets","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma.\n\n- Only used for `listingStatus` = `For_Rent`\n- Possible values: `Allow large dogs, Allow small dogs, Allow cats`"},{"name":"otherAmenities","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n1. Possible values when **`listingStatus` = `For_Sale` or `Sold`**: \n- `Must have A/C, Must have pool, Waterfront`\n2. Possible values when **`listingStatus` =   `For_Rent`**: \n- `Must have A/C, Must have pool, Waterfront, On-site Parking, In-unit Laundry, Accepts Zillow Applications, Income Restricted, Apartment Community`\n"},{"name":"view","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n- Possible values: `City, Mountain, Park, Water`"},{"name":"daysOnZillow","in":"query","required":false,"schema":{"type":"string","enum":["Any","1_day","7_days","14_days","30_days","90_days","6_months","12_months","24_months","36_months"]},"description":"- Only used for `listingStatus` = `For_Sale` or `Rent`"},{"name":"soldInLast","in":"query","required":false,"schema":{"type":"string","enum":["Any","1_day","7_days","14_days","30_days","90_days","6_months","12_months","24_months","36_months"]},"description":"- Only used for `listingStatus` = `Sold`"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"MLS #, yard, fireplace, horses, etc"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Full Zillow search and filter endpoint. Every search filters you see on Zillow website, is available in this endpoint."}},"/comparable_homes":{"get":{"operationId":"get_comparable_homes","summary":"comparable_homes","tags":["Property Info - Specific"],"parameters":[{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"Enter ZPID.","example":"44471319"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"example":"https://www.zillow.com/homedetails/415-South-St-APT-202-Honolulu-HI-96813/2089316022_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"description":"#### Use any of the three options above, `(ZPID/URL/Address)`\n","example":"1221 Victoria St APT 301, Honolulu, HI 96814"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get comparable homes nearby a property by zpid/address/url."}},"/rental_market":{"get":{"operationId":"get_rental_market","summary":"rental_market_trends","tags":["Market Analytics"],"parameters":[{"name":"search_query","in":"query","required":true,"schema":{"type":"string"},"description":"Search by `City or Zip`","example":"Austin, TX"},{"name":"bedrooom_type","in":"query","required":false,"schema":{"type":"string","enum":["All_Bedrooms","Studio","1_Bedroom","2_Bedroom","3_Bedroom","4_Bedroom_Plus"]},"description":"Select any bedroom types you want to use as a filter."},{"name":"home_type","in":"query","required":false,"schema":{"type":"string","enum":["All_Property_Types","Houses","Apartments_and_Condos","Townhomes"]},"description":"Select any home types you want to use as a filter."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get rental market trends for any city/zip."}},"/agent/details":{"get":{"operationId":"get_agent_details","summary":"agent/details","tags":["Find an Agent"],"parameters":[{"name":"agent_link","in":"query","required":false,"schema":{"type":"string"},"description":"Enter agent's Zillow page URL","example":"https://www.zillow.com/profile/Alex-Antigua"},{"name":"username","in":"query","required":false,"schema":{"type":"string"},"description":"Enter an agent username. If given both agent_link and username, it will take agent_link as first priority.","example":"Alex-Antigua"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get Zillow agent details."}},"/skip/detailsbyid":{"get":{"operationId":"get_skip_detailsbyid","summary":"skip_trace/details_by_id","tags":["Skip Tracing"],"parameters":[{"name":"peo_id","in":"query","required":true,"schema":{"type":"string"},"description":"To get phone numbers and emails, please enter the `Person ID` found from the `/skip_trace/byaddress` endpoint above.\n\nEx.:  `px860662uu9n6u8r04888 `\n\n### **Important:**\n- Skip tracing endpoints costs `6 requests/call`.\n- **For more requests and endpoints, use this API**: https://rapidapi.com/oneapiproject/api/skip-tracing-working-api","example":"px860662uu9n6u8r04888"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get all personal details from ID. Get phone, email, associates, relatives, address details and more!"}},"/pro/byurl":{"get":{"operationId":"get_pro_byurl","summary":"By Zillow URL","tags":["Property Info - Advanced ⭐️"],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string"},"description":"For URLs with ZPIDs only. If it's an `apartment` (**the URL contains /b/ or /apartment/**), please use this endpoint instead: [Apartment Details Endpoint](https://realtyapi.io/dashboard?tab=playground&api=zillow&endpoint=apartmentdetails)\n","example":"https://www.zillow.com/homedetails/2762-Downing-St-Jacksonville-FL-32205/44471319_zpid/"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get details by a Zillow URL."}},"/byurl":{"get":{"operationId":"get_byurl","summary":"By Zillow URL","tags":["Property Info - Minimal"],"parameters":[{"name":"url","in":"query","required":false,"schema":{"type":"string"},"description":"For URLs with ZPIDs only. If it's an `apartment` (**the URL contains /b/ or /apartment/**), please use this endpoint instead: [Apartment Details Endpoint](https://realtyapi.io/dashboard?tab=playground&api=zillow&endpoint=apartmentdetails)\n","example":"https://www.zillow.com/homedetails/2762-Downing-St-Jacksonville-FL-32205/44471319_zpid/"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Put any property url from Zillow to get details.\nMinimalistic and trimmed version of the /pro/byurl endpoint for easier navigation."}},"/search/byurl":{"get":{"operationId":"get_search_byurl","summary":"search/byurl","tags":["Search Zillow"],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string"},"example":"https://www.zillow.com/jacksonville-fl/?searchQueryState=%7B%22pagination%22%3A%7B%7D%2C%22usersSearchTerm%22%3A%22Jacksonville%20FL%22%2C%22mapBounds%22%3A%7B%22west%22%3A-82.183337765625%2C%22east%22%3A-81.194568234375%2C%22south%22%3A29.998610626520275%2C%22north%22%3A30.686008883991057%7D%2C%22regionSelection%22%3A%5B%7B%22regionId%22%3A25290%2C%22regionType%22%3A6%7D%5D%2C%22isMapVisible%22%3Atrue%2C%22filterState%22%3A%7B%22ah%22%3A%7B%22value%22%3Atrue%7D%2C%22sort%22%3A%7B%22value%22%3A%22days%22%7D%2C%22open%22%3A%7B%22value%22%3Atrue%7D%7D%2C%22isListVisible%22%3Atrue%7D"},{"name":"page","in":"query","required":true,"schema":{"type":"number"},"example":1}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search Zillow, use any filters. Then copy the url, and put it here to get data."}},"/similar":{"get":{"operationId":"get_similar","summary":"similar_properties","tags":["Property Info - Specific"],"parameters":[{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"Enter ZPID.","example":"44471319"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"example":"https://www.zillow.com/homedetails/415-South-St-APT-202-Honolulu-HI-96813/2089316022_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"description":" ","example":"1221 Victoria St APT 301, Honolulu, HI 96814"},{"name":"bylotid","in":"query","required":false,"schema":{"type":"string"},"description":"#### Use any of the Four options above, `(byZPID/byURL/byAddress/byLotID)`\n\n- Lotids are for apartments and buildings. For most of the properties, a ZPID is used. You can get these from search endpoints.\n- Use any of the four options available. If you keep all four, the API will take input in this order (first priority to last) : zpid>url>address>lotid","example":"1001422618"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get similar homes/properties by zpid/address/url/lotid."}},"/agent/for_sale":{"get":{"operationId":"get_agent_for_sale","summary":"agent/forSaleProperties","tags":["Find an Agent"],"parameters":[{"name":"encodedZuid","in":"query","required":true,"schema":{"type":"string"},"description":"You can find `encodedZuid` from the /agent/search endpoint.","example":"X1-ZU10bs62tnoyy2x_5dugv"},{"name":"page","in":"query","required":false,"schema":{"type":"string"},"description":"Use pagination if total # of results are more than presented.","example":"1"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get agent's for-sale properties."}},"/search/bymls":{"get":{"operationId":"get_search_bymls","summary":"search/bymls","tags":["Search Zillow"],"parameters":[{"name":"mlsid","in":"query","required":true,"schema":{"type":"string"},"description":"Enter an MLS ID (ex. S1710866)","example":"S1710866"},{"name":"listingStatus","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]}},{"name":"homeType","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n1. Possible values when **`listingStatus` = `For_Rent`**: \n- `Houses, Apartments/Condos/Co-ops, Townhomes`\n2. Possible values when **`listingStatus` = `For_Sale` or `Sold`**: \n- `Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured`\n","example":"Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured"},{"name":"listingType","in":"query","required":false,"schema":{"type":"string","enum":["By_Agent","By_Owner_and_Other"]},"description":"Only used for **listingStatus**: `For_Sale`.  Default: **By_Agent**"},{"name":"listingTypeOptions","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for **listingStatus**: `For_Sale`. For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n1. Possible values when **`listingType` = `By_Agent`**: \n- `Agent listed, New Construction, Fore-closures, Auctions, Foreclosed, Pre-foreclosures`\n2. Possible values when **`listingType` = `By_Owner_and_Other`**: \n- `Owner Posted, Agent listed, New Construction, Fore-closures, Auctions, Foreclosed, Pre-foreclosures`","example":"Agent listed,New Construction,Fore-closures,Auctions"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"MLS Search Endpoint on Zillow."}},"/nearby":{"get":{"operationId":"get_nearby","summary":"nearby_properties","tags":["Property Info - Specific"],"parameters":[{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"Enter ZPID.","example":"44471319"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"example":"https://www.zillow.com/homedetails/415-South-St-APT-202-Honolulu-HI-96813/2089316022_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"description":" ","example":"1221 Victoria St APT 301, Honolulu, HI 96814"},{"name":"bylotid","in":"query","required":false,"schema":{"type":"string"},"description":"#### Use any of the Four options above, `(byZPID/byURL/byAddress/byLotID)`\n\n- Lotids are for apartments and buildings. For most of the properties, a ZPID is used. You can get these from search endpoints.\n- Use any of the four options available. If you keep all four, the API will take input in this order (first priority to last) : zpid>url>address>lotid","example":"1001422618"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get nearby properties of a property by zpid/address/url/lotid."}},"/agent/for_rent":{"get":{"operationId":"get_agent_for_rent","summary":"agent/forRentProperties","tags":["Find an Agent"],"parameters":[{"name":"encodedZuid","in":"query","required":true,"schema":{"type":"string"},"description":"You can find `encodedZuid` from the /agent/search endpoint.","example":"X1-ZU10bs62tnoyy2x_5dugv"},{"name":"page","in":"query","required":false,"schema":{"type":"string"},"description":"Use pagination if total # of results are more than presented.","example":"1"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get agent's for-rent properties."}},"/search/bypolygon":{"get":{"operationId":"get_search_bypolygon","summary":"search/bypolygon","tags":["Search Zillow"],"parameters":[{"name":"polygon","in":"query","required":true,"schema":{"type":"string"},"description":"Enter polygon ordinates:","example":"40.855234480429694 -74.17845832952554, 40.855234480429694 -74.19555443455033, 40.839398873832685 -74.24344650496268, 40.80972482702799 -74.28449657022708, 40.78908363119005 -74.296929020874, 40.77047722402841 -74.29867566132631, 40.758686571326656 -74.29488731066652, 40.74457283221658 -74.27932595196283, 40.7208001408447 -74.24336135180303, 40.69433436537408 -74.17940690332038, 40.68872311180734 -74.15785903804887, 40.68534441906408 -74.11065612092496, 40.688994903106064 -74.08725269587569, 40.6996418749718 -74.06332250180179, 40.736494491243455 -74.01404222522173, 40.75810156036361 -73.99800162982523, 40.780478366299285 -73.9884228226182, 40.81917604658057 -73.98606029895414, 40.835810580257295 -73.99136755778092, 40.85944179559576 -74.01440264299832, 40.867487214707964 -74.02566670962027, 40.875048003689685 -74.04705615165555, 40.87701705179268 -74.08824087399046, 40.870109405210556 -74.12233010923437, 40.84829460307693 -74.15796597388221, 40.85470124757849 -74.17896529341184"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"Zillow provides `1000` results on each search. This endpoint returns `200` results per call. So the maximum page number could be `5`. \n\n- `To collect all the data`:  Narrow down your search into smaller areas. (Search by zip code, Set different listPriceRange, try different homeTypes)","example":1},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Homes_for_you","Rental_Priority_Score","Price_High_to_Low","Price_Low_to_High","Newest","Bedrooms","Bathrooms","Square_Feet","Lot_Size","Year_Built"]},"description":"Select how you want to sort your search results. \n- Defaults:\n- For Sale : `Homes_for_you`\n- For Rent : `Rental_Priority_Score`\n- Sold : `Newest`"},{"name":"listingStatus","in":"query","required":true,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"Select which type of property data you want to find. "},{"name":"listPriceRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Price:  `min:5000`\n- For Maximum Price:  `max:500000`\n- For a Price Range:  `min:5000, max:500000`"},{"name":"monthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for **listingStatus**: `For_Sale`. \n**Possible Inputs:**\n- For Minimum Payment:  `min:5000`\n- For Maximum Payment:  `max:50000`\n- For a Payment Range:  `min:5000, max:50000`"},{"name":"downPayment","in":"query","required":false,"schema":{"type":"number"},"description":"Only used for **listingStatus**: `For_Sale`. Input a down payment (dollars). Example: `15000`. For *No Down Payment*,  do not input anything."},{"name":"bed_min","in":"query","required":false,"schema":{"type":"string","enum":["No_Min","Studio","1","2","3","4","5"]},"description":"Input the minimum number of bedrooms that should be present on the listings. For an **exact match**, use bed_min and bed_max equal. For example, to see properties with 3 bedrooms: `bed_min=3, bed_max=3`"},{"name":"bed_max","in":"query","required":false,"schema":{"type":"string","enum":["No_Max","Studio","1","2","3","4","5"]},"description":"Input the maximum number of bedrooms that could be present on the listings. "},{"name":"bathrooms","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","OneHalfPlus","TwoPlus","ThreePlus","FourPlus"]},"description":"Input Mapping Explanation:\n`Any` → Any\n`OnePlus` → 1+\n`OneHalfPlus` → 1.5+\n`TwoPlus` →  2+\n`ThreePlus` → 3+\n`FourPlus` →  4+"},{"name":"homeType","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n1. Possible values when **`listingStatus` = `For_Rent`**: \n- `Houses, Apartments/Condos/Co-ops, Townhomes`\n2. Possible values when **`listingStatus` = `For_Sale` or `Sold`**: \n- `Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured`\n","example":"Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured"},{"name":"space","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will `NOT` select any types.\n\n- Only used for `listingStatus` = `For_Rent`\n- Possible values: `Entire Place, Room`"},{"name":"maxHOA","in":"query","required":false,"schema":{"type":"string","enum":["Any","No_HOA_Fee","50_dollars_month","100_dollars_month","200_dollars_month","300_dollars_month","400_dollars_month","500_dollars_month","600_dollars_month","700_dollars_month","800_dollars_month","900_dollars_month","1000_dollars_month"]},"description":"Only used for **listingStatus**: `For_Sale` or `Sold`."},{"name":"incIncompleteHOA","in":"query","required":false,"schema":{"type":"boolean"},"description":"Include homes with incomplete HOA data. Only used for **listingStatus**: `For_Sale` or `Sold`."},{"name":"listingType","in":"query","required":false,"schema":{"type":"string","enum":["By_Agent","By_Owner_and_Other"]},"description":"Only used for **listingStatus**: `For_Sale`.  Default: **By_Agent**"},{"name":"listingTypeOptions","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for **listingStatus**: `For_Sale`. For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n1. Possible values when **`listingType` = `By_Agent`**: \n- `Agent listed, New Construction, Fore-closures, Auctions, Foreclosed, Pre-foreclosures`\n2. Possible values when **`listingType` = `By_Owner_and_Other`**: \n- `Owner Posted, Agent listed, New Construction, Fore-closures, Auctions, Foreclosed, Pre-foreclosures`","example":"Agent listed,New Construction,Fore-closures,Auctions"},{"name":"propertyStatus","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n- Only used for `listingStatus` = `For_Sale`\n- Possible values: `Coming soon, Accepting backup offers, Pending & under contract`"},{"name":"tours","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n1. Possible values when **`listingStatus` = `For_Rent`**: \n- `Must have 3D Tour`\n2. Possible values when **`listingStatus` = `For_Sale`**: \n- `Must have open house, Must have 3D Tour`\n"},{"name":"parkingSpots","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","TwoPlus","ThreePlus","FourPlus"]},"description":"- Only used for `listingStatus` = `For_Sale` or `Sold`\n- Where:  `Any` → Any\n`OnePlus` → 1+\n`TwoPlus` →  2+\n`ThreePlus` → 3+\n`FourPlus` →  4+"},{"name":"haveGarage","in":"query","required":false,"schema":{"type":"boolean"},"description":"- Only used for `listingStatus` = `For_Sale` or `Sold`\n"},{"name":"move_in_date","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for `listingStatus` = `For_Rent`"},{"name":"hideNoDateListings","in":"query","required":false,"schema":{"type":"boolean"},"description":"Hide listings with no move-in date provided. Only used: `For_Rent`"},{"name":"squareFeetRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Square Feet:  `min:500`\n- For Maximum Square Feet:  `max:5000`\n- For a Square Feet Range:  `min:500, max:5000`"},{"name":"lotSizeRange","in":"query","required":false,"schema":{"type":"string"},"description":"Values should be in **square feet**.  For acre-sqft calculation: `1 acre` = `43560 sqft`\n\n1. **Possible Inputs:**\n- For Minimum Lot Size:  `min:1000`\n- For Maximum Lot Size:  `max:7500`\n- For a Lot Size Range:  `min:1000, max:7500`"},{"name":"yearBuiltRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Year Built:  `min:2011`\n- For Maximum Year Built:  `max:2024`\n- For a Year Built Range:  `min:2011, max:2024`"},{"name":"mustHaveBasement","in":"query","required":false,"schema":{"type":"string","enum":["No","Yes_Finished","Yes_Unfinished","Yes_Both"]}},{"name":"singleStoryOnly","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hide55plusComm","in":"query","required":false,"schema":{"type":"boolean"},"description":"Senior Living: Hide 55+ communities\n- Only used for `listingStatus` = `For_Sale` or `Sold`\n"},{"name":"pets","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma.\n\n- Only used for `listingStatus` = `For_Rent`\n- Possible values: `Allow large dogs, Allow small dogs, Allow cats`"},{"name":"soldInLast","in":"query","required":false,"schema":{"type":"string","enum":["Any","1_day","7_days","14_days","30_days","90_days","6_months","12_months","24_months","36_months"]},"description":"- Only used for `listingStatus` = `Sold`"},{"name":"otherAmenities","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n1. Possible values when **`listingStatus` = `For_Sale` or `Sold`**: \n- `Must have A/C, Must have pool, Waterfront`\n2. Possible values when **`listingStatus` =   `For_Rent`**: \n- `Must have A/C, Must have pool, Waterfront, On-site Parking, In-unit Laundry, Accepts Zillow Applications, Income Restricted, Apartment Community`\n"},{"name":"view","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n- Possible values: `City, Mountain, Park, Water`"},{"name":"daysOnZillow","in":"query","required":false,"schema":{"type":"string","enum":["Any","1_day","7_days","14_days","30_days","90_days","6_months","12_months","24_months","36_months"]},"description":"- Only used for `listingStatus` = `For_Sale` or `Rent`"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"MLS #, yard, fireplace, horses, etc"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search on Zillow by polygon input."}},"/climate":{"get":{"operationId":"get_climate","summary":"climate","tags":["Property Info - Specific"],"parameters":[{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"Enter ZPID.","example":"245422059"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"example":"https://www.zillow.com/homedetails/84-55-Daniels-St-APT-6E-Jamaica-NY-11435/245422059_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"description":"#### Use any of the three options above, `(byZPID/byURL/byAddress)`\n\n- For most of the properties, a ZPID is used. You can get these from search endpoints.\n- Use any of the three options available. If you keep all three, the API will take input in this order (first priority to last): zpid>url>address","example":"8455 Daniels Street #6E, Briarwood, NY 11435"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get owner information of a property by zpid/address/url."}},"/agent/sold_properties":{"get":{"operationId":"get_agent_sold_properties","summary":"agent/soldProperties","tags":["Find an Agent"],"parameters":[{"name":"encodedZuid","in":"query","required":true,"schema":{"type":"string"},"description":"You can find `encodedZuid` from the /agent/search endpoint.","example":"X1-ZU10bs62tnoyy2x_5dugv"},{"name":"page","in":"query","required":false,"schema":{"type":"string"},"description":"Use pagination if total # of results are more than presented.","example":"1"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get agent's previously sold properties."}},"/search/bycoordinates":{"get":{"operationId":"get_search_bycoordinates","summary":"search/bycoordinates","tags":["Search Zillow"],"parameters":[{"name":"latitude","in":"query","required":true,"schema":{"type":"string"},"description":"Enter latitude, longitude, and radius to make a `circle search.`","example":"40.599283"},{"name":"longitude","in":"query","required":true,"schema":{"type":"string"},"example":"-74.129194"},{"name":"radius","in":"query","required":true,"schema":{"type":"string"},"example":"0.5"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"Zillow provides `1000` results on each search. This endpoint returns `200` results per call. So the maximum page number could be `5`. \n\n- `To collect all the data`:  Narrow down your search into smaller areas. (Search by zip code, Set different listPriceRange, try different homeTypes)","example":1},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Homes_for_you","Rental_Priority_Score","Price_High_to_Low","Price_Low_to_High","Newest","Bedrooms","Bathrooms","Square_Feet","Lot_Size","Year_Built"]},"description":"Select how you want to sort your search results. \n- Defaults:\n- For Sale : `Homes_for_you`\n- For Rent : `Rental_Priority_Score`\n- Sold : `Newest`"},{"name":"listingStatus","in":"query","required":true,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"Select which type of property data you want to find. "},{"name":"listPriceRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Price:  `min:5000`\n- For Maximum Price:  `max:500000`\n- For a Price Range:  `min:5000, max:500000`"},{"name":"monthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for **listingStatus**: `For_Sale`. \n**Possible Inputs:**\n- For Minimum Payment:  `min:5000`\n- For Maximum Payment:  `max:50000`\n- For a Payment Range:  `min:5000, max:50000`"},{"name":"downPayment","in":"query","required":false,"schema":{"type":"number"},"description":"Only used for **listingStatus**: `For_Sale`. Input a down payment (dollars). Example: `15000`. For *No Down Payment*,  do not input anything."},{"name":"bed_min","in":"query","required":false,"schema":{"type":"string","enum":["No_Min","Studio","1","2","3","4","5"]},"description":"Input the minimum number of bedrooms that should be present on the listings. For an **exact match**, use bed_min and bed_max equal. For example, to see properties with 3 bedrooms: `bed_min=3, bed_max=3`"},{"name":"bed_max","in":"query","required":false,"schema":{"type":"string","enum":["No_Max","Studio","1","2","3","4","5"]},"description":"Input the maximum number of bedrooms that could be present on the listings. "},{"name":"bathrooms","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","OneHalfPlus","TwoPlus","ThreePlus","FourPlus"]},"description":"Input Mapping Explanation:\n`Any` → Any\n`OnePlus` → 1+\n`OneHalfPlus` → 1.5+\n`TwoPlus` →  2+\n`ThreePlus` → 3+\n`FourPlus` →  4+"},{"name":"homeType","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n1. Possible values when **`listingStatus` = `For_Rent`**: \n- `Houses, Apartments/Condos/Co-ops, Townhomes`\n2. Possible values when **`listingStatus` = `For_Sale` or `Sold`**: \n- `Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured`\n","example":"Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured"},{"name":"space","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will `NOT` select any types.\n\n- Only used for `listingStatus` = `For_Rent`\n- Possible values: `Entire Place, Room`"},{"name":"maxHOA","in":"query","required":false,"schema":{"type":"string","enum":["Any","No_HOA_Fee","50_dollars_month","100_dollars_month","200_dollars_month","300_dollars_month","400_dollars_month","500_dollars_month","600_dollars_month","700_dollars_month","800_dollars_month","900_dollars_month","1000_dollars_month"]},"description":"Only used for **listingStatus**: `For_Sale` or `Sold`."},{"name":"incIncompleteHOA","in":"query","required":false,"schema":{"type":"boolean"},"description":"Include homes with incomplete HOA data. Only used for **listingStatus**: `For_Sale` or `Sold`."},{"name":"listingType","in":"query","required":false,"schema":{"type":"string","enum":["By_Agent","By_Owner_and_Other"]},"description":"Only used for **listingStatus**: `For_Sale`.  Default: **By_Agent**"},{"name":"listingTypeOptions","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for **listingStatus**: `For_Sale`. For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n1. Possible values when **`listingType` = `By_Agent`**: \n- `Agent listed, New Construction, Fore-closures, Auctions, Foreclosed, Pre-foreclosures`\n2. Possible values when **`listingType` = `By_Owner_and_Other`**: \n- `Owner Posted, Agent listed, New Construction, Fore-closures, Auctions, Foreclosed, Pre-foreclosures`","example":"Agent listed,New Construction,Fore-closures,Auctions"},{"name":"propertyStatus","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n- Only used for `listingStatus` = `For_Sale`\n- Possible values: `Coming soon, Accepting backup offers, Pending & under contract`"},{"name":"tours","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n1. Possible values when **`listingStatus` = `For_Rent`**: \n- `Must have 3D Tour`\n2. Possible values when **`listingStatus` = `For_Sale`**: \n- `Must have open house, Must have 3D Tour`\n"},{"name":"parkingSpots","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","TwoPlus","ThreePlus","FourPlus"]},"description":"- Only used for `listingStatus` = `For_Sale` or `Sold`\n- Where:  `Any` → Any\n`OnePlus` → 1+\n`TwoPlus` →  2+\n`ThreePlus` → 3+\n`FourPlus` →  4+"},{"name":"haveGarage","in":"query","required":false,"schema":{"type":"boolean"},"description":"- Only used for `listingStatus` = `For_Sale` or `Sold`\n"},{"name":"move_in_date","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for `listingStatus` = `For_Rent`"},{"name":"hideNoDateListings","in":"query","required":false,"schema":{"type":"boolean"},"description":"Hide listings with no move-in date provided. Only used: `For_Rent`"},{"name":"squareFeetRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Square Feet:  `min:500`\n- For Maximum Square Feet:  `max:5000`\n- For a Square Feet Range:  `min:500, max:5000`"},{"name":"lotSizeRange","in":"query","required":false,"schema":{"type":"string"},"description":"Values should be in **square feet**.  For acre-sqft calculation: `1 acre` = `43560 sqft`\n\n1. **Possible Inputs:**\n- For Minimum Lot Size:  `min:1000`\n- For Maximum Lot Size:  `max:7500`\n- For a Lot Size Range:  `min:1000, max:7500`"},{"name":"yearBuiltRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Year Built:  `min:2011`\n- For Maximum Year Built:  `max:2024`\n- For a Year Built Range:  `min:2011, max:2024`"},{"name":"mustHaveBasement","in":"query","required":false,"schema":{"type":"string","enum":["No","Yes_Finished","Yes_Unfinished","Yes_Both"]}},{"name":"singleStoryOnly","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hide55plusComm","in":"query","required":false,"schema":{"type":"boolean"},"description":"Senior Living: Hide 55+ communities\n- Only used for `listingStatus` = `For_Sale` or `Sold`\n"},{"name":"pets","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma.\n\n- Only used for `listingStatus` = `For_Rent`\n- Possible values: `Allow large dogs, Allow small dogs, Allow cats`"},{"name":"otherAmenities","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n1. Possible values when **`listingStatus` = `For_Sale` or `Sold`**: \n- `Must have A/C, Must have pool, Waterfront`\n2. Possible values when **`listingStatus` =   `For_Rent`**: \n- `Must have A/C, Must have pool, Waterfront, On-site Parking, In-unit Laundry, Accepts Zillow Applications, Income Restricted, Apartment Community`\n"},{"name":"view","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n- Possible values: `City, Mountain, Park, Water`"},{"name":"daysOnZillow","in":"query","required":false,"schema":{"type":"string","enum":["Any","1_day","7_days","14_days","30_days","90_days","6_months","12_months","24_months","36_months"]},"description":"- Only used for `listingStatus` = `For_Sale` or `Rent`"},{"name":"soldInLast","in":"query","required":false,"schema":{"type":"string","enum":["Any","1_day","7_days","14_days","30_days","90_days","6_months","12_months","24_months","36_months"]},"description":"- Only used for `listingStatus` = `Sold`"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"MLS #, yard, fireplace, horses, etc"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search on Zillow by coordinates input."}},"/propimages":{"get":{"operationId":"get_propimages","summary":"property_images","tags":["Property Info - Specific"],"parameters":[{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"Enter ZPID.","example":"44472566"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"example":"https://www.zillow.com/homedetails/415-South-St-APT-202-Honolulu-HI-96813/2089316022_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"description":"#### Use any of the three options above, `(ZPID/URL/Address)`\n","example":"1221 Victoria St APT 301, Honolulu, HI 96814"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get all the images of any property by ZPID/address/URL."}},"/agent/reviews":{"get":{"operationId":"get_agent_reviews","summary":"agent/reviews","tags":["Find an Agent"],"parameters":[{"name":"encodedZuid","in":"query","required":true,"schema":{"type":"string"},"description":"You can find `encodedZuid` from the /agent/search endpoint.","example":"X1-ZU10bs62tnoyy2x_5dugv"},{"name":"page","in":"query","required":false,"schema":{"type":"string"},"description":"Use pagination if total # of results are more than presented.","example":"1"},{"name":"sortby","in":"query","required":false,"schema":{"type":"string","enum":["newest_first","rating_high_to_low","rating_low_to_high"]}}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get Zillow agent reviews.."}},"/search/bymapbounds":{"get":{"operationId":"get_search_bymapbounds","summary":"search/bymapbounds","tags":["Search Zillow"],"parameters":[{"name":"eastLongitude","in":"query","required":true,"schema":{"type":"string"},"example":"-81.3709966319857"},{"name":"northLatitude","in":"query","required":true,"schema":{"type":"string"},"example":"28.545572508476443"},{"name":"southLatitude","in":"query","required":true,"schema":{"type":"string"},"example":"28.53109949152356"},{"name":"westLongitude","in":"query","required":true,"schema":{"type":"string"},"example":"-81.38747136801429"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"Zillow provides `1000` results on each search. This endpoint returns `200` results per call. So the maximum page number could be `5`. \n\n- `To collect all the data`:  Narrow down your search into smaller areas. (Search by zip code, Set different listPriceRange, try different homeTypes)","example":1},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Homes_for_you","Rental_Priority_Score","Price_High_to_Low","Price_Low_to_High","Newest","Bedrooms","Bathrooms","Square_Feet","Lot_Size","Year_Built"]},"description":"Select how you want to sort your search results. \n- Defaults:\n- For Sale : `Homes_for_you`\n- For Rent : `Rental_Priority_Score`\n- Sold : `Newest`"},{"name":"listingStatus","in":"query","required":true,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"Select which type of property data you want to find. "},{"name":"listPriceRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Price:  `min:5000`\n- For Maximum Price:  `max:500000`\n- For a Price Range:  `min:5000, max:500000`"},{"name":"monthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for **listingStatus**: `For_Sale`. \n**Possible Inputs:**\n- For Minimum Payment:  `min:5000`\n- For Maximum Payment:  `max:50000`\n- For a Payment Range:  `min:5000, max:50000`"},{"name":"downPayment","in":"query","required":false,"schema":{"type":"number"},"description":"Only used for **listingStatus**: `For_Sale`. Input a down payment (dollars). Example: `15000`. For *No Down Payment*,  do not input anything."},{"name":"bed_min","in":"query","required":false,"schema":{"type":"string","enum":["No_Min","Studio","1","2","3","4","5"]},"description":"Input the minimum number of bedrooms that should be present on the listings. For an **exact match**, use bed_min and bed_max equal. For example, to see properties with 3 bedrooms: `bed_min=3, bed_max=3`"},{"name":"bed_max","in":"query","required":false,"schema":{"type":"string","enum":["No_Max","Studio","1","2","3","4","5"]},"description":"Input the maximum number of bedrooms that could be present on the listings. "},{"name":"bathrooms","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","OneHalfPlus","TwoPlus","ThreePlus","FourPlus"]},"description":"Input Mapping Explanation:\n`Any` → Any\n`OnePlus` → 1+\n`OneHalfPlus` → 1.5+\n`TwoPlus` →  2+\n`ThreePlus` → 3+\n`FourPlus` →  4+"},{"name":"homeType","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n1. Possible values when **`listingStatus` = `For_Rent`**: \n- `Houses, Apartments/Condos/Co-ops, Townhomes`\n2. Possible values when **`listingStatus` = `For_Sale` or `Sold`**: \n- `Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured`\n","example":"Houses, Townhomes, Multi-family, Condos/Co-ops, Lots-Land, Apartments, Manufactured"},{"name":"space","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will `NOT` select any types.\n\n- Only used for `listingStatus` = `For_Rent`\n- Possible values: `Entire Place, Room`"},{"name":"maxHOA","in":"query","required":false,"schema":{"type":"string","enum":["Any","No_HOA_Fee","50_dollars_month","100_dollars_month","200_dollars_month","300_dollars_month","400_dollars_month","500_dollars_month","600_dollars_month","700_dollars_month","800_dollars_month","900_dollars_month","1000_dollars_month"]},"description":"Only used for **listingStatus**: `For_Sale` or `Sold`."},{"name":"incIncompleteHOA","in":"query","required":false,"schema":{"type":"boolean"},"description":"Include homes with incomplete HOA data. Only used for **listingStatus**: `For_Sale` or `Sold`."},{"name":"listingTypeOptions","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for **listingStatus**: `For_Sale`. For multiple inputs, separate them with a comma or keep it empty for all types selected.\n\n1. Possible values when **`listingType` = `By_Agent`**: \n- `Agent listed, New Construction, Fore-closures, Auctions, Foreclosed, Pre-foreclosures`\n2. Possible values when **`listingType` = `By_Owner_and_Other`**: \n- `Owner Posted, Agent listed, New Construction, Fore-closures, Auctions, Foreclosed, Pre-foreclosures`","example":"Agent listed,New Construction,Fore-closures,Auctions"},{"name":"propertyStatus","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n- Only used for `listingStatus` = `For_Sale`\n- Possible values: `Coming soon, Accepting backup offers, Pending & under contract`"},{"name":"tours","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n1. Possible values when **`listingStatus` = `For_Rent`**: \n- `Must have 3D Tour`\n2. Possible values when **`listingStatus` = `For_Sale`**: \n- `Must have open house, Must have 3D Tour`\n"},{"name":"parkingSpots","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","TwoPlus","ThreePlus","FourPlus"]},"description":"- Only used for `listingStatus` = `For_Sale` or `Sold`\n- Where:  `Any` → Any\n`OnePlus` → 1+\n`TwoPlus` →  2+\n`ThreePlus` → 3+\n`FourPlus` →  4+"},{"name":"move_in_date","in":"query","required":false,"schema":{"type":"string"},"description":"Only used for `listingStatus` = `For_Rent`"},{"name":"hideNoDateListings","in":"query","required":false,"schema":{"type":"boolean"},"description":"Hide listings with no move-in date provided. Only used: `For_Rent`"},{"name":"squareFeetRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Square Feet:  `min:500`\n- For Maximum Square Feet:  `max:5000`\n- For a Square Feet Range:  `min:500, max:5000`"},{"name":"lotSizeRange","in":"query","required":false,"schema":{"type":"string"},"description":"Values should be in **square feet**.  For acre-sqft calculation: `1 acre` = `43560 sqft`\n\n1. **Possible Inputs:**\n- For Minimum Lot Size:  `min:1000`\n- For Maximum Lot Size:  `max:7500`\n- For a Lot Size Range:  `min:1000, max:7500`"},{"name":"yearBuiltRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs:**\n- For Minimum Year Built:  `min:2011`\n- For Maximum Year Built:  `max:2024`\n- For a Year Built Range:  `min:2011, max:2024`"},{"name":"mustHaveBasement","in":"query","required":false,"schema":{"type":"string","enum":["No","Yes_Finished","Yes_Unfinished","Yes_Both"]}},{"name":"singleStoryOnly","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hide55plusComm","in":"query","required":false,"schema":{"type":"boolean"},"description":"Senior Living: Hide 55+ communities\n- Only used for `listingStatus` = `For_Sale` or `Sold`\n"},{"name":"otherAmenities","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n1. Possible values when **`listingStatus` = `For_Sale` or `Sold`**: \n- `Must have A/C, Must have pool, Waterfront`\n2. Possible values when **`listingStatus` =   `For_Rent`**: \n- `Must have A/C, Must have pool, Waterfront, On-site Parking, In-unit Laundry, Accepts Zillow Applications, Income Restricted, Apartment Community`\n"},{"name":"view","in":"query","required":false,"schema":{"type":"string"},"description":"For multiple inputs, separate them with a comma. Keeping it empty will **NOT** select any types.\n\n- Possible values: `City, Mountain, Park, Water`"},{"name":"daysOnZillow","in":"query","required":false,"schema":{"type":"string","enum":["Any","1_day","7_days","14_days","30_days","90_days","6_months","12_months","24_months","36_months"]},"description":"- Only used for `listingStatus` = `For_Sale` or `Rent`"},{"name":"soldInLast","in":"query","required":false,"schema":{"type":"string","enum":["Any","1_day","7_days","14_days","30_days","90_days","6_months","12_months","24_months","36_months"]},"description":"- Only used for `listingStatus` = `Sold`"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"MLS #, yard, fireplace, horses, etc"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search on Zillow by mapbounds input."}},"/pricehistory":{"get":{"operationId":"get_pricehistory","summary":"pricehistory","tags":["Property Info - Specific"],"parameters":[{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"Input the zpid of a property","example":"44466838"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"description":"Input the URL of a property","example":"https://www.zillow.com/homedetails/3-W-Forest-Dr-Rochester-NY-14624/30907787_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"description":"Input the `Address` of a property","example":"3 W Forest Dr, Rochester, NY 14624"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Gives you Price History information by zpid/url/address.\n\nIf you provide all three parameters, params accept order will be:\nZPID > URL > ADDRESS"}},"/search/byaiprompt":{"get":{"operationId":"get_search_byaiprompt","summary":"search/by-ai-prompt","tags":["Search Zillow"],"parameters":[{"name":"ai_search_prompt","in":"query","required":true,"schema":{"type":"string"},"description":"**This endpoint isn't as accurate as the other search endpoints at identifying filters. If you want accuracy, it's recommended to use the other search endpoints.**\n\nExample search prompts:\n-  `2+ bedroom homes for sale in New York City NY with 2+ bathrooms`\n-  `Homes for sale in Alamo City $150k to $250k and posted in last 6 months`\n-  `Austin TX sold homes with 2+ bedrooms, has basement, city view, 1000 sqft, built after 2000`","example":"2 bedroom homes for sale in new york"},{"name":"page","in":"query","required":false,"schema":{"type":"string"},"example":"1"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Homes_for_you","Rental_Priority_Score","Price_High_to_Low","Price_Low_to_High","Newest","Bedrooms","Bathrooms","Square_Feet","Lot_Size","Year_Built"]}},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"Enter different keywords like `MLS #, yard, agent etc.`"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Yes, you can describe the filters you want to use. Zillow's built-in search."}},"/taxinfo":{"get":{"operationId":"get_taxinfo","summary":"taxinfo_history","tags":["Property Info - Specific"],"parameters":[{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"Input the zpid of a property","example":"44466838"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"description":"Input the URL of a property","example":"https://www.zillow.com/homedetails/3-W-Forest-Dr-Rochester-NY-14624/30907787_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"description":"Input the `Address` of a property","example":"3 W Forest Dr, Rochester, NY 14624"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Gives you property tax information by zpid/url/address..\n\nIf you provide all three parameters, params access order will be:\nZPID > URL > ADDRESS"}},"/walk_transit_bike":{"get":{"operationId":"get_walk_transit_bike","summary":"walk_transit_bike","tags":["Property Info - Specific"],"parameters":[{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"Input the zpid of a property","example":"44466838"},{"name":"byurl","in":"query","required":false,"schema":{"type":"string"},"description":"Input the URL of a property","example":"https://www.zillow.com/homedetails/3-W-Forest-Dr-Rochester-NY-14624/30907787_zpid/"},{"name":"byaddress","in":"query","required":false,"schema":{"type":"string"},"description":"Input the `Address` of a property","example":"3 W Forest Dr, Rochester, NY 14624"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Gives you Walk-Transit-Bike Scores by zpid/url/address..\n\nIf you provide all three parameters, params access order will be:\nZPID > URL > ADDRESS"}},"/search/offmarket":{"get":{"operationId":"get_search_offmarket","summary":"search/offmarket","tags":["Search Zillow"],"parameters":[{"name":"zipCode","in":"query","required":false,"schema":{"type":"string"},"description":"Zip code to sweep (the whole zip). Send this OR latitude + longitude.","example":"90210"},{"name":"latitude","in":"query","required":false,"schema":{"type":"number"},"description":"Centre latitude of a circle search. Use with `longitude` (+ optional `radius`). Takes precedence over `zipCode`.","example":43.6455},{"name":"longitude","in":"query","required":false,"schema":{"type":"number"},"description":"Centre longitude of a circle search.","example":-72.3085},{"name":"radius","in":"query","required":false,"schema":{"type":"number"},"description":"Radius in miles around `latitude`/`longitude`. Default `0.5`. Keep it small (0.25 to 1): Zillow thins off-market results for large areas, so small circles return far more homes.","example":0.5},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"Page number passed to Zillow. Default `1`. Zillow currently returns this search only for page 1 (later pages come back empty), so leave it at 1 and shrink the area instead.","example":1},{"name":"pageSize","in":"query","required":false,"schema":{"type":"number"},"description":"Homes per page requested from Zillow, `1` to `1000` (default `1000`). Counts listings and off-market homes together, before the off-market filter.","example":1000},{"name":"includePending","in":"query","required":false,"schema":{"type":"boolean"},"description":"`true` to also return homes with a pending sale.","example":false},{"name":"includeClosed","in":"query","required":false,"schema":{"type":"boolean"},"description":"`true` to also return homes that recently closed / sold.","example":false}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Off-market homes (not currently listed) with Zestimates inside a zip code or a lat/lng circle, so one call sweeps an area for valuations and comps. Send `zipCode`, or `latitude` + `longitude` + `radius` (miles, default `0.5`); the circle wins if both are sent. Zillow returns at most one page of `1000` homes (listings plus off-market) and thins off-market results for large areas, so a whole zip yields a few hundred homes while a 0.5 mi circle can return 700+. For complete coverage tile the area with small circles and de-duplicate on `zpid`. `page` and `pageSize` are passed to Zillow but only page 1 returns data; `pageResultCount` shows how many homes the page held before the off-market filter."}},"/lotid_from_address":{"get":{"operationId":"get_lotid_from_address","summary":"lotid_from_address","tags":["Property Info - Specific"],"parameters":[{"name":"propertyaddress","in":"query","required":true,"schema":{"type":"string"},"description":"Only `apartment and building` addresses will return with a lot ID. Other properties on Zillow use ZPID as an identifier. ","example":"131 Great Circle Rd, Nashville, TN 37228"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Find the lotID from the address. `Lotid is used for buildings and apartments.`"}},"/apartment_details":{"get":{"operationId":"get_apartment_details","summary":"apartment_details","tags":["Property Info - Specific"],"parameters":[{"name":"bylotid","in":"query","required":false,"schema":{"type":"string"},"description":"Enter a valid LotID. You can find it from the `/lotid_from_address` endpoint.","example":"1001422626"},{"name":"byapturl","in":"query","required":false,"schema":{"type":"string"},"description":"You can put the apartment URL directly to get details. Ex.:\n- `https://www.zillow.com/b/natiivo-austin-austin-tx-CjQbkL`\n- `https://www.zillow.com/apartments/nashville-tn/samara/9DsRgb`\n\n**You can use any of the two available options (bylotid/byapturl)**","example":"https://www.zillow.com/apartments/nashville-tn/parkwood-villa/5XhxdJ/"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get apartment/building details from the lot ID and URL."}},"/lotlines":{"get":{"operationId":"get_lotlines","summary":"lotlines","tags":["Property Info - Specific"],"parameters":[{"name":"lat","in":"query","required":false,"schema":{"type":"string"},"description":"Input Latitude found from property details.","example":"39.89637"},{"name":"lng","in":"query","required":false,"schema":{"type":"string"},"description":"Input Longitude found from property details.","example":"-75.373184"},{"name":"byzpid","in":"query","required":false,"schema":{"type":"string"},"description":"If you don't have long/lat value, use the byzpid parameter. ","example":"9415364"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get Lotlines of nearby area, for a property"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-realtyapi-key","description":"RealtyAPI key from your dashboard at https://www.realtyapi.io."}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"PaymentRequired":{"description":"No credits remaining on the API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}