0.6.0 (April 28, 2023)
- Refactor
financials
endpoint intofinancials
category - Refactor
inventory
endpoint intoinventory
category - Refactor
price_feed
endpoint intoprice_feed
category - Introduce
financials
history
endpoint - Introduce
inventory
history
endpoint - New market:
Broward County, FL
-->parcl_id
:5821600
- New market:
Reno City, NV
-->parcl_id
:5377231
Introduce Financials History Endpoint
Introducing financials history endpoint, accessible at https://api.realestate.parcllabs.com/v1/financials/:parclId/history
. Historical financial metrics go back to 1/31/2021
which includes data between 1/31/2020
through 1/31/2021
.
For example, a metric with a date of 1/31/2021
will include 365 days worth of price_feed
market data to calculate the average return, compound annual growth rate, annual volatility, etc. On 2/28/2021
365 days of data from February 28, 2021 will be utilized to calculate that set of metrics. Essentially this is a rolling year of data that is indexed at the end of each month.
Historical financials provides a monthly checkpoint of the prior year of key financials metrics about any given <parcl_id>
. These metrics include volatility, sharpe_ratio, compound annual growth rate, kurtosis, excess kurtosis, the relationship with 30 year mortgage rates, and whether they are outperforming the S&P 500.
The response object:
{
"parcl_id": 2900187,
"alpha_beta": {
"spy": [
{
"alpha": 1.7655,
"beta": -0.0001,
"date": "2021-01-31"
},
{
"alpha": 1.657,
"beta": 0.0005,
"date": "2021-02-28"
},
{
"alpha": 0.0498,
"beta": 0.0017,
"date": "2021-03-31"
}
]
},
"correlation_coefficient": {
"mortgage30us": [
{
"date": "2021-01-31",
"pricefeed_corr_coef_lag_2_weeks": -0.7946,
"pricefeed_corr_coef_lag_4_weeks": -0.7564,
"pricefeed_corr_coef_lag_6_weeks": -0.8029,
"pricefeed_corr_coef_lag_8_weeks": -0.7899
},
{
"date": "2021-02-28",
"pricefeed_corr_coef_lag_2_weeks": -0.77,
"pricefeed_corr_coef_lag_4_weeks": -0.7774,
"pricefeed_corr_coef_lag_6_weeks": -0.7293,
"pricefeed_corr_coef_lag_8_weeks": -0.5186
},
{
"date": "2021-03-31",
"pricefeed_corr_coef_lag_2_weeks": -0.6318,
"pricefeed_corr_coef_lag_4_weeks": -0.5135,
"pricefeed_corr_coef_lag_6_weeks": -0.2148,
"pricefeed_corr_coef_lag_8_weeks": 0.2187
}
]
},
"metrics": [
{
"annual_volatility": 0.0142,
"avg_return": 0.00036,
"cagr": 0.1383,
"date": "2021-01-31",
"excess_kurtosis": -3.75084,
"kurtosis": -0.75084,
"sharpe_ratio": 9.13887
},
{
"annual_volatility": 0.0144,
"avg_return": 0.00029,
"cagr": 0.113,
"date": "2021-02-28",
"excess_kurtosis": -4.30175,
"kurtosis": -1.30175,
"sharpe_ratio": 7.44464
},
{
"annual_volatility": 0.0142,
"avg_return": 0.00034,
"cagr": 0.1336,
"date": "2021-03-31",
"excess_kurtosis": -4.61503,
"kurtosis": -1.61503,
"sharpe_ratio": 8.86871
}
]
}
Introduce Inventory History Endpoint
Introducing our newest endpoint, accessible at https://api.realestate.parcllabs.com/v1/inventory/:parclId/history
Historical inventory provides an annual checkpoint going back to 2010
on the stock of available owner occupied units for any given <parcl_id>
, broken out by Single Family Residence, Townhome and Condo. This endpoint can be leveraged to calculate the trend in residential real estate growth over time.
The response object:
{
"parcl_id": 2900282,
"historical_inventory": [
{
"date": "2023-04-24",
"condo": 17039,
"single_family": 374484,
"townhouse": 53632,
"total_units": 445155
},
{
"date": "2022-12-31",
"condo": 16968,
"single_family": 372621,
"townhouse": 53271,
"total_units": 442860
},
{
"date": "2021-12-31",
"condo": 16894,
"single_family": 367050,
"townhouse": 52807,
"total_units": 436751
},
{
"date": "2020-12-31",
"condo": 16732,
"single_family": 357503,
"townhouse": 50836,
"total_units": 425071
}
]
}
Updated endpoint categories
Introduce 3 new endpoint categories (financials
, inventory
, and price_feed
) and refactor existing endpoints to new paths:
Old --> New
v1/place/<parcl_id>/price_feed --> v1/price_feed/<parcl_id>/history
v1/place/<parcl_id>/price_feed_stats --> v1/price_feed/<parcl_id>/stats
v1/place/price_feed_last --> v1/price_feed/latest
v1/parcls/<parcl_id>/financials --> v1/financials/<parcl_id>/current
v1/parcls/<parcl_id>/inventory --> v1/inventory/<parcl_id>/current