Get neighborhood data for a listing | PriceLabs

{
  "data": {
    "Listings Used": 350,
    "currency": "EUR",
    "lat": 48.2041,
    "lng": 16.3697,
    "source": "airbnb",
    "Neighborhood Data Source": "Nearby Listings",
    "Future Percentile Prices": {
      "Category": {
        "0": {
          "Listings Used": 50,
          "Active Used": 50,
          "Inactive Used": 0,
          "X_values": [
            "2023-11-15",
            "2023-11-16",
            "2023-11-17"
          ],
          "Y_values": [
            [
              92.7,
              93.6,
              103.7
            ],
            [
              115.1,
              116.1,
              139
            ],
            [
              148.8,
              151.6,
              166.6
            ],
            [
              107.2,
              110.4,
              126.8
            ],
            [
              177.3,
              181.2,
              217.6
            ]
          ]
        },
        "1": {
          "Listings Used": 245,
          "Active Used": 245,
          "Inactive Used": 0,
          "X_values": [
            "2023-11-15",
            "2023-11-16",
            "2023-11-17"
          ],
          "Y_values": [
            [
              99.2,
              99.2,
              108.6
            ],
            [
              129.2,
              128.2,
              147.9
            ],
            [
              166.6,
              169.4,
              194.2
            ],
            [
              125.4,
              126.3,
              147.9
            ],
            [
              215.8,
              216.2,
              240.4
            ]
          ]
        }
      },
      "Labels": [
        "25th Percentile",
        "50th Percentile",
        "75th Percentile",
        "Median Booked Price",
        "90th Percentile"
      ]
    },
    "Future Occ/New/Canc": {
      "Category": {
        "0": {
          "Listings Used": 50,
          "Active Used": 50,
          "Inactive Used": 0,
          "X_values": [
            "2023-05-19",
            "2023-05-20",
            "2023-05-21"
          ],
          "Y_values": [
            [
              [
                87.5,
                80.4878,
                65.7143
              ]
            ],
            [
              [
                0,
                0,
                0
              ]
            ],
            [
              [
                0,
                0,
                0
              ]
            ],
            [
              [
                91.1765,
                100,
                94.1176
              ]
            ],
            [
              [
                91.1765,
                100,
                94.1176
              ]
            ],
            [
              [
                0,
                0,
                0
              ]
            ]
          ]
        }
      },
      "Labels": [
        "Occupancy",
        "New Bookings",
        "Canceled Bookings",
        "Occupancy_LY",
        "Occupancy_STLY",
        "New_Bookings_STLY"
      ]
    },
    "Summary Table Base Price": {
      "Category": {
        "0": {
          "Listings Used": 50,
          "Active Used": 50,
          "Inactive Used": 0,
          "Y_values": [
            98,
            126,
            171,
            199,
            [],
            []
          ]
        },
        "All": {
          "Listings Used": 350,
          "Y_values": [
            99,
            141,
            185,
            236,
            [],
            []
          ]
        }
      },
      "Labels": [
        "25th Percentile Price( EUR)",
        "50th Percentile Price( EUR)",
        "75th Percentile Price( EUR)",
        "90th Percentile Price( EUR)"
      ]
    }
  },
  "status": "Success"
}

Get neighborhood data for your listing with all stats shown on the Neighborhood Tab.

Query parameters

listing_idstringRequired

pmsstringRequired

use_default_dataenumOptionalDefaults to false

When true uses default data source instead of source selected on the UI.

Allowed values:

Response

Success

dataobject

Neighborhood data payload from the pricing engine (neighborhood_json).

statusstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

$	curl -G https://api.pricelabs.co/v1/neighborhood_data \
>	-H "X-API-Key: {{API_KEY}}" \
>	-d listing_id=SUNSETPROPS_OLSE___239 \
>	-d pms=vrm

Headers

Query parameters

Response

Errors