avm_client

This is api client library for AVM (automated valuation machine) - https://avm.enbisys.com

Get instant and accurate Property Valuations and Predictive Analytics with our AI and Big Data tools. And make smart decisions faster

Installation

gem install avm_client

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'avm_client'

# Setup authorization
AvmClient.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-KEY'] = 'SET YOUR TOKEN HERE!'
end

api_instance = AvmClient::DefaultApi.new

property_features = AvmClient::PropertyFeatures.new
required_features = AvmClient::RequiredFeatures.new
additional_features = AvmClient::AdditionalFeatures.new

additional_features.built_form = AvmClient::BuiltForm::DETACHED
additional_features.roof_energy_efficiency = AvmClient::EnergyEfficiency::GOOD

required_features.postcode = 'b1 1tb'
required_features.floor_level = AvmClient::FloorLevel::FLOOR_5
required_features.new_or_resale = AvmClient::NewOrResale::NEW
required_features.number_of_rooms = 2
required_features.property_type = AvmClient::PropertyType::DETACHED_HOUSE
required_features.total_floor_area_in_sqf = 160

property_features.additional_features = additional_features
property_features.required_features = required_features

begin
  price = api_instance.get_fast_valuation(property_features)
  valuation = api_instance.get_valuation(property_features)
  puts price
  puts "price range from: #{valuation.price_range_from}"
  puts "to: #{valuation.price_range_to}"
rescue AvmClient::ApiError => e
  puts "Exception when calling DefaultApi->get_fast_valuation: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://avm.enbisys.com/api

Class	Method	HTTP request	Description
AvmClient::DefaultApi	get_fast_valuation	POST /properties/getFastValuation
AvmClient::DefaultApi	get_valuation	POST /properties/getValuation

Documentation for Models

• AvmClient::AdditionalFeatures
• AvmClient::BuiltForm
• AvmClient::EnergyEfficiency
• AvmClient::EnergyRating
• AvmClient::FloorLevel
• AvmClient::LeaseholdOrFreehold
• AvmClient::NewOrResale
• AvmClient::Problem
• AvmClient::PropertyFeatures
• AvmClient::PropertyType
• AvmClient::RequiredFeatures
• AvmClient::RoofInsulation
• AvmClient::RoofType
• AvmClient::Valuation
• AvmClient::ValuationPriceDistribution
• AvmClient::WallInsulation
• AvmClient::WallType
• AvmClient::WindowGlazingType

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header