Predictive Scores

Machine learning endpoints for investment feasibility scoring, market propensity (Mashmeter), and property recommendations based on demographics.

POST/v1.1/client/ml/investment-likelihood

Investment Likelihood

"Property Finder" is the functionality supported by the Investment Likelihood machine learning model, predicting the investment feasibility score for each MLS listing. Users can search for up to 5 areas concurrently for potential investments.

The model has achieved over 86% of accuracy score and is being optimized on an ongoing basis, using enriched data sets and enhanced methodology.

HTTP Headers

Header	Value	Default
Content-Type	application/json
x-api-key	User Authentication Header

Body parameters

Name
airbnb_ROI
Type
number
Description
Airbnb cash on cash (rent over investment).
Name
airbnb_rental
Type
number
Description
Airbnb monthly rental income.
Name
traditional_ROI
Type
number
Description
Airbnb cash on cash (rent over investment).
Name
traditional_rental
Type
number
Description
Traditional monthly rental income.
Name
baths
Type
integer
Description
Property bathrooms.
Name
beds
Type
integer
Description
Property bedrooms.
Name
days_on_market
Type
integer
Description
How many days the listing has been active on market. Use 0 when missed.
Name
home_type
Type
string
Description
Property home type: Condo/Coop, Multi Family, Other, Single Family Residential, Townhouse.
Name
list_price
Type
integer
Description
Property list price. Use 0 when missed.
Name
sqft
Type
integer
Description
Property sqft value. Use 0 when missed.

Request

POST

/v1.1/client/ml/investment-likelihood

curl -X POST "https://api.mashvisor.com/v1.1/client/ml/investment-likelihood" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"airbnb_ROI":9.33728,"airbnb_rental":3235.36,"traditional_ROI":1.92281,"traditional_rental":1270,"baths":10,"beds":10,"days_on_market":152,"home_type":"Multi Family","list_price":599000,"sqft":2000}'

Response

{
  "status": "success",
  "content": {
    "contact": {
      "prediction": {
        "Value": 1
      },
      "prediction_likelihood": {
        "Value": 67.31213123
      }
    }
  },
  "message": "prediction_likelihood succeeded"
}

POST/v1.1/client/ml/mashmeter

Mashmeter

Mashmeter is a blended dynamic model utilizing real-time data with an output showing a low to high propensity for investment property returns, combined with a specific market investment opportunity.

HTTP Headers

Header	Value	Default
Content-Type	application/json
x-api-key	User Authentication Header

Body parameters

Name
airbnb_listings
Type
integer
Description
Number of properties listed for sale in a given neighbourhood.
Name
median_airbnb_coc
Type
number
Description
Median Airbnb cash on cash (rent over investment) for a neighborhood.
Name
airbnb_price_to_rent_ratio
Type
number
Description
Airbnb price to rent ratio.
Name
traditional_listings
Type
integer
Description
Number of properties listed on Airbnb in a given neighbourhood.
Name
median_traditional_coc
Type
number
Description
Median traditional cash on cash (rent over investment) for a neighborhood.
Name
traditional_price_to_rent_ratio
Type
number
Description
Traditional price to rent ratio.
Name
walkscore
Type
integer
Description
Neighborhood Walkscore value.

Request

POST

/v1.1/client/ml/mashmeter

curl -X POST "https://api.mashvisor.com/v1.1/client/ml/mashmeter" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"airbnb_listings":1104,"median_airbnb_coc":6.60582,"airbnb_price_to_rent_ratio":27.884447053896,"traditional_listings":7,"median_traditional_coc":0.7074975,"traditional_price_to_rent_ratio":28.650655961001,"walkscore":55}'

Response

{
  "status": "success",
  "content": {
    "traditional_mashmeter": "75.09",
    "airbnb_mashmeter": "67.79",
    "traditional_weight": "0.46",
    "airbnb_weight": "2.52",
    "strategy": "Airbnb",
    "mashmeter": "67.79"
  },
  "message": "Mashmeter values fetched successfully"
}

POST/v1.1/client/ml/recommended_property

Property Recommender

The API returns a JSON object with data representing specifications for recommended properties based on an input consisting of demographics and other data. The returned data includes property type, number of beds/baths, and the home value.

HTTP Headers

Header	Value	Default
Content-Type	application/json
x-api-key	User Authentication Header

Body parameters

Name
AgeRange
Type
string
Description
Person age range. Possible inputs: 18-24, 25-34, 35-44, 45-54, 55-64, 65-74, 75+, UNKNOWN.
Name
WealthScore
Type
string
Description
Any from 0 to 100, or UNKNOWN.
Name
Gender
Type
string
Description
Male, Female, UNKNOWN.
Name
EstimatedHouseholdIncome
Type
string
Description
e.g. < $20,000, $50,000-99,999, $250,000, UNKNOWN.
Name
PresenceOfChildren
Type
string
Description
YES, UNKNOWN.
Name
NumberOfChildren
Type
string
Description
Any positive integer. If missing, send -1.
Name
MaritalStatusInHousehold
Type
string
Description
Married, Single, UNKNOWN.
Name
Investing
Type
string
Description
YES, UNKNOWN.
Name
EstWealth
Type
string
Description
e.g. < $1, $250,000-499,999, > $499,999, UNKNOWN.
Name
NumberCreditLines
Type
string
Description
Any positive integer.
Name
LengthOfResidence
Type
string
Description
1 - 4 year, 5 - 10 years, 11 - 15 years, UNKNOWN.
Name
Sale1 Transfer Amt
Type
string
Description
Any positive number.
Name
BusinessOwner
Type
string
Description
Accountant, Contractor, Owner/Partner, Person Owns a Business, Self Employed, UNKNOWN.

Request

POST

/v1.1/client/ml/recommended_property

curl -X POST "https://api.mashvisor.com/v1.1/client/ml/recommended_property" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"AgeRange":"45-54","WealthScore":"50.0","Gender":"Female","EstimatedHouseholdIncome":"> $250,000","PresenceOfChildren":"YES","NumberOfChildren":"1","MaritalStatusInHousehold":"Single","Investing":"YES","EstWealth":"> $499,999","NumberCreditLines":"1","LengthOfResidence":"11 - 15 years","Sale1 Transfer Amt":"590000.0","BusinessOwner":"UNKNOWN"}'

Response

{
  "status": "success",
  "content": {
    "property_type": {
      "Condo/Coop": 69
    },
    "bedrooms": {
      "1": 95
    },
    "bathrooms": {
      "['1', '2']": 57.4
    },
    "home_value": {
      "> $1,000,000": 71.5
    }
  }
}