The hc-api-python from housecanary

README endpoint cleanup

Need to make sure endpoints in README are in sync with current v2 docs.

These two endpoints should be removed:

score
mls

These two are coming soon (can probably just remove for now):

ltv
ltv_forecast

`property/value_report` endpoint removed

According to the HouseCanary API docs, the property/value_report endpoint was deprecated and replaced with property/value_report_static and property/value_report_dynamic: https://api-docs.housecanary.com/#july-18-2018-value-report-endpoint-changes

It appears that property/value_report was finally removed from the API yesterday and the replacement endpoints have not been added to this library.

Drop HC/redundant prefixes

We really don't need to prefix everything with "HC" or be so redundant with our naming (e.g. housecanary.hcrequests.HouseCanaryRequestClient vs housecanary.request.Request)

Use `response.content` for binary response content

Would you accept a PR to update process_pdf_response and process_zip_response (https://github.com/housecanary/hc-api-python/blob/master/housecanary/output.py#L91) to use response.content, as is suggested for binary response content (http://docs.python-requests.org/en/master/user/quickstart/#binary-response-content)? Is there a reason to use .text?

This would require a major bump, but would make the library more intuitive to work with.

Use @housecanary.com email before pushing to pypi.

See

hc-api-python/setup.py

Line 13 in dc48699

author_email='[email protected]',

.

It would make more sense to set up something like [email protected] that multiple people can access just in case anyone has questions. Similarly, a shared account on pypi would be a good idea since otherwise one person could be the bottleneck for deploying code changes.

If we still want to keep that email address somewhere in the repo then a separate contributor file should be added (e.g. https://github.com/kennethreitz/requests/blob/master/AUTHORS.rst)

Fix package name

If you plan on posting this on pypi hc-api-python is an odd package name to go with. Everything on pypi is already python, so that can obviously go, and hc isn't really search friendly. Since the folder is already called housecanary why not just call the package that too?

Tests don't work out of the box

See

hc-api-python/tests/test_hcapiclient.py

Line 2 in dc48699

    
           These tests require the HC_API_KEY and HC_API_SECRET environment variables to be set.

There's no reason why the tests should require environment variables to be set. The tests should just mock that data or set it locally.

SSL error

As of today (March 19, 2019) I'm getting this SSL error when I try make a request using this library:

requests.exceptions.SSLError: HTTPSConnectionPool(host='api.housecanary.com', port=443): Max retries exceeded with url: / (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1045)')))
I suspect this is actually due to an incomplete certificate update on the server, and I've just filed a ticket on https://support.housecanary.com/ . I will update this if I get a ticket number that I can post. I can access the api endpoint in the browser, but hitting it from Python (either with this lib or using requests.get() directly) results in the same error. When I put the endpoint url into Digicert's checker, it said that it was ok in general but was missing intermediate certs. Here's a screenshot:

Everything was fine yesterday. I tried updating certifi but that didn't help. And, in fact, I can still connect with openssl if I specify certifi's root certificate, so it is not that either.

Use slumber to cut down on boilerplate code

See http://slumber.readthedocs.io

It would remove the need for things like

hc-api-python/housecanary/hcapiclient.py

Lines 172 to 230 in dc48699

    
           def consumer(self, address_data): 
        
               """Call the consumer endpoint""" 
        
               return self._api_client.fetch("property/consumer", address_data) 
        
           def flood(self, address_data): 
        
               """Call the flood endpoint""" 
        
               return self._api_client.fetch("property/flood", address_data) 
        
           def school(self, address_data): 
        
               """Call the school endpoint""" 
        
               return self._api_client.fetch("property/school", address_data) 
        
           def value(self, address_data): 
        
               """Call the value endpoint""" 
        
               return self._api_client.fetch("property/value", address_data) 
        
           def value_forecast(self, address_data): 
        
               """Call the value_forecast endpoint""" 
        
               return self._api_client.fetch("property/value_forecast", address_data) 
        
           def zip_hpi_historical(self, address_data): 
        
               """Call the zip_hpi_historical endpoint""" 
        
               return self._api_client.fetch("property/zip_hpi_historical", address_data) 
        
           def zip_hpi_forecast(self, address_data): 
        
               """Call the zip_hpi_forecast endpoint""" 
        
               return self._api_client.fetch("property/zip_hpi_forecast", address_data) 
        
           def rental_value(self, address_data): 
        
               """Call the rental_value endpoint""" 
        
               return self._api_client.fetch("property/rental_value", address_data) 
        
           def msa_details(self, address_data): 
        
               """Call the msa_details endpoint""" 
        
               return self._api_client.fetch("property/msa_details", address_data) 
        
           def mortgage_lien(self, address_data): 
        
               """Call the mortgage_lien endpoint""" 
        
               return self._api_client.fetch("property/mortgage_lien", address_data) 
        
           def owner_occupied(self, address_data): 
        
               """Call the owner_occupied endpoint""" 
        
               return self._api_client.fetch("property/owner_occupied", address_data) 
        
           def details(self, address_data): 
        
               """Call the details endpoint""" 
        
               return self._api_client.fetch("property/details", address_data) 
        
           def sales_history(self, address_data): 
        
               """Call the sales_history endpoint""" 
        
               return self._api_client.fetch("property/sales_history", address_data) 
        
           def nod(self, address_data): 
        
               """Call the nod endpoint""" 
        
               return self._api_client.fetch("property/nod", address_data) 
        
           def census(self, address_data): 
        
               """Call the census endpoint""" 
        
               return self._api_client.fetch("property/census", address_data)

, https://github.com/housecanary/hc-api-python/blob/dc48699b29e47305053b7da534037e3c6e993895/housecanary/hcrequests.py, https://github.com/housecanary/hc-api-python/blob/dc48699b29e47305053b7da534037e3c6e993895/housecanary/hcobject.py, etc.

Value history EndPoint

Will there ever be a property/value_history endpoint? I see from API reference for property/value endpoint that "HouseCanary proprietary sale valuation models for each property, computed and updated every month". Is it possible that this historical data has been saved and might be available as an endpoint?

housecanary / hc-api-python Goto Github PK

hc-api-python's People

Contributors

Stargazers

Watchers

Forkers

hc-api-python's Issues

README endpoint cleanup

`property/value_report` endpoint removed

Drop HC/redundant prefixes

Use `response.content` for binary response content

Use @housecanary.com email before pushing to pypi.

Fix package name

Tests don't work out of the box

SSL error

Use slumber to cut down on boilerplate code

Value history EndPoint

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	def consumer(self, address_data):
	"""Call the consumer endpoint"""
	return self._api_client.fetch("property/consumer", address_data)

	def flood(self, address_data):
	"""Call the flood endpoint"""
	return self._api_client.fetch("property/flood", address_data)

	def school(self, address_data):
	"""Call the school endpoint"""
	return self._api_client.fetch("property/school", address_data)

	def value(self, address_data):
	"""Call the value endpoint"""
	return self._api_client.fetch("property/value", address_data)

	def value_forecast(self, address_data):
	"""Call the value_forecast endpoint"""
	return self._api_client.fetch("property/value_forecast", address_data)

	def zip_hpi_historical(self, address_data):
	"""Call the zip_hpi_historical endpoint"""
	return self._api_client.fetch("property/zip_hpi_historical", address_data)

	def zip_hpi_forecast(self, address_data):
	"""Call the zip_hpi_forecast endpoint"""
	return self._api_client.fetch("property/zip_hpi_forecast", address_data)

	def rental_value(self, address_data):
	"""Call the rental_value endpoint"""
	return self._api_client.fetch("property/rental_value", address_data)

	def msa_details(self, address_data):
	"""Call the msa_details endpoint"""
	return self._api_client.fetch("property/msa_details", address_data)

	def mortgage_lien(self, address_data):
	"""Call the mortgage_lien endpoint"""
	return self._api_client.fetch("property/mortgage_lien", address_data)

	def owner_occupied(self, address_data):
	"""Call the owner_occupied endpoint"""
	return self._api_client.fetch("property/owner_occupied", address_data)

	def details(self, address_data):
	"""Call the details endpoint"""
	return self._api_client.fetch("property/details", address_data)

	def sales_history(self, address_data):
	"""Call the sales_history endpoint"""
	return self._api_client.fetch("property/sales_history", address_data)

	def nod(self, address_data):
	"""Call the nod endpoint"""
	return self._api_client.fetch("property/nod", address_data)

	def census(self, address_data):
	"""Call the census endpoint"""
	return self._api_client.fetch("property/census", address_data)