Get Revenue, ADR, and Occupancy metrics for a location | PriceLabs

{
  "KPIsByBedroomCategory": {
    "2": {
      "ADRAvg": 89,
      "ADR25Percentile": 64,
      "ADR75Percentile": 102,
      "Revenue": 11213,
      "AvgOccupancy": 46.73,
      "NoOfListings": 318,
      "MonthlyBreakup": {
        "Revenue": {
          "January": 1871,
          "February": 1289,
          "March": 1832,
          "April": 656,
          "May": 748,
          "June": 503,
          "July": 1164,
          "August": 1165,
          "September": 637,
          "October": 829,
          "November": 1187,
          "December": 1518
        },
        "ADRAvg": {
          "January": 95,
          "February": 94,
          "March": 111,
          "April": 77,
          "May": 87,
          "June": 76,
          "July": 72,
          "August": 74,
          "September": 64,
          "October": 82,
          "November": 79,
          "December": 84
        },
        "AvgOccupancy": {
          "January": 75.09,
          "February": 62.41,
          "March": 71.16,
          "April": 26.03,
          "May": 33.28,
          "June": 22.02,
          "July": 41.22,
          "August": 46.1,
          "September": 25.56,
          "October": 34.77,
          "November": 60.74,
          "December": 70.58
        },
        "NoOfListings": {
          "January": 192,
          "February": 193,
          "March": 211,
          "April": 216,
          "May": 218,
          "June": 285,
          "July": 179,
          "August": 179,
          "September": 182,
          "October": 180,
          "November": 207,
          "December": 208
        }
      }
    },
    "3": {
      "ADRAvg": 147,
      "ADR25Percentile": 103,
      "ADR75Percentile": 176,
      "Revenue": 21135,
      "AvgOccupancy": 49.48,
      "NoOfListings": 134,
      "MonthlyBreakup": {
        "Revenue": {
          "January": 3580,
          "February": 2239,
          "March": 3221,
          "April": 1095,
          "May": 1422,
          "June": 1051,
          "July": 2158,
          "August": 2082,
          "September": 1286,
          "October": 1026,
          "November": 2050,
          "December": 3080
        },
        "ADRAvg": {
          "January": 154,
          "February": 147,
          "March": 205,
          "April": 124,
          "May": 143,
          "June": 144,
          "July": 124,
          "August": 126,
          "September": 106,
          "October": 122,
          "November": 143,
          "December": 159
        },
        "AvgOccupancy": {
          "January": 77.92,
          "February": 57.57,
          "March": 59.76,
          "April": 24.67,
          "May": 34.38,
          "June": 19.79,
          "July": 57.77,
          "August": 60.79,
          "September": 30.46,
          "October": 38.24,
          "November": 67.66,
          "December": 73.82
        },
        "NoOfListings": {
          "January": 88,
          "February": 89,
          "March": 96,
          "April": 101,
          "May": 108,
          "June": 127,
          "July": 70,
          "August": 68,
          "September": 75,
          "October": 77,
          "November": 82,
          "December": 86
        }
      }
    },
    "4": {
      "ADRAvg": 159,
      "ADR25Percentile": 112,
      "ADR75Percentile": 192,
      "Revenue": 19501,
      "AvgOccupancy": 45.17,
      "NoOfListings": 22,
      "MonthlyBreakup": {
        "Revenue": {
          "January": 3498,
          "February": 2562,
          "March": 3096,
          "April": 1714,
          "May": 660,
          "June": 1354,
          "July": 1481,
          "August": 1658,
          "September": 1541,
          "October": 1290,
          "November": 1916,
          "December": 2739
        },
        "ADRAvg": {
          "January": 158,
          "February": 138,
          "March": 187,
          "April": 154,
          "May": 125,
          "June": 101,
          "July": 126,
          "August": 119,
          "September": 114,
          "October": 118,
          "November": 127,
          "December": 142
        },
        "AvgOccupancy": {
          "January": 74.17,
          "February": 60.13,
          "March": 56.35,
          "April": 10.25,
          "May": 16.21,
          "June": 29.05,
          "July": 46.81,
          "August": 42.33,
          "September": 22.55,
          "October": 38.97,
          "November": 67.7,
          "December": 71.92
        },
        "NoOfListings": {
          "January": 15,
          "February": 16,
          "March": 18,
          "April": 14,
          "May": 18,
          "June": 21,
          "July": 13,
          "August": 13,
          "September": 14,
          "October": 14,
          "November": 15,
          "December": 15
        }
      }
    }
  }
}

Either address or both lat and lng must be provided as location input.

Query parameters

latdoubleOptional

Latitude of the property location. Accepted range is -90 to +90. Required if address is not provided.

lngdoubleOptional

Longitude of the property location. Accepted range is -180 to +180. Required if address is not provided.

addressstringOptional

Full address of the property. Either address or both lat and lng must be provided.

currencystringRequired

Currency code for the revenue estimates (e.g. USD, EUR, GBP, INR, AUD).

bedroom_categoryintegerRequired

Number of bedrooms for the property. Use 0 for studio.

monthlybooleanOptional

When set to true, the response includes a MonthlyBreakup object with month-by-month KPIs. Defaults to false.

Response

Success

KPIsByBedroomCategorymap from strings to objects

Key Performance Indicators grouped by bedroom category. Returns data for n-1, n, and n+1 bedroom categories, where n is the requested bedroom_category.

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

500

Internal Server Error

502

Bad Gateway Error

$	curl -G https://api.pricelabs.co/v1/revenue/estimator \
>	-H "X-API-Key: {{API_KEY}}" \
>	-d currency=USD \
>	-d bedroom_category=3

Headers

Query parameters

Response

Errors