Back to All

0.7.0 (May 12, 2023)

27 days ago by ReadMe API
  • Introduce financials/<parcl_id>/volatility endpoint
  • Refactor markets endpoint to include census designated regions, state FIPS, improved error messaging
  • Fix v1/price_feed/latest endpoint to return a 404 if no parcl_id is provided in the request.
  • Introduce sales/<parcl_id>/current and sales/<parcl_id>/history endpoints
  • Introduce listings/<parcl_id>/current endpoint
  • Introduce absorption/<parcl_id>/current endpoint

Introduce volatility endpoint

We are pleased to introduce financials/<parcl_id>/volatility endpoint and metric. The Price Feed Volatility metric - a new tool for tracking variations in the returns of real estate markets using the Parcl Labs Price Feed (PLPF) as its underlying metric. Our approach is consistent with that of the PLPF, employing a moving window defined for each market to account for local factors that may influence the market. After defining the window, we calculate the daily returns over the period, and determine the annualized standard deviation. This commonly-used metric enables investors and analysts to assess the level of risk associated with a particular market, and make well-informed decisions regarding potential investments. Ultimately, this tool is designed to help real estate professionals adjust their investment strategies as necessary to optimize risk and reward.

{
    "parcl_id": 2900187,
    "volatility": [
        {
            "date": "2023-05-05",
            "volatility": 0.030855
        },
        {
            "date": "2023-05-04",
            "volatility": 0.028155
        }
    ]
}

Refactor Markets Endpoint

Refactored markets endpoint to include Census designated regions, state FIPS codes, and full state names.

These changes are backwards compatible with the existing markets response object. The updated response object:

{
    "parcl_id": 2900142,
    "location_type": "MSA",
    "name": "Mobile",
    "state": "AL",
    "state_name": "Alabama",
    "state_fips_code": "01",
    "census_region": "East South Central"
}

Introduce Sales Current & History Endpoint

Introducing new endpoints, accessible at https://api.realestate.parcllabs.com/v1/sales/:parclId/current and https://api.realestate.parcllabs.com/v1/sales/:parclId/history

The sales endpoints return the number of homes sold in the last 30 days (from the date) for
any given <parcl_id>. The current endpoint returns the most recent sales data while the historical
endpoint dates back to 1/1/2020.

The Sales Current response object:

{
    "parcl_id": 2900282,
    "sales":
        {
            "date": "2023-05-03",
            "sales_30_day": 2217
        }
}

The Sales History response object:

{
    "parcl_id": 2900282,
    "historical_sales": [
        {
            "date": "2023-05-03",
            "sales_30_day": 2217
        },
        {
            "date": "2023-05-02",
            "sales_30_day": 2315
        },
        {
            "date": "2023-05-01",
            "sales_30_day": 2274
        },
        {
            "date": "2023-04-30",
            "sales_30_day": 2203
        },
    ]
}

Introduce Listings Current Endpoint

Introducing a new endpoint, accessible at https://api.realestate.parcllabs.com/v1/listings/:parclId/current

The listings endpoints return the number of unique homes listed in the last 30 days (from the date) for
any given <parcl_id>. The current endpoint returns the most recent listings data available.

The Listings Current response object:

{
    "parcl_id": 2900282,
    "sales":
        {
            "date": "2023-05-05",
            "listings_30_day": 7722
        }
}

Introduce Absorption Rate Current Endpoint

Introducing a new endpoint, accessible at https://api.realestate.parcllabs.com/v1/absorption/:parclId/current

The absorption rate endpoints return the rate at which homes are being sold relative to the number of homes available for sale
(homes sold over past 30 days from date / available homes over past 30 days from date) for any given <parcl_id>. The current
endpoint returns the most recent absorption rate available.

The Absorption Current response object:

{
    "parcl_id": 2900282,
    "absorption_rate":
        {
            "absorption_rate": 0.2,
            "date": "2023-05-07"
        }
}