# overview **Overview** Zillow Scraper is a really useful tool that helps you get information about houses and properties from Zillow, which is the biggest site for real estate listings in the world. Whether you want to buy a house, sell one, or just find out how much a property is worth, the Zillow API gives you lots of data right at your fingertips. It has cool features like property values, details about the houses, and even a mortgage calculator, which makes it easy to make smart choices. With the Zillow Scraper API, you can easily search for houses and check out listings directly from your own apps and websites. This is great for developers and people who love real estate, as it lets them use all the awesome data from Zillow in their projects. So, if you're into real estate, this API can be a really helpful resource to make your property adventures more successful in today's ever-changing market. **** ~~Test~~ - sideview ``` ``` **** # authentication **How to get API key** The Scrapeak API uses API keys to authenticate requests. You can view and manage your API keys in the [Scrapeak Dashboard](https://app.scrapeak.com/dashboard/settings). You need to sign up for any plan (including free starter plan) to get an API key. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. **** ~~Steps~~ - json ```- Log in or Register for the Scrapeak Dashboard. - Sign up for any plan, including the free starter plan. - Go to the settings page and copy your API key.``` **** # endpoints ## property Details **Property Details** `/property` `/property` API endpoint gives you all the important information you need to use our scraper effectively. This scraper is a strong tool that helps you easily get lots of details about properties. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `zpid` | zpid of property | Yes | Integer | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and ZPID of a property api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY property_zpid = "66288024" #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/zillow/property" params = {"api_key": api_key, "zpid": property_zpid} #/ Make the API request response = requests.get(api_url, params=params) response_content = response.text print(response_content)``` **** **** ~~*Response Example ~~ - json ```{ "is_success": true, "data": { "listingDataSource": "Phoenix", "zpid": 26914709, "city": "Dallas", "state": "TX", "homeStatus": "PENDING", "address": { "streetAddress": "8320 Mountainview Dr", "city": "Dallas", "state": "TX", "zipcode": "75249", "neighborhood": null, "community": null, "subdivision": null }, "isListingClaimedByCurrentSignedInUser": false, "isCurrentSignedInAgentResponsible": false, "bedrooms": 4, "bathrooms": 2, "price": 349000, "yearBuilt": 1988, "streetAddress": "8320 Mountainview Dr", "zipcode": "75249", "isCurrentSignedInUserVerifiedOwner": false, "regionString": "Dallas TX 75249", "propertyUpdatePageLink": null, "moveHomeMapLocationLink": null, "propertyEventLogLink": null, "editPropertyHistorylink": null, "isRentalListingOffMarket": false, "hdpUrl": "/homedetails/8320-Mountainview-Dr-Dallas-TX-75249/26914709_zpid/", "listing_sub_type": { "is_newHome": false, "is_FSBO": false, "is_FSBA": true, "is_foreclosure": false, "is_bankOwned": false, "is_forAuction": false, "is_comingSoon": false, "is_pending": true, "is_openHouse": false }, "nearbyCities": [...], "nearbyNeighborhoods": [...], "country": "USA", "nearbyZipcodes": [...], "citySearchUrl": { "text": "Homes in Dallas", "path": "/dallas-tx/" }, "zipcodeSearchUrl": { "path": "/dallas-tx-75249/" }, "apartmentsForRentInZipcodeSearchUrl": { "path": "/dallas-tx-75249/apartments/" }, "housesForRentInZipcodeSearchUrl": { "path": "/dallas-tx-75249/rent-houses/" }, "abbreviatedAddress": "8320 Mountainview Dr", "neighborhoodRegion": null, "building": null, "isUndisclosedAddress": false, "boroughId": null, "providerListingID": null, "neighborhoodSearchUrl": null, "stateSearchUrl": { "path": "/tx/" }, "countySearchUrl": { "text": "Homes in Dallas County", "path": "/dallas-county-tx/" }, "boroughSearchUrl": null, "communityUrl": null, "isPremierBuilder": false, "isZillowOwned": false, "homeType": "SINGLE_FAMILY", "adTargets": {...}, "currency": "USD", "resoFacts": {...}, "attributionInfo": { "listingAgreement": null, "mlsName": "NTREIS", "agentEmail": null, "agentLicenseNumber": "0469449", "agentName": "Lisa Speaks", "agentPhoneNumber": null, "attributionTitle": null, "brokerName": "Expressions Property", "brokerPhoneNumber": "214-498-2982", "buyerAgentMemberStateLicense": null, "buyerAgentName": null, "buyerBrokerageName": null, "coAgentLicenseNumber": null, "coAgentName": null, "coAgentNumber": null, "lastChecked": "2023-07-26 18:03:20", "lastUpdated": "2023-07-12 16:40:06", "listingOffices": [ { "associatedOfficeType": "listOffice", "officeName": "Expressions Property" } ], "listingAgents": [ { "associatedAgentType": "listAgent", "memberFullName": "Lisa Speaks", "memberStateLicense": "0469449" } ], "mlsDisclaimer": "IDX information is provided exclusively for personal, non-commercial use, and may not be used for any purpose other than to identify prospective properties consumers may be interested in purchasing. Information is deemed reliable but not guaranteed.\n\nThe listing broker’s offer of compensation is made only to participants of the MLS where the listing is filed. ", "mlsId": "20362413", "providerLogo": null, "infoString3": null, "infoString5": null, "infoString10": "IDX information is provided exclusively for personal, non-commercial use, and may not be used for any purpose other than to identify prospective properties consumers may be interested in purchasing. Information is deemed reliable but not guaranteed.\n\nThe listing broker’s offer of compensation is made only to participants of the MLS where the listing is filed. ", "infoString16": null, "trueStatus": null }, "listPriceLow": null, "homeRecommendations": { "blendedRecs": [], "displayShort": "" }, "livingArea": 2180, "livingAreaValue": 2180, "zestimate": 354700, "newConstructionType": null, "zestimateLowPercent": "5", "zestimateHighPercent": "5", "rentZestimate": 2400, "restimateLowPercent": "6", "restimateHighPercent": "7", "schools": [...], "homeValues": null, "parentRegion": { "name": "75249" }, "nearbyHomes": [...], "countyFIPS": "48113", "parcelId": "0086840D000050000", "taxHistory": [...], "priceHistory": [...], "comps": [...], "description": "In the middle of beauty--close to Cedar Ridge Preserve sits a 4 bedroom home just waiting for your buyers. Located in desired Mountain Creek on the edge of Dallas, Cedar Hill and Duncanville, this corner lot home boasts 4 good size bedrooms and 2 baths in a home that has been meticulously maintained. The 4th bedroom was used as an office. Fresh paint, recently remodeled bathroom and kitchen, new cooktop, and a new side fence and gate are just a few of the upgrades. The kitchen is bright and open with coffee bar, gas appliances and island that incorporates with the living room. 2 living areas, 2 dining, and a big backyard make functionality and enjoyment easy. The primary bedroom is large. Primary bathroom has dual sinks, separate shower, and a garden tub to melt the day away. Walking trails, hiking, 2 parks, an amazing library and nature are all just around the corner. Home is in the Duncanville School District and is close to everything in Dallas or Ft Worth for commuters.", "whatILove": null, "contingentListingType": null, "timeOnZillow": "26 days", "pageViewCount": 784, "favoriteCount": 84, "daysOnZillow": 26, "latitude": 32.64911, "longitude": -96.967224, "openHouseSchedule": [], "brokerageName": "Expressions Property", "timeZone": "America/Chicago", "listingMetadata": {...}, "pals": [], "listingAccountUserId": "X1-ZUzbu4x91mrpqh_aovt3", "homeInsights": [...], "sellingSoon": [ { "treatmentId": "model_0", "percentile": 0.98 } ], "listingProvider": null, "isIncomeRestricted": null, "brokerId": null, "ssid": 15, "monthlyHoaFee": 31, "mortgageRates": { "fifteenYearFixedRate": 5.735, "thirtyYearFixedRate": 6.52, "arm5Rate": 6.418 }, "propertyTaxRate": 1.72, "hdpTypeDimension": "Pending", "mlsid": "20362413", "propertyTypeDimension": "Single Family", "enhancedBrokerImageUrl": null, "tourEligibility": { "isPropertyTourEligible": false, "propertyTourOptions": { "isFinal": true, "tourAvailability": [], "tourType": "NONE" } }, "contactFormRenderData": {...}, "responsivePhotos": [...], "buildingId": null, "hasApprovedThirdPartyVirtualTourUrl": false, "photoCount": 33, "livingAreaUnits": "Square Feet", "lotSize": 8189, "lotAreaValue": 8189.28, "lotAreaUnits": "Square Feet", "postingProductType": "Standard", "marketingName": null, "richMedia": null, "cityId": 38128, "stateId": 54, "zipPlusFour": "3027", "numberOfUnitsTotal": null, "foreclosureDefaultFilingDate": null, "foreclosureAuctionFilingDate": null, "foreclosureLoanDate": null, "foreclosureLoanOriginator": null, "foreclosureLoanAmount": null, "foreclosurePriorSaleDate": null, "foreclosurePriorSaleAmount": null, "foreclosureBalanceReportingDate": null, "foreclosurePastDueBalance": null, "foreclosureUnpaidBalance": null, "foreclosureAuctionTime": null, "foreclosureAuctionDescription": null, "foreclosureAuctionCity": null, "foreclosureAuctionLocation": null, "foreclosureDate": null, "foreclosureAmount": null, "foreclosingBank": null, "foreclosureJudicialType": "Non-Judicial", "datePostedString": "2023-06-30", "foreclosureTypes": { "isBankOwned": false, "isForeclosedNFS": false, "isPreforeclosure": false, "isAnyForeclosure": false, "wasNonRetailAuction": false, "wasForeclosed": false, "wasREO": null, "wasDefault": null }, "foreclosureMoreInfo": null, "hasBadGeocode": false, "postingUrl": null, "hasPublicVideo": false, "primaryPublicVideo": null, "richMediaVideos": null, "photos": [...], "listingSubType": { "isFSBA": true, "isFSBO": false, "isPending": true, "isNewHome": false, "isForeclosure": false, "isBankOwned": false, "isForAuction": false, "isOpenHouse": false, "isComingSoon": false }, "tourViewCount": 0, "postingContact": { "name": "Lisa Speaks", "photo": null }, "vrModel": { "vrModelGuid": null, "revisionId": null }, "thirdPartyVirtualTour": { "lightboxUrl": null, "staticUrl": null, "providerKey": null, "approved": false }, "listingAccount": null, "listingFeedID": null, "livingAreaUnitsShort": "sqft", "priceChange": null, "priceChangeDate": null, "priceChangeDateString": null, "formattedChip": { "location": [ { "fullValue": "8320 Mountainview Dr" }, { "fullValue": "Dallas, TX 75249" } ] }, "hideZestimate": false, "comingSoonOnMarketDate": null, "isPreforeclosureAuction": false, "lastSoldPrice": null, "isHousingConnector": false, "responsivePhotosOriginalRatio": [...], "thumb": [...], "isRecentStatusChange": false, "isNonOwnerOccupied": false, "county": "Dallas County", "isFeatured": false, "rentalApplicationsAcceptedType": "REQUEST_TO_APPLY", "listingTypeDimension": "For Sale by Agent", "featuredListingTypeDimension": "organic", "brokerIdDimension": "For Sale by Agent", "keystoneHomeStatus": "Pending", "pageUrlFragment": "ForSale", "isRentalsLeadCapMet": false, "isPaidMultiFamilyBrokerId": false, "selfTour": { "hasSelfTour": false } }, "message": "Scraped successfully!" }``` **** ## listing **Search Listing** `/listing` The Listing API endpoint is a powerful tool that lets you get Zillow's property search listings easily. It helps you extract valuable data from Zillow's big property database without any hassle. Whether you want property details for research, comparison, or analysis, the Listing API endpoint can provide all the information you need. By adding this endpoint to your apps or websites, you can give your users direct access to property listings. It's a great way to improve your real estate projects. **This API endpoint has a limited number of data points for properties in the list.* | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `url` | The URL of the listing page with the 'searchQueryState' parameter. | Yes | String | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and listing URL api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY listing_url = "YOUR-LISTING-URL" # The URL of the listing page with the 'searchQueryState' parameter. #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/zillow/listing" parameters = {"api_key": api_key, "url": listing_url} #/ Make the API request response = requests.get(api_url, params=parameters) response_content = response.text print(response_content)``` **** **** ~~*Response Example~~ - json ```{ "is_success": true, "data": { "user": { "isLoggedIn": false, "email": "", "displayName": "", "hasHousingConnectorPermission": false, "savedHomesCount": 0, "personalizedSearchTraceID": "64c1ced5b48dbbdfb0f0c39efd8c24e8", "guid": "c9498dbb-bdaa-46d1-921c-9057f6332952", "zuid": "", "isBot": false, "userSpecializedSEORegion": false }, "mapState": { "customRegionPolygonWkt": null, "schoolPolygonWkt": null, "isCurrentLocationSearch": false, "userPosition": { "lat": null, "lon": null } }, "regionState": { "regionInfo": [ { "regionType": 6, "regionId": 182023, "regionName": "Henrico", "displayName": "Henrico VA", "isPointRegion": false } ], "regionBounds": { "north": 37.668539, "east": -77.197726, "south": 37.353506, "west": -77.740535 } }, "searchPageSeoObject": { "baseUrl": "/henrico-va/", "windowTitle": "Henrico VA Real Estate - Henrico VA Homes For Sale | Zillow", "metaDescription": "Zillow has 18 homes for sale in Henrico VA. View listing photos, review sales history, and use our detailed real estate filters to find the perfect place." }, "requestId": 9, "cat1": { "searchResults": { "listResults": [ { "zpid": "12355600", "id": "12355600", "providerListingId": null, "imgSrc": "https://photos.zillowstatic.com/fp/070f78f8485ab58d76e95f88d3a8d3dc-p_e.jpg", "hasImage": true, "carouselPhotos": [..], "detailUrl": "https://www.zillow.com/homedetails/112-Forest-Ave-Richmond-VA-23223/12355600_zpid/", "statusType": "FOR_SALE", "statusText": "House for sale", "countryCurrency": "$", "price": "$299,000", "unformattedPrice": 299000, "address": "112 Forest Ave, Richmond, VA 23223", "addressStreet": "112 Forest Ave", "addressCity": "Richmond", "addressState": "VA", "addressZipcode": "23223", "isUndisclosedAddress": false, "beds": 4, "baths": 2.0, "area": 2012, "latLong": { "latitude": 37.553795, "longitude": -77.34002 }, "isZillowOwned": false, "variableData": { "type": "3D_HOME", "text": "3D Tour" }, "badgeInfo": null, "hdpData": { "homeInfo": { "zpid": 12355600, "streetAddress": "112 Forest Ave", "zipcode": "23223", "city": "Richmond", "state": "VA", "latitude": 37.553795, "longitude": -77.34002, "price": 299000.0, "bathrooms": 2.0, "bedrooms": 4.0, "livingArea": 2012.0, "homeType": "SINGLE_FAMILY", "homeStatus": "FOR_SALE", "daysOnZillow": -1, "isFeatured": false, "shouldHighlight": false, "zestimate": 299700, "rentZestimate": 2228, "listing_sub_type": { "is_FSBA": true }, "isUnmappable": false, "isPreforeclosureAuction": false, "homeStatusForHDP": "FOR_SALE", "priceForHDP": 299000.0, "isNonOwnerOccupied": true, "isPremierBuilder": false, "isZillowOwned": false, "currency": "USD", "country": "USA", "taxAssessedValue": 172900.0, "lotAreaValue": 0.3201, "lotAreaUnit": "acres", "isShowcaseListing": false } }, "isSaved": false, "isUserClaimingOwner": false, "isUserConfirmedClaim": false, "pgapt": "ForSale", "sgapt": "For Sale (Broker)", "zestimate": 299700, "shouldShowZestimateAsPrice": false, "has3DModel": true, "hasVideo": false, "isHomeRec": false, "info2String": "Listing provided by CVRMLS", "brokerName": "AARE", "hasAdditionalAttributions": true, "isFeaturedListing": false, "isShowcaseListing": false, "availabilityDate": null, "list": true, "relaxed": false }, { "zpid": "12346493", "id": "12346493", "providerListingId": null, "imgSrc": "https://photos.zillowstatic.com/fp/2a29d11dedc3283757d197b83276452c-p_e.jpg", "hasImage": true, "carouselPhotos": [...], "detailUrl": "https://www.zillow.com/homedetails/405-Craig-Ave-Richmond-VA-23222/12346493_zpid/", "statusType": "FOR_SALE", "statusText": "House for sale", "countryCurrency": "$", "price": "$199,999", "unformattedPrice": 199999, "address": "405 Craig Ave, Richmond, VA 23222", "addressStreet": "405 Craig Ave", "addressCity": "Richmond", "addressState": "VA", "addressZipcode": "23222", "isUndisclosedAddress": false, "beds": 3, "baths": 1.0, "area": 816, "latLong": { "latitude": 37.59199, "longitude": -77.43066 }, "isZillowOwned": false, "variableData": { "type": "TIME_ON_INFO", "text": "13 hours ago", "data": { "isFresh": false } }, "badgeInfo": null, "hdpData": { "homeInfo": { "zpid": 12346493, "streetAddress": "405 Craig Ave", "zipcode": "23222", "city": "Richmond", "state": "VA", "latitude": 37.59199, "longitude": -77.43066, "price": 199999.0, "bathrooms": 1.0, "bedrooms": 3.0, "livingArea": 816.0, "homeType": "SINGLE_FAMILY", "homeStatus": "FOR_SALE", "daysOnZillow": -1, "isFeatured": false, "shouldHighlight": false, "zestimate": 211600, "rentZestimate": 1565, "listing_sub_type": { "is_FSBA": true }, "isUnmappable": false, "isPreforeclosureAuction": false, "homeStatusForHDP": "FOR_SALE", "priceForHDP": 199999.0, "isNonOwnerOccupied": true, "isPremierBuilder": false, "isZillowOwned": false, "currency": "USD", "country": "USA", "taxAssessedValue": 105500.0, "lotAreaValue": 0.2903, "lotAreaUnit": "acres", "isShowcaseListing": false } }, "isSaved": false, "isUserClaimingOwner": false, "isUserConfirmedClaim": false, "pgapt": "ForSale", "sgapt": "For Sale (Broker)", "zestimate": 211600, "shouldShowZestimateAsPrice": false, "has3DModel": false, "hasVideo": false, "isHomeRec": false, "info2String": "Listing provided by CVRMLS", "brokerName": "CR8TIVE Realty LLC", "hasAdditionalAttributions": true, "isFeaturedListing": false, "isShowcaseListing": false, "availabilityDate": null, "list": true, "relaxed": false }, { "zpid": "12308708", "id": "12308708", "providerListingId": null, "imgSrc": "https://photos.zillowstatic.com/fp/b8b57b0c43c7c66cea937fcf9b537b31-p_e.jpg", "hasImage": true, "carouselPhotos": [ { "url": "https://photos.zillowstatic.com/fp/b8b57b0c43c7c66cea937fcf9b537b31-p_e.jpg" } ], "detailUrl": "https://www.zillow.com/homedetails/9713-Drexel-Ln-Henrico-VA-23228/12308708_zpid/", "statusType": "FOR_SALE", "statusText": "House for sale", "countryCurrency": "$", "price": "$290,000", "unformattedPrice": 290000, "address": "9713 Drexel Ln, Henrico, VA 23228", "addressStreet": "9713 Drexel Ln", "addressCity": "Henrico", "addressState": "VA", "addressZipcode": "23228", "isUndisclosedAddress": false, "beds": 3, "baths": 1.0, "area": 1352, "latLong": { "latitude": 37.645256, "longitude": -77.50168 }, "isZillowOwned": false, "variableData": { "type": "DAYS_ON", "text": "1 day on Zillow" }, "badgeInfo": null, "hdpData": { "homeInfo": { "zpid": 12308708, "streetAddress": "9713 Drexel Ln", "zipcode": "23228", "city": "Henrico", "state": "VA", "latitude": 37.645256, "longitude": -77.50168, "price": 290000.0, "bathrooms": 1.0, "bedrooms": 3.0, "livingArea": 1352.0, "homeType": "SINGLE_FAMILY", "homeStatus": "FOR_SALE", "daysOnZillow": -1, "isFeatured": false, "shouldHighlight": false, "zestimate": 301200, "rentZestimate": 1825, "listing_sub_type": { "is_FSBA": true }, "isUnmappable": false, "isPreforeclosureAuction": false, "homeStatusForHDP": "FOR_SALE", "priceForHDP": 290000.0, "isNonOwnerOccupied": true, "isPremierBuilder": false, "isZillowOwned": false, "currency": "USD", "country": "USA", "taxAssessedValue": 206500.0, "lotAreaValue": 0.2834, "lotAreaUnit": "acres", "isShowcaseListing": false } }, "isSaved": false, "isUserClaimingOwner": false, "isUserConfirmedClaim": false, "pgapt": "ForSale", "sgapt": "For Sale (Broker)", "zestimate": 301200, "shouldShowZestimateAsPrice": false, "has3DModel": false, "hasVideo": false, "isHomeRec": false, "info2String": "Listing provided by CVRMLS", "brokerName": "Fathom Realty Virginia", "hasAdditionalAttributions": true, "isFeaturedListing": false, "isShowcaseListing": false, "availabilityDate": null, "list": true, "relaxed": false } ... ], "resultsHash": "32a651f2", "homeRecCount": 0, "showForYouCount": 0, "mapResults": [ { "zpid": "12355600", "price": "$299,000", "priceLabel": "$299K", "beds": 4, "baths": 2.0, "area": 2012, "latLong": { "latitude": 37.553795, "longitude": -77.34002 }, "statusType": "FOR_SALE", "statusText": "House for sale", "isFavorite": false, "isUserClaimingOwner": false, "isUserConfirmedClaim": false, "imgSrc": "https://photos.zillowstatic.com/fp/070f78f8485ab58d76e95f88d3a8d3dc-p_e.jpg", "hasImage": true, "visited": false, "listingType": "", "variableData": { "type": "3D_HOME", "text": "3D Tour" }, "hdpData": { "homeInfo": { "zpid": 12355600, "streetAddress": "112 Forest Ave", "zipcode": "23223", "city": "Richmond", "state": "VA", "latitude": 37.553795, "longitude": -77.34002, "price": 299000.0, "bathrooms": 2.0, "bedrooms": 4.0, "livingArea": 2012.0, "homeType": "SINGLE_FAMILY", "homeStatus": "FOR_SALE", "daysOnZillow": -1, "isFeatured": false, "shouldHighlight": false, "zestimate": 299700, "rentZestimate": 2228, "listing_sub_type": { "is_FSBA": true }, "isUnmappable": false, "isPreforeclosureAuction": false, "homeStatusForHDP": "FOR_SALE", "priceForHDP": 299000.0, "isNonOwnerOccupied": true, "isPremierBuilder": false, "isZillowOwned": false, "currency": "USD", "country": "USA", "taxAssessedValue": 172900.0, "lotAreaValue": 0.3201, "lotAreaUnit": "acres", "isShowcaseListing": false } }, "shouldShowZestimateAsPrice": false, "detailUrl": "/homedetails/112-Forest-Ave-Richmond-VA-23223/12355600_zpid/", "pgapt": "ForSale", "sgapt": "For Sale (Broker)", "has3DModel": true, "hasVideo": false, "isHomeRec": false, "address": "112 Forest Ave, Richmond, VA 23223", "hasAdditionalAttributions": false, "isFeaturedListing": false, "isShowcaseListing": false, "availabilityDate": null, "timeOnZillow": 2384681170 } ], "relaxedResults": [], "relaxedResultsHash": "1" }, "searchList": { "expansionDistance": 0, "zeroResultsFilters": null, "message": null, "adsConfig": { "navAdSlot": "", "displayAdSlot": "", "targets": {}, "needsUpdate": false }, "totalResultCount": 18, "resultsPerPage": 41, "totalPages": 1, "displayResultsCount": 15, "limitSearchResultsCount": null, "listResultsTitle": "Henrico VA Real Estate & Homes For Sale", "resultContexts": [ { "ssid": 382, "context": "All or a portion of th multiple Listing information is provided by the Central Virginia Regional Multiple Listing Service, LLC, from a copyrighted compilation of Listing s. All CVR MLS information provided is deemed reliable but is not guaranteed accurate. The compilation of Listings and each individual Listing are ©2023 Central Virginia Regional Multiple Listing Service, LLC. All rights reserved.\n\nThe listing broker’s offer of compensation is made only to participants of the MLS where the listing is filed.\n", "contextImage": "https://photos.zillowstatic.com/fp/b9087ed1e0be33e7c1ddd784cbcd3898-zillow_web_95_35.jpg" }, { "ssid": 17925, "context": "", "contextImage": null }, { "ssid": 100138, "context": null, "contextImage": null } ], "pageRules": "PropertySearchLookupResponseRules(isAdsRestricted=false, lowestLimitSearchResultsCount=null)", "shareConfig": { "captchaKey": "6Lf2nvMSAAAAAMQ5p6WlAfDEixMdOQgJsij-3_ud" } } }, "categoryTotals": { "cat1": { "totalResultCount": 18 }, "cat2": { "totalResultCount": 3 } } }, "message": "success" }``` **** ## Location Search **Location Search** `/locationSuggestions` The `/locationSuggestions` endpoint is a fantastic feature of the Zillow Scraper API that lets users search for different places just by typing a name. It's really versatile and can show results like states, counties, streets, and even specific home addresses. When you add this feature to your apps or websites, it makes it easy for users to find important location-based information. Whether they want to look for properties in a specific area or explore details about neighborhoods, the `/locationSuggestions` endpoint gives them accurate and relevant results, making their real estate experience even better. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `q` | An address, neighborhood, city, home address or ZIP code | Yes | String | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and query api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY query = "YOUR-QUERY" #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/zillow/locationSuggestions" parameters = {"api_key": api_key, "q": query} #/ Make the API request response = requests.get(api_url, params=parameters) response_content = response.text print(response_content)``` **** **** ~~Response Example~~ - json ```{ "results": [ { "display": "Tampa, FL", "resultType": "Region", "metaData": { "regionId": 41176, "regionType": "city", "city": "Tampa", "county": "Hillsborough County", "state": "FL", "country": "United States", "lat": 27.978314420263924, "lng": -82.47285136768215 } }, { "display": "Tampa Palms, Tampa, FL", "resultType": "Region", "metaData": { "regionId": 269207, "regionType": "neighborhood", "city": "Tampa", "county": "Hillsborough County", "state": "FL", "country": "United States", "lat": 28.103966994172627, "lng": -82.38830949722475 } }, { "display": "Tampa-Bayshore Gardens, Tampa, FL", "resultType": "Region", "metaData": { "regionId": 275669, "regionType": "neighborhood", "city": "Tampa", "county": "Hillsborough County", "state": "FL", "country": "United States", "lat": 27.9236343424835, "lng": -82.48750991131047 } }, { "display": "Tampa Heights, Tampa, FL", "resultType": "Region", "metaData": { "regionId": 269206, "regionType": "neighborhood", "city": "Tampa", "county": "Hillsborough County", "state": "FL", "country": "United States", "lat": 27.96919196504578, "lng": -82.46090407434997 } }, { "display": "Tampa International Airport Area, Tampa, FL", "resultType": "Region", "metaData": { "regionId": 275668, "regionType": "neighborhood", "city": "Tampa", "county": "Hillsborough County", "state": "FL", "country": "United States", "lat": 27.968271793260527, "lng": -82.54324507973395 } } ] }``` **** ## ZPID Search **ZPID Search** `/zpidByAddress` The `/zpidByAddress` endpoint is a helpful part of the Zillow Scraper API that makes it easy to search for properties using addresses. When you enter an address, this endpoint gives you a special ID called Zillow Property ID (zpid) that belongs to that property. This ID is like a key that unlocks all the details and data about the property in Zillow's big database. When you add this feature to your apps or websites, users can quickly and accurately find property information based on addresses they're interested in. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `street` | Street of the property | Yes | String | | `city` | City of the property | Yes | String | | `state` | State of the property | Yes | String | | `zipcode` | Zip code of the property | No | Integer | **** ~~Scraper API Call~~ - python ```import requests import json defaultHeaders = {"User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko)"} apiUrl = "https://app.scrapeak.com/v1/scrapers/zillow/zpidByAddress" apiKey = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY querystring = { "api_key": apiKey, "street":street, "city":city, "state":state, "zipcode":zip_code } response = requests.request("GET", apiUrl, params=querystring, headers=defaultHeaders) responseContent = response.text print(responseContent)``` **** **** ~~Response Example~~ - json ```{ "is_success": true, "data": [ { "zpid": "103920781", "url": "https://www.zillow.com/homedetails/3013-N-Labarre-Rd-Metairie-LA-70002/103920781_zpid/" }, { "zpid": "73724740", "url": "https://www.zillow.com/homedetails/3009-N-Labarre-Rd-Metairie-LA-70002/73724740_zpid/" }, { "zpid": "73742842", "url": "https://www.zillow.com/homedetails/3300-N-Labarre-Rd-Metairie-LA-70002/73742842_zpid/" }, { "zpid": "73735743", "url": "https://www.zillow.com/homedetails/3017-N-Labarre-Rd-Metairie-LA-70002/73735743_zpid/" }, { "zpid": "103924468", "url": "https://www.zillow.com/homedetails/3004-N-Labarre-Rd-Metairie-LA-70002/103924468_zpid/" }, { "zpid": "73735043", "url": "https://www.zillow.com/homedetails/3108-N-Labarre-Rd-Metairie-LA-70002/73735043_zpid/" } ], "message": "success" }``` **** ## Price Chunking **Price Chunking (pull all the properties)** `/priceChunks` The `/priceChunks` API endpoint is a really strong tool that lets you scrape all property data from Zillow without any limits or restrictions. It means you can efficiently get information from their huge listing site without worrying about any set quotas from Zillow. Whether you're doing big data analysis or creating a big real estate app, the `/priceChunks` endpoint gives you the power to access lots of property information smoothly. There is a limit in Zillow's listing system. This limit is 1,000 properties. To overcome this limit, you need to apply a price chunking process. This process works as follows: A listing search URL is provided. The Scrapeak API returns a list of the most optimal price ranges, allowing you to scrape all the properties without hitting any limits. For an example script, please check the `Price Chunking` section in the [Scripts Library](https://docs.scrapeak.com/zillow-scraper/scriptslibrary) tab. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `url` | The URL of the listing page with the 'searchQueryState' parameter. | Yes | String | **** ~~Scraper API Call~~ - python ```import requests import json apiUrl = "https://app.scrapeak.com/v1/scrapers/zillow/priceChunks" apiKey = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY listingUrl = "LISTING_URL" querystring = { "api_key": apiKey, "url":listingUrl, } response = requests.request("GET", apiUrl, params=querystring) responseContent = response.text print(responseContent)``` **** **** ~~Response Example~~ - json ```{ "is_success": true, "data": { "task_id": "ae5048b2-c8c7-430d-88f3-50a68b45058c" }, "message": "Price chunking process is started." }``` **** # Tasks ## Status **Check status of task** `/task/status` The API endpoint `/task/status` is a system function. You can check status of your task. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `task_id` | ID of your task| Yes | String **** ~~Raw URL~~ - json ```GET - https://app.scrapeak.com/api/task/status?api_key={YOUR_API_KEY}&task_id={TASK_ID}``` **** ~~Response Example~~ - json ```{ "is_success": true, "data": { "status": "SUCCESS", "is_completed": true }, "message": "success" }``` ## Result **Check result of task** `/task/result` The API endpoint `/task/result` is a system function. You can get result data of your task. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `task_id` | ID of your task| Yes | String **** ~~RAW URL~~ - json ```GET - https://app.scrapeak.com/api/task/result?api_key={YOUR_API_KEY}&task_id={TASK_ID}``` **** ~~Response Example~~ - json ```{ "is_success": true, "data": { "result": { "chunks": [ { "chunkMinPrice": 100000, "chunkMaxPrice": 350000, "chunkedlistSize": 484 }, { "chunkMinPrice": 350001, "chunkMaxPrice": 600000, "chunkedlistSize": 339 } ] }, "task_status": "SUCCESS" }, "message": "success" }``` **** # Scripts Library **Scripts Library** To support our users in getting started quickly, we provide a collection of useful scripts in our "Scripts Library" repository on GitHub. This resourceful repository offers a variety of scripts that can streamline your integration process and enhance your overall experience. With these pre-made scripts readily available, you can accelerate your development and effortlessly implement Scrapeak's capabilities into your applications or projects. [Click here to see the Scripts Library](https://www.scrapeak.com/pricing/) **** ~~Test~~ - sideview-github-preview ``` ``` **** # Costs **Credit Cost** Scrapers in the Scrapeak store use credits per request. Our system only charges you for successful results. Status that we count as successful requests: `'is_success': true` [Click here to see the plans](https://www.scrapeak.com/pricing/) **** ~~Test~~ - sideview ```

Parameter Table

Endpoint	Description	Supported Platforms	Credits Usage
`/property`	Property scraping with url or zpid of property. This endpoint gives you hundreds of data points of the property	Web and API	10 credits/request
`/listing`	Listing scraping with listing url. A listing page usually contains general information of 40 properties.	Web and API	10 credits/request
`/locationSuggestions`	Location suggestions	API	10 credits/request
`/zpidByAddress`	Searching zpid by address	API	10 credits/request

``` # FAQ **FAQs** **Can I change my API key?** \ Yes it's possible. Please contact us. **Can I extract contact info of any property?** \ Yes, you can extract contact informations via `/property` API endpoint. **How can I go to next listing page?** \ By increasing the page number parameter in the listing url you sent. You can access the next page data. **** ~~Test~~ - sideview ```

What is the rate limit?
It depends on your subscription plan. Click here to see the plans

What programming languages can I use?
You can use any programming language you want. Our preference is usually Python.

```

Loading ...