Get prices for listings

POST

https://api.pricelabs.co/v1/listing_prices

POST

/v1/listing_prices

$ curl -X POST https://api.pricelabs.co/v1/listing_prices \
>      -H "X-API-Key: {{API_KEY}}" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "listings": [
>     {
>       "id": "ABCDEF",
>       "pms": "pms",
>       "dateFrom": "2023-01-01",
>       "dateTo": "2023-12-31",
>       "reason": true
>     },
>     {
>       "id": "12345",
>       "pms": "airbnb"
>     },
>     {
>       "id": "11051___123121",
>       "pms": "lodgify"
>     },
>     {
>       "id": "bcd32262-eb0d-4192-b2eb-3da30f380346",
>       "pms": "orbirental"
>     }
>   ]
> }'

1 [
2   {
3     "id": "PL111",
4     "pms": "test_pms",
5     "group": "",
6     "currency": "EUR",
7     "last_refreshed_at": "2023-07-13T08:17:53+00:00",
8     "los_pricing": {
9       "1": {
10         "los_night": "1",
11         "max_price": "",
12         "min_price": "",
13         "los_adjustment": "10"
14       },
15       "5": {
16         "los_night": "5",
17         "max_price": "",
18         "min_price": "",
19         "los_adjustment": "-5"
20       },
21       "7": {
22         "los_night": "7",
23         "max_price": "",
24         "min_price": "",
25         "los_adjustment": "-10"
26       },
27       "28": {
28         "los_night": "28",
29         "max_price": "",
30         "min_price": "",
31         "los_adjustment": "-20"
32       }
33     },
34     "data": [
35       {
36         "date": "2023-07-13",
37         "price": 93,
38         "user_price": 250,
39         "uncustomized_price": 93,
40         "min_stay": 2,
41         "booking_status": "",
42         "booking_status_STLY": "",
43         "ADR": -1,
44         "ADR_STLY": -1,
45         "unbookable": 1,
46         "booked_date": "-1",
47         "booked_date_STLY": "-1",
48         "weekly_discount": 0.9,
49         "monthly_discount": 0.8,
50         "extra_person_fee": 15,
51         "extra_person_fee_trigger": 6,
52         "check_in": true,
53         "check_out": false,
54         "demand_color": "#c0f1958c",
55         "demand_desc": "Low Demand",
56         "reason": {
57           "listing_info": {
58             "ADR": -1,
59             "avg_los": 0,
60             "num_bookings": 0,
61             "num_checkins": 0,
62             "num_checkouts": 0,
63             "booked_date": "-1",
64             "date_STLY": "2023-01-17",
65             "ADR_STLY": -1,
66             "avg_los_STLY": 0,
67             "num_bookings_STLY": 0,
68             "num_checkins_STLY": 0,
69             "num_checkouts_STLY": 0,
70             "booked_date_STLY": "-1",
71             "num_blocked": 0,
72             "occupancy": 0,
73             "max_price_limit": 99999,
74             "min_price_limit": 10,
75             "unbookable": 0,
76             "currency": "USD",
77             "price": "798",
78             "uncustomized_price": "1262",
79             "last_price": null,
80             "price_with_default_discounts": "798",
81             "locale": "en",
82             "OfficialAirbnb": 0,
83             "nhood_demand": "1",
84             "availability": "1",
85             "l_occupied": "0",
86             "minstay_seasonal_profile": "",
87             "nhood_occ": "20%",
88             "customized_price": "798",
89             "minimum_price": "600",
90             "maximum_price": "20000",
91             "base_price": "2000",
92             "base_price_type": "Listing",
93             "dso_flag": "0",
94             "seasonal_base_price_flag": "0"
95           }
96         },
97         "market_factors": {
98           "0": {
99             "key": "seasonality",
100             "value": "-32%",
101             "price": 1368,
102             "title": "Seasonality"
103           },
104           "1": {
105             "key": "demand_factor",
106             "value": "-8%",
107             "price": 1262,
108             "title": "Demand Factor",
109             "hotel_demand": "-0%",
110             "str_demand": "-8%"
111           }
112         },
113         "pricing_customizations": {
114           "0": {
115             "key": "last_min_factor",
116             "value": "-26%",
117             "price": 939,
118             "title": "Last Minute Price Factor (default)"
119           },
120           "1": {
121             "key": "listing_occ_pricing_factor",
122             "value": "-15%",
123             "price": 798,
124             "title": "Occupancy Based Adjustment (default)"
125           }
126         },
127         "thresholds": {
128           "0": {
129             "key": "min_price",
130             "value": 600,
131             "title": "Min Price (Safety)"
132           },
133           "1": {
134             "key": "max_price",
135             "value": 20000,
136             "title": "Max Price (Safety)"
137           }
138         },
139         "other_customizations": {},
140         "final_price_override": {},
141         "final_adjustments": {}
142       },
143       {
144         "date": "2023-07-14",
145         "price": 105,
146         "user_price": 250,
147         "uncustomized_price": 105,
148         "min_stay": 3,
149         "booking_status": "",
150         "booking_status_STLY": "",
151         "ADR": -1,
152         "ADR_STLY": -1,
153         "unbookable": 1,
154         "booked_date": "-1",
155         "booked_date_STLY": "-1",
156         "weekly_discount": 0.9,
157         "monthly_discount": 0.8,
158         "extra_person_fee": 15,
159         "extra_person_fee_trigger": 6,
160         "check_in": false,
161         "check_out": true,
162         "demand_color": "#c0f1958c",
163         "demand_desc": "Low Demand"
164       },
165       {
166         "date": "2023-07-15",
167         "price": 111,
168         "user_price": 250,
169         "uncustomized_price": 111,
170         "min_stay": 3,
171         "booking_status": "",
172         "booking_status_STLY": "",
173         "ADR": -1,
174         "ADR_STLY": -1,
175         "unbookable": 1,
176         "booked_date": "-1",
177         "booked_date_STLY": "-1",
178         "weekly_discount": 0.9,
179         "monthly_discount": 0.8,
180         "extra_person_fee": 15,
181         "extra_person_fee_trigger": 6,
182         "check_in": true,
183         "check_out": false,
184         "demand_color": "#c0f1958c",
185         "demand_desc": "Low Demand"
186       },
187       {
188         "date": "2023-07-16",
189         "price": 109,
190         "user_price": 250,
191         "uncustomized_price": 109,
192         "min_stay": 2,
193         "booking_status": "",
194         "booking_status_STLY": "",
195         "ADR": -1,
196         "ADR_STLY": -1,
197         "unbookable": 1,
198         "booked_date": "-1",
199         "booked_date_STLY": "-1",
200         "weekly_discount": 0.9,
201         "monthly_discount": 0.8,
202         "extra_person_fee": 15,
203         "extra_person_fee_trigger": 6,
204         "check_in": false,
205         "check_out": true,
206         "demand_color": "#c0f1958c",
207         "demand_desc": "Low Demand"
208       },
209       {
210         "date": "2023-07-17",
211         "price": 115,
212         "user_price": 250,
213         "uncustomized_price": 115,
214         "min_stay": 2,
215         "booking_status": "",
216         "booking_status_STLY": "",
217         "ADR": -1,
218         "ADR_STLY": -1,
219         "unbookable": 1,
220         "booked_date": "-1",
221         "booked_date_STLY": "-1",
222         "weekly_discount": 0.9,
223         "monthly_discount": 0.8,
224         "extra_person_fee": 15,
225         "extra_person_fee_trigger": 6,
226         "check_in": true,
227         "check_out": false,
228         "demand_color": "#c0f1958c",
229         "demand_desc": "Low Demand"
230       },
231       {
232         "date": "2023-07-18",
233         "price": 121,
234         "user_price": 250,
235         "uncustomized_price": 121,
236         "min_stay": 2,
237         "booking_status": "",
238         "booking_status_STLY": "",
239         "ADR": -1,
240         "ADR_STLY": -1,
241         "unbookable": 1,
242         "booked_date": "-1",
243         "booked_date_STLY": "-1",
244         "weekly_discount": 0.9,
245         "monthly_discount": 0.8,
246         "extra_person_fee": 15,
247         "extra_person_fee_trigger": 6,
248         "check_in": false,
249         "check_out": false,
250         "demand_color": "#c0f1958c",
251         "demand_desc": "Low Demand"
252       },
253       {
254         "date": "2023-07-19",
255         "price": 127,
256         "user_price": 250,
257         "uncustomized_price": 127,
258         "min_stay": 2,
259         "weekly_discount": 0.9,
260         "monthly_discount": 0.8,
261         "extra_person_fee": 15,
262         "extra_person_fee_trigger": 6,
263         "check_in": false,
264         "check_out": false,
265         "demand_color": "#c0f1958c",
266         "demand_desc": "Low Demand"
267       }
268     ]
269   }
270 ]

Get prices for listings in your PriceLabs account. Returns the last-refreshed price information for each listing.

Request

This endpoint expects an object.

listingslist of objectsRequired

Listings to fetch prices for. Each listing and its PMS must already exist in your PriceLabs account.

Response

Success

idstring

ID for the listing

pmsstring

PMS Name

groupstring

Listing group

currencystring

Currency for the listing

last_refreshed_atstring

DateTime when the listing was last refreshed in PL like when “Save & Refresh” is done. Also updated when sync happens as prices are refreshed before sync.

errorstring

Returned instead of price data when the request cannot be fulfilled for this listing

error_statusenum

Machine-readable error code. LISTING_NOT_PRESENT — listing does not exist in PriceLabs. LISTING_NO_DATA — prices were not fetched on PriceLabs. LISTING_TOGGLE_OFF — sync is turned OFF.

los_pricingobject

LOS pricing as defined in PL for the listing

datalist of objects

Daily price entries for the requested date range

Errors

400

Bad Request Error

Headers

Request

Response

Errors