Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davidski/zestimate-lambda

λ🏠 AWS Lambda function for monitoring Zillow Zestimates
https://github.com/davidski/zestimate-lambda

aws lambda real-estate zillow

Last synced: about 2 months ago
JSON representation

λ🏠 AWS Lambda function for monitoring Zillow Zestimates

Awesome Lists containing this project

README

        

Zestimate Tracker (a/k/a update-zestimate)
==========================================

Python based AWS Lambda function for checking the Zillow Zestimate of a
given property value.

When triggered, this function pulls a CSV from a configured S3 location
and the current Zillow Zestimate (including rental estimates) for a
specified property. If the date of the last update to the Zestimate is
newer than the last date in the file, a message is published to an
SNS topic with the new value and the full Zestimate response is
appended to the CSV.

Zestimates API documentation: https://bridgedataoutput.com/docs/explorer/zestimates#listZestimates

Expected Environment Variables
------------------------------

+ zaddress - Address to track
+ zwsid - Bridge Interactive API Server Token (for server-to-server communication)
+ bucket_name - S3 bucket name to store Zestimate history
+ bucket_key - S3 object name to store Zestimate history
+ sns_topic_arn - SNS topic to publish to when new updates available

Deployment
----------

Continuous Deployment is done via the GitHub Actions workflow. Alternatively,
the included [Makefile](./Makefile) will build a ZIP file which can be
deployed to AWS Lambda. This ZIP file will include all dependencies
(including Pandas, and therefore rather large).

Contributing
============

This project is governed by a [Code of Conduct](./CODE_OF_CONDUCT.md). By
participating in this project you agree to abide by these terms.

License
=======

The [MIT License](LICENSE) applies.