ScrapeBadger.Api.ZillowApi

All URIs are relative to https://scrapebadger.com

Method	HTTP request	Description
ZillowGetAgentProfileListings	GET /v1/zillow/agent	Get agent profile + listings
ZillowGetMultifamilyBuilding	GET /v1/zillow/building	Get multifamily building
ZillowGetPropertyDetail	GET /v1/zillow/property/{zpid}	Get property detail
ZillowGetPropertyDetailByUrl	GET /v1/zillow/property	Get property detail by URL
ZillowListCoverageMarkets	GET /v1/zillow/markets	List coverage markets
ZillowRegionAddressSuggestions	GET /v1/zillow/autocomplete	Region/address suggestions
ZillowSearchProperties	GET /v1/zillow/search	Search properties
ZillowZillowScraperHealthCheck	GET /v1/zillow/health	Zillow scraper health check
ZillowZillowScraperHealthCheckHead	HEAD /v1/zillow/health	Zillow scraper health check

ZillowGetAgentProfileListings

Object ZillowGetAgentProfileListings (string username = null, string url = null)

Get agent profile + listings

Get a Zillow professional's profile and their active listings.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class ZillowGetAgentProfileListingsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ZillowApi(httpClient, config, httpClientHandler);
            var username = "username_example";  // string | Zillow profile username (optional) 
            var url = "url_example";  // string | Full Zillow /profile/... URL (optional) 

            try
            {
                // Get agent profile + listings
                Object result = apiInstance.ZillowGetAgentProfileListings(username, url);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ZillowApi.ZillowGetAgentProfileListings: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ZillowGetAgentProfileListingsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get agent profile + listings
    ApiResponse<Object> response = apiInstance.ZillowGetAgentProfileListingsWithHttpInfo(username, url);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ZillowApi.ZillowGetAgentProfileListingsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
username	string	Zillow profile username	[optional]
url	string	Full Zillow /profile/... URL	[optional]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ZillowGetMultifamilyBuilding

Object ZillowGetMultifamilyBuilding (string url)

Get multifamily building

Get a Zillow apartment community with per-unit pricing and availability. Multi-unit rentals are served on /apartments/... and /b/... pages, which /property cannot read — pass a home_type=BUILDING search result's detail_url here instead.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class ZillowGetMultifamilyBuildingExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ZillowApi(httpClient, config, httpClientHandler);
            var url = "url_example";  // string | Full Zillow building URL, e.g. https://www.zillow.com/apartments/kansas-city-mo/brookside-51/CkBJqt/

            try
            {
                // Get multifamily building
                Object result = apiInstance.ZillowGetMultifamilyBuilding(url);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ZillowApi.ZillowGetMultifamilyBuilding: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ZillowGetMultifamilyBuildingWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get multifamily building
    ApiResponse<Object> response = apiInstance.ZillowGetMultifamilyBuildingWithHttpInfo(url);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ZillowApi.ZillowGetMultifamilyBuildingWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
url	string	Full Zillow building URL, e.g. https://www.zillow.com/apartments/kansas-city-mo/brookside-51/CkBJqt/

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ZillowGetPropertyDetail

Object ZillowGetPropertyDetail (string zpid)

Get property detail

Get a single Zillow property's full detail by zpid.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class ZillowGetPropertyDetailExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ZillowApi(httpClient, config, httpClientHandler);
            var zpid = "zpid_example";  // string | 

            try
            {
                // Get property detail
                Object result = apiInstance.ZillowGetPropertyDetail(zpid);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ZillowApi.ZillowGetPropertyDetail: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ZillowGetPropertyDetailWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get property detail
    ApiResponse<Object> response = apiInstance.ZillowGetPropertyDetailWithHttpInfo(zpid);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ZillowApi.ZillowGetPropertyDetailWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
zpid	string

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ZillowGetPropertyDetailByUrl

Object ZillowGetPropertyDetailByUrl (string url)

Get property detail by URL

Get a single Zillow property's full detail by its homedetails URL.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class ZillowGetPropertyDetailByUrlExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ZillowApi(httpClient, config, httpClientHandler);
            var url = "url_example";  // string | Full Zillow /homedetails/... URL

            try
            {
                // Get property detail by URL
                Object result = apiInstance.ZillowGetPropertyDetailByUrl(url);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ZillowApi.ZillowGetPropertyDetailByUrl: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ZillowGetPropertyDetailByUrlWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get property detail by URL
    ApiResponse<Object> response = apiInstance.ZillowGetPropertyDetailByUrlWithHttpInfo(url);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ZillowApi.ZillowGetPropertyDetailByUrlWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
url	string	Full Zillow /homedetails/... URL

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ZillowListCoverageMarkets

Object ZillowListCoverageMarkets ()

List coverage markets

List Zillow coverage regions (US + Canada).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class ZillowListCoverageMarketsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ZillowApi(httpClient, config, httpClientHandler);

            try
            {
                // List coverage markets
                Object result = apiInstance.ZillowListCoverageMarkets();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ZillowApi.ZillowListCoverageMarkets: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ZillowListCoverageMarketsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // List coverage markets
    ApiResponse<Object> response = apiInstance.ZillowListCoverageMarketsWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ZillowApi.ZillowListCoverageMarketsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ZillowRegionAddressSuggestions

Object ZillowRegionAddressSuggestions (string query)

Region/address suggestions

Resolve a search term to Zillow regions/addresses.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class ZillowRegionAddressSuggestionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ZillowApi(httpClient, config, httpClientHandler);
            var query = "query_example";  // string | Partial location — city, ZIP, address, neighborhood

            try
            {
                // Region/address suggestions
                Object result = apiInstance.ZillowRegionAddressSuggestions(query);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ZillowApi.ZillowRegionAddressSuggestions: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ZillowRegionAddressSuggestionsWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Region/address suggestions
    ApiResponse<Object> response = apiInstance.ZillowRegionAddressSuggestionsWithHttpInfo(query);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ZillowApi.ZillowRegionAddressSuggestionsWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
query	string	Partial location — city, ZIP, address, neighborhood

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ZillowSearchProperties

Object ZillowSearchProperties (string location, string status = null, int? page = null, string sort = null, int? priceMin = null, int? priceMax = null, int? bedsMin = null, decimal? bathsMin = null, string homeType = null, int? sqftMin = null, int? sqftMax = null, int? lotMin = null, int? lotMax = null, int? yearBuiltMin = null, int? yearBuiltMax = null, int? hoaMax = null, string keywords = null, string daysOn = null, decimal? north = null, decimal? south = null, decimal? east = null, decimal? west = null)

Search properties

Search Zillow for for-sale / for-rent / recently-sold properties.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class ZillowSearchPropertiesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ZillowApi(httpClient, config, httpClientHandler);
            var location = "location_example";  // string | City/state, ZIP, address or neighborhood
            var status = "\"for_sale\"";  // string | for_sale|for_rent|sold (optional)  (default to "for_sale")
            var page = 1;  // int? |  (optional)  (default to 1)
            var sort = "sort_example";  // string | homes_for_you|newest|price_high_to_low|price_low_to_high|bedrooms|bathrooms|square_feet|lot_size|year_built (optional) 
            var priceMin = 56;  // int? |  (optional) 
            var priceMax = 56;  // int? |  (optional) 
            var bedsMin = 56;  // int? |  (optional) 
            var bathsMin = 8.14D;  // decimal? |  (optional) 
            var homeType = "homeType_example";  // string | houses|condos|townhomes|apartments|manufactured|lots|multi_family (optional) 
            var sqftMin = 56;  // int? |  (optional) 
            var sqftMax = 56;  // int? |  (optional) 
            var lotMin = 56;  // int? |  (optional) 
            var lotMax = 56;  // int? |  (optional) 
            var yearBuiltMin = 56;  // int? |  (optional) 
            var yearBuiltMax = 56;  // int? |  (optional) 
            var hoaMax = 56;  // int? |  (optional) 
            var keywords = "keywords_example";  // string |  (optional) 
            var daysOn = "daysOn_example";  // string |  (optional) 
            var north = 8.14D;  // decimal? | Map bounds for tiling past the 820 cap (optional) 
            var south = 8.14D;  // decimal? |  (optional) 
            var east = 8.14D;  // decimal? |  (optional) 
            var west = 8.14D;  // decimal? |  (optional) 

            try
            {
                // Search properties
                Object result = apiInstance.ZillowSearchProperties(location, status, page, sort, priceMin, priceMax, bedsMin, bathsMin, homeType, sqftMin, sqftMax, lotMin, lotMax, yearBuiltMin, yearBuiltMax, hoaMax, keywords, daysOn, north, south, east, west);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ZillowApi.ZillowSearchProperties: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ZillowSearchPropertiesWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Search properties
    ApiResponse<Object> response = apiInstance.ZillowSearchPropertiesWithHttpInfo(location, status, page, sort, priceMin, priceMax, bedsMin, bathsMin, homeType, sqftMin, sqftMax, lotMin, lotMax, yearBuiltMin, yearBuiltMax, hoaMax, keywords, daysOn, north, south, east, west);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ZillowApi.ZillowSearchPropertiesWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
location	string	City/state, ZIP, address or neighborhood
status	string	for_sale	for_rent
page	int?		[optional] [default to 1]
sort	string	homes_for_you	newest
priceMin	int?		[optional]
priceMax	int?		[optional]
bedsMin	int?		[optional]
bathsMin	decimal?		[optional]
homeType	string	houses	condos
sqftMin	int?		[optional]
sqftMax	int?		[optional]
lotMin	int?		[optional]
lotMax	int?		[optional]
yearBuiltMin	int?		[optional]
yearBuiltMax	int?		[optional]
hoaMax	int?		[optional]
keywords	string		[optional]
daysOn	string		[optional]
north	decimal?	Map bounds for tiling past the 820 cap	[optional]
south	decimal?		[optional]
east	decimal?		[optional]
west	decimal?		[optional]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ZillowZillowScraperHealthCheck

Object ZillowZillowScraperHealthCheck ()

Zillow scraper health check

Check health of the Zillow scraper service (accepts HEAD for UptimeRobot).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class ZillowZillowScraperHealthCheckExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ZillowApi(httpClient, config, httpClientHandler);

            try
            {
                // Zillow scraper health check
                Object result = apiInstance.ZillowZillowScraperHealthCheck();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ZillowApi.ZillowZillowScraperHealthCheck: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ZillowZillowScraperHealthCheckWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Zillow scraper health check
    ApiResponse<Object> response = apiInstance.ZillowZillowScraperHealthCheckWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ZillowApi.ZillowZillowScraperHealthCheckWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ZillowZillowScraperHealthCheckHead

Object ZillowZillowScraperHealthCheckHead ()

Zillow scraper health check

Check health of the Zillow scraper service (accepts HEAD for UptimeRobot).

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ScrapeBadger.Api;
using ScrapeBadger.Client;
using ScrapeBadger.Model;

namespace Example
{
    public class ZillowZillowScraperHealthCheckHeadExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://scrapebadger.com";
            // Configure API key authorization: ApiKeyAuth
            config.AddApiKey("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("X-API-Key", "Bearer");

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new ZillowApi(httpClient, config, httpClientHandler);

            try
            {
                // Zillow scraper health check
                Object result = apiInstance.ZillowZillowScraperHealthCheckHead();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ZillowApi.ZillowZillowScraperHealthCheckHead: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ZillowZillowScraperHealthCheckHeadWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Zillow scraper health check
    ApiResponse<Object> response = apiInstance.ZillowZillowScraperHealthCheckHeadWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ZillowApi.ZillowZillowScraperHealthCheckHeadWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

ZillowApi.md

Latest commit

History

ZillowApi.md

File metadata and controls

ScrapeBadger.Api.ZillowApi

ZillowGetAgentProfileListings

Example

Using the ZillowGetAgentProfileListingsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ZillowGetMultifamilyBuilding

Example

Using the ZillowGetMultifamilyBuildingWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ZillowGetPropertyDetail

Example

Using the ZillowGetPropertyDetailWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ZillowGetPropertyDetailByUrl

Example

Using the ZillowGetPropertyDetailByUrlWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ZillowListCoverageMarkets

Example

Using the ZillowListCoverageMarketsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ZillowRegionAddressSuggestions

Example

Using the ZillowRegionAddressSuggestionsWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ZillowSearchProperties

Example

Using the ZillowSearchPropertiesWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ZillowZillowScraperHealthCheck

Example

Using the ZillowZillowScraperHealthCheckWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ZillowZillowScraperHealthCheckHead

Example

Using the ZillowZillowScraperHealthCheckHeadWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details