Code Monkey home page Code Monkey logo

zillow2mqtt's Introduction

unmaintained

It appears that in Oct 2021, Zillow stopped supporting the API.

HTTP 410 GONE

zillow2mqtt

Software License Build Status Coverage Status

An experiment to publish Zillow ZEstimates to MQTT.

See also Zillow's API documentation at http://www.zillow.com/howto/api/APIOverview.htm.

Use

The application can be locally built using dotnet build or you can utilize the multi-architecture Docker image(s).

Example

docker run \
-e ZILLOW__APIKEY="B1-AWz18xy032zklA_6Nmn1" \
-e ZILLOW__RESOURCES__0__ZPID="69103754" \
-e ZILLOW__RESOURCES__0__Slug="home" \
-e ZILLOW__MQTT__BROKER="localhost" \
-e ZILLOW__MQTT__DISCOVERYENABLED="true" \
mannkind/zillow2mqtt:latest

OR

ZILLOW__APIKEY="B1-AWz18xy032zklA_6Nmn1" \
ZILLOW__RESOURCES__0__ZPID="69103754" \
ZILLOW__RESOURCES__0__Slug="home" \
ZILLOW__MQTT__BROKER="localhost" \
ZILLOW__MQTT__DISCOVERYENABLED="true" \
./zillow2mqtt 

Configuration

Configuration happens via environmental variables

ZILLOW__APIKEY                             - The Zillow API key
ZILLOW__POLLINGINTERVAL                    - [OPTIONAL] The delay between zestimates lookups, defaults to "1.00:03:31"
ZILLOW__RESOURCES__#__ZPID                 - The n-th iteration of a Zillow Property ID for a specific property
ZILLOW__RESOURCES__#__Slug                 - The n-th iteration of a slug to identify the specific Zillow Property ID
ZILLOW__MQTT__TOPICPREFIX                  - [OPTIONAL] The MQTT topic on which to publish the collection lookup results, defaults to "home/zillow"
ZILLOW__MQTT__DISCOVERYENABLED             - [OPTIONAL] The MQTT discovery flag for Home Assistant, defaults to false
ZILLOW__MQTT__DISCOVERYPREFIX              - [OPTIONAL] The MQTT discovery prefix for Home Assistant, defaults to "homeassistant"
ZILLOW__MQTT__DISCOVERYNAME                - [OPTIONAL] The MQTT discovery name for Home Assistant, defaults to "zillow"
ZILLOW__MQTT__BROKER                       - [OPTIONAL] The MQTT broker, defaults to "test.mosquitto.org"
ZILLOW__MQTT__USERNAME                     - [OPTIONAL] The MQTT username, default to ""
ZILLOW__MQTT__PASSWORD                     - [OPTIONAL] The MQTT password, default to ""

Prior Implementations

Golang

zillow2mqtt's People

Contributors

mannkind avatar rlespinasse avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.