Skip to content

systep/homefacts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HomeFacts CircleCI

The following is an unoffical go client for homefacts.com. HomeFacts is a website that provides stats about addresses. This unoffical software is not affiliated with homefacts.com in any way. Visit Homefacts here.

Usage Example

Initialize a client, and use the GetFacts function, passing a string address. The response object looks like so

 {
 	"crimeRate": {
 		"Class": "successIcon",
 		"Text": "Low"
 	},
 	"schoolRating": {
 		"Class": "errorIcon",
 		"Text": "B+ for 22280 S 209th Way"
 	},
 	"registeredOffenders": {
 		"Class": "warningIcon",
 		"Text": "1  within 1 mile"
 	},
 	"avgHomePrice": {
 		"Class": "warningIcon",
 		"Text": "$203,000 within 1 mile"
 	},
 	"foreclosures": {
 		"Class": "errorIcon",
 		"Text": "51  within 1 mile"
 	},
 	"naturalHazards": {
 		"Class": "successIcon",
 		"Text": "Earthquake, Hurricane "
 	},
 	"environmentalHazards": {
 		"Class": "",
 		"Text": "9  within 1 mile"
 	}
 }
package main

import (
	"flag"
	"log"

	"encoding/json"

	"github.com/skyline-ai/homefacts"
)

var (
	address = flag.String("address", "22280 S 209th Way, Queen Creek, AZ 85142", "address")
)

func init() {
	flag.Parse()
}

func main() {
	c := homefacts.New()

	resp, err := c.GetFacts(&homefacts.Request{
		Address: *address,
	})

	if err != nil {
		log.Fatalln(err)
	}

	j, err := json.MarshalIndent(resp.Result, " ", "\t")

	if err != nil {
		log.Fatalln(err)
	}

	log.Printf("response: %s", j)
	// prints:
	//  {
	//  	"crimeRate": {
	//  		"Class": "successIcon",
	//  		"Text": "Low"
	//  	},
	//  	"schoolRating": {
	//  		"Class": "errorIcon",
	//  		"Text": "B+ for 22280 S 209th Way"
	//  	},
	//  	"registeredOffenders": {
	//  		"Class": "warningIcon",
	//  		"Text": "1  within 1 mile"
	//  	},
	//  	"avgHomePrice": {
	//  		"Class": "warningIcon",
	//  		"Text": "$203,000 within 1 mile"
	//  	},
	//  	"foreclosures": {
	//  		"Class": "errorIcon",
	//  		"Text": "51  within 1 mile"
	//  	},
	//  	"naturalHazards": {
	//  		"Class": "successIcon",
	//  		"Text": "Earthquake, Hurricane "
	//  	},
	//  	"environmentalHazards": {
	//  		"Class": "",
	//  		"Text": "9  within 1 mile"
	//  	}
	//  }
}

About

an unoffical go client for getting data from homefacts.com

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages