Skip to content

mannkind/redfin2mqtt

Repository files navigation

redfin2mqtt

Software License Build Status Coverage Status

An experiment to publish Redfin estimates to MQTT. !!! The Redfin API is super unofficial, this will 100% break !!!

Use

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

Example

docker run \
-e REDFIN__RESOURCES__0__RPID="69103754" \
-e REDFIN__RESOURCES__0__Slug="home" \
-e REDFIN__MQTT__BROKER="localhost" \
-e REDFIN__MQTT__DISCOVERYENABLED="true" \
mannkind/redfin2mqtt:latest

OR

REDFIN__RESOURCES__0__RPID="69103754" \
REDFIN__RESOURCES__0__Slug="home" \
REDFIN__MQTT__BROKER="localhost" \
REDFIN__MQTT__DISCOVERYENABLED="true" \
./redfin2mqtt 

Configuration

Configuration happens via environmental variables

REDFIN__POLLINGINTERVAL                    - [OPTIONAL] The delay between zestimates lookups, defaults to "1.00:03:31"
REDFIN__RESOURCES__#__RPID                 - The n-th iteration of a Redfin Property ID for a specific property
REDFIN__RESOURCES__#__Slug                 - The n-th iteration of a slug to identify the specific Redfin Property ID
REDFIN__MQTT__TOPICPREFIX                  - [OPTIONAL] The MQTT topic on which to publish the collection lookup results, defaults to "home/redfin"
REDFIN__MQTT__DISCOVERYENABLED             - [OPTIONAL] The MQTT discovery flag for Home Assistant, defaults to false
REDFIN__MQTT__DISCOVERYPREFIX              - [OPTIONAL] The MQTT discovery prefix for Home Assistant, defaults to "homeassistant"
REDFIN__MQTT__DISCOVERYNAME                - [OPTIONAL] The MQTT discovery name for Home Assistant, defaults to "redfin"
REDFIN__MQTT__BROKER                       - [OPTIONAL] The MQTT broker, defaults to "test.mosquitto.org"
REDFIN__MQTT__USERNAME                     - [OPTIONAL] The MQTT username, default to ""
REDFIN__MQTT__PASSWORD                     - [OPTIONAL] The MQTT password, default to ""

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages