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

curl -G https://api.pricelabs.co/v2/revenue/estimator \
     -H "X-API-Key: {{API_KEY}}" \
     -d currency=USD \
     -d bedroom_category=3 \
     --data-urlencode "filters={"pool": 0, "hottub": 1, "ratings": {"gt": 2, "lt": 5}, "review_count": {"gt": 5}, "bathroom": {"gt": 2}, "max_guest": {"lt": 4}}"

{
  "KPIsByBedroomCategory": {
    "3": {
      "RevenueMonthlyAvg": 1179,
      "Revenue25PercentileSum": 6600,
      "Revenue50PercentileSum": 14100,
      "Revenue75PercentileSum": 23900,
      "Revenue90PercentileSum": 35400,
      "ADR90PercentileAvg": 185,
      "ADR75PercentileAvg": 144,
      "ADR50PercentileAvg": 104,
      "ADR25PercentileAvg": 70,
      "AvgAdjustedOccupancy": 45,
      "NoOfListings": 353,
      "MonthlyBreakup": {
        "Revenue25Percentile": {
          "January": 1437.2,
          "February": 338.6,
          "March": 1125.8,
          "April": 0,
          "May": 248.9,
          "June": 0,
          "July": 596.2,
          "August": 729.9,
          "September": 0,
          "October": 0,
          "November": 902.2,
          "December": 1301.6
        },
        "Revenue50Percentile": {
          "January": 2208,
          "February": 1293,
          "March": 2285.3,
          "April": 258.1,
          "May": 860.4,
          "June": 146.7,
          "July": 1509.2,
          "August": 1366.8,
          "September": 369.8,
          "October": 562.5,
          "November": 1341.8,
          "December": 1947
        },
        "Revenue75Percentile": {
          "January": 3350.7,
          "February": 2239.9,
          "March": 3475.8,
          "April": 957.9,
          "May": 1503.1,
          "June": 779.9,
          "July": 2224.6,
          "August": 2219.9,
          "September": 1302.6,
          "October": 1087.4,
          "November": 2063.5,
          "December": 2719.2
        },
        "Revenue90Percentile": {
          "January": 4739.6,
          "February": 3314.5,
          "March": 5008.9,
          "April": 1832,
          "May": 2171.2,
          "June": 1574,
          "July": 3141.3,
          "August": 3064.3,
          "September": 2121.1,
          "October": 1909,
          "November": 3029.4,
          "December": 3572.6
        },
        "ADR25Percentile": {
          "January": 83.7,
          "February": 46.5,
          "March": 106,
          "April": 0,
          "May": 58.4,
          "June": 0,
          "July": 62.7,
          "August": 60.4,
          "September": 0,
          "October": 0,
          "November": 68.9,
          "December": 79.5
        },
        "ADR50Percentile": {
          "January": 117.2,
          "February": 101.7,
          "March": 143.4,
          "April": 54.5,
          "May": 99.9,
          "June": 54.2,
          "July": 85.5,
          "August": 89.3,
          "September": 47.9,
          "October": 61.1,
          "November": 91.7,
          "December": 106.7
        },
        "ADR75Percentile": {
          "January": 155.9,
          "February": 142.3,
          "March": 194,
          "April": 98.3,
          "May": 139.2,
          "June": 98,
          "July": 120.8,
          "August": 124,
          "September": 91.4,
          "October": 95.8,
          "November": 131.5,
          "December": 145.7
        },
        "ADR90Percentile": {
          "January": 210.6,
          "February": 173.1,
          "March": 228.2,
          "April": 143.1,
          "May": 185.9,
          "June": 130.3,
          "July": 157.1,
          "August": 155.8,
          "September": 131.4,
          "October": 137.7,
          "November": 180.7,
          "December": 189.5
        },
        "AvgOccupancy": {
          "January": 82.1,
          "February": 58.6,
          "March": 67.7,
          "April": 10,
          "May": 26.7,
          "June": 7.4,
          "July": 66.7,
          "August": 61.3,
          "September": 15.4,
          "October": 22.4,
          "November": 56.3,
          "December": 75
        },
        "Occ25Percentile": {
          "January": 60,
          "February": 14.4,
          "March": 37,
          "April": 0,
          "May": 7.4,
          "June": 0,
          "July": 20.8,
          "August": 34.8,
          "September": 0,
          "October": 0,
          "November": 33.3,
          "December": 56
        },
        "Occ75Percentile": {
          "January": 93,
          "February": 92.2,
          "March": 86.2,
          "April": 47.2,
          "May": 55.6,
          "June": 32.1,
          "July": 87.1,
          "August": 82.7,
          "September": 60,
          "October": 61.3,
          "November": 85.5,
          "December": 91.5
        },
        "NoListingUsed": {
          "January": 203,
          "February": 194,
          "March": 217,
          "April": 214,
          "May": 221,
          "June": 226,
          "July": 183,
          "August": 162,
          "September": 139,
          "October": 160,
          "November": 162,
          "December": 198
        }
      },
      "bedrooms_considered": [
        "3"
      ]
    }
  }
}

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.

filtersstringOptional

A JSON string containing filter criteria to narrow comparable listings. Pass as a JSON string, not a JSON object. Supported keys:

pool (0 or 1) — Filter by pool availability
hottub (0 or 1) — Filter by hot tub availability
ratings ({“gt”: n, “lt”: n}) — Filter by listing ratings range
review_count ({“gt”: n, “lt”: n}) — Filter by review count range
bathroom ({“gt”: n, “lt”: n}) — Filter by number of bathrooms range
max_guest ({“gt”: n, “lt”: n}) — Filter by maximum guest capacity range

Example value (pass as a JSON string, not a JSON object):

'{"pool": 0, "hottub": 1, "ratings": {"gt": 2, "lt": 5}, "review_count": {"gt": 5}, "bathroom": {"gt": 2}, "max_guest": {"lt": 4}}'

A JSON string containing filter criteria to narrow comparable listings. Pass as a JSON string, not a JSON object. Supported keys: - **pool** (0 or 1) — Filter by pool availability - **hottub** (0 or 1) — Filter by hot tub availability - **ratings** ({"gt": n, "lt": n}) — Filter by listing ratings range - **review_count** ({"gt": n, "lt": n}) — Filter by review count range - **bathroom** ({"gt": n, "lt": n}) — Filter by number of bathrooms range - **max_guest** ({"gt": n, "lt": n}) — Filter by maximum guest capacity range **Example value (pass as a JSON string, not a JSON object):** ``` '{"pool": 0, "hottub": 1, "ratings": {"gt": 2, "lt": 5}, "review_count": {"gt": 5}, "bathroom": {"gt": 2}, "max_guest": {"lt": 4}}' ```

Response

Success

KPIsByBedroomCategorymap from strings to objects

KPI metrics for the requested bedroom category. Each key represents the bedroom count passed in the bedroom_category parameter. For bedroom categories >= 5, if there are not enough listings, data from +/-1 bedroom categories is aggregated. The bedrooms_considered field shows which categories were used.

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

500

Internal Server Error

502

Bad Gateway Error

Headers

Query parameters

Response

Errors