Skip to content

jamie-mh/estimmo-api

Repository files navigation

Estimmo API

High-performance French real-estate estimation and history API built with ASP.NET and PostGIS. Using open data, Estimmo provides a visualisation of national property values and sale history.

Website

API Documentation

Data sources

Running the API

Download the Docker Compose file (compose.yaml) and run it to start the service.

docker compose up -d

The API should now be accessible at http://localhost:8080.

Populating the database

The runner image downloads all the necessary data and imports it into the database.

It can be run using the following command:

docker run -v ./data:/data --net estimmo_estimmo --user "$(id -u):$(id -g)" ghcr.io/jamie-mh/estimmo-runner:latest

This will download the data into the data directory relative to where the command is run.

By default, this will run all the steps. Alternatively, an argument can be passed to the container to select the desired step (download, prepare, import).

About

🗺️ French real-estate estimation and history API

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors