The Home Equity Summary API allows you to retrieve the summary of home equity information for a specific property. This API provides details such as available equity, total equity, loan information, and equity calculation parameters.

Endpoint

The endpoint for accessing the Home Equity Summary API is:

POST https://api.chimney.io/home-equity-summary

Request Body

The API request should include the following in the request body:

  • Content-Type: application/json

The request body should include the following fields:

  • address (string, required): The full address of the property, including city, state, and ZIP code.
  • maxLTV (string, optional): The maximum loan-to-value ratio allowed by the organization. If no value is entered, we default is set to .8.

Example:

{
  "address": "123 Main St, Anytown, USA 12345",
  "orgMaxLTV": "0.8",
}

Response

The API provides a response in the following structure:

{
  "Home Value Summary": {
    "chimneyEstimate": "1000000",
      "high": "1500000",
      "low": "900000"
    },
    "availableEquity": "120000",
    "totalEquity": "250000",
    "LTV": "0.52",
    "availableEquityRange": {
      "high": "150000",
      "low": "100000"
    },
    "totalLoanBalance": "130000",
    "totalLoanCount": 2
  },
  "Current Loans": {
    "primaryMortgage": {
      "exists": true,
      "balance": "80000",
      "ID": "123456"
    },
    "secondHomeLoan": {
      "exists": true,
      "balance": "50000",
      "ID": "789012"
    },
    "thirdHomeLoan": {
      "exists": false,
      "balance": null,
      "ID": null
    }
  }
}

The response contains information about the home equity summary, current loans, and equity calculation details.

Example Usage

Here's an example of how to make a POST request to the Home Equity Summary API endpoint:

curl --request POST \
  --url https://api.chimney.io/home-equity-summary \
 

 --header 'Content-Type: application/json' \
  --data '{
    "address": "123 Main St, Anytown, USA 12345"
    "maxLTV": "0.85",
  }'

Please note that you need to replace the example values with the actual values for the address and organization variables.