Retrieve a listing
- Irene Marín
get https://ws.icnea.net/analytics/listings/{listing_id}/
Use this endpoint to retireve an existing listing.
PATH PARAMS
listing_id string required | Listing ID. |
|---|
QUERY PARAMS
usr string required | API_key for your company, provided by Icnea. |
|---|
RESPONSES
200
{
"analytics_listing_response": {
"listing_id": 12341001,
"active": "true",
"name": "Casa Freya",
"internal_name": "C-Freya",
"property_type_group": "house",
"property_type_category": "villa",
"address": {
"city": "Pineda de Mar",
"zip": "08342",
"region": "Maresme",
"country": "ES"
},
"coordinates": {
"latitude": 2.34324324,
"longitude": 0.3243242343
},
"surface": 50,
"min_capacity": 1,
"max_capacity": 5,
"units": 1,
"owners": [
{
"unit_id": 1,
"owner_id": 9001,
"owner_name": "Francisco"
}
],
"groups": [
{
"group_id": 101,
"group_name": "Casas de lujo"
}
],
"bedrooms": 2,
"bathrooms": 1,
"toilets": 0,
"single_beds": 0,
"double_beds": 2,
"sofa_beds": 0,
"bunk_beds": 0,
"currency": "EUR",
"fees": {
"booking_fee": 0,
"cleaning_fee": 40,
"towels_fee": 0,
"bedlinen_fee": 0,
"internet_fee": 0,
"security_deposit": 200
},
"amenities": [ ... ],
"house_rules": [ ... ],
"views": [ ... ],
"distances": {
"city_center": 0,
"airport": 0,
"harbour": 0,
"railway_station": 0,
"public_transport": 0,
"hospital": 0,
"pharmacy": 0,
"market": 0,
"ski_slope": 0,
"beach": 0,
"golf": 0,
"public_park": 0,
"historic_district": 0
},
"reviews": [
{
"date": "2025-01-04",
"country": "ES",
"language": "en",
"channel": "Airbnb",
"booking_id": "102345",
"rating": {
"total": 9.2,
"location": 8,
"staff": 10,
"cleanliness": 10,
"comfort": 6,
"value": 8,
"accuracy": 0,
"communication": 0,
"surroundings": 0,
"tranquility": 0
}
}
]
}
}Parameter | Type | Description |
|---|---|---|
listing_id | integer | Property ID in Icnea. 8 digits for a production account, 5 digits for a test account. |
active | boolean |
|
name | string | Public name of the property (it will show in website and OTAs). |
internal_name | string | Internal name of the property, only used in the PMS. |
property_type_group | string | General type of property. Here you can see the list. |
property_type_category | string | Specific type of property. Here you can see the list. |
address | object |
|
surface | integer |
|
min_capacity | integer |
|
max_capacity | integer |
|
units | integer |
|
owners | array of objects |
|
groups | array of objects |
|
bedrooms | integer |
|
bathrooms | integer |
|
toilets | integer |
|
single_beds | integer |
|
double_beds | integer |
|
sofa_beds | integer |
|
bunk_beds | integer |
|
currency | string |
|
fees | object |
|
amenities | array of objects |
|
restrictions | array of objects |
|
views | array of objects |
|
distances | object |
|
reviews | array of objects |
|
address
Parameter | Type | Description |
|---|---|---|
city | string |
|
zip | string |
|
region | string |
|
country | string |
|
latitude | decimal |
|
longitude | decimal |
|
owners
Parameter | Type | Description |
|---|---|---|
unit_id | integer |
|
owner_id | integer |
|
owner_name | string |
|
groups
Parameter | Type | Description |
|---|---|---|
unit_id | integer |
|
owner_id | integer |
|
owner_name | string |
|
fees
Parameter | Type | Description |
|---|---|---|
booking_fee | integer |
|
cleaning_fee | integer |
|
towels_fee | integer |
|
bedlinen_fee | integer |
|
internet_fee | integer |
|
security_deposit | integer |
|
amenities
restrictions
views
distances
reviews
Parameter | Type | Description |
|---|---|---|
date | date |
|
country | string |
|
language | string |
|
channel | string |
|
booking_id | string |
|
rating | object |
|
rating
Parameter | Type | Description |
|---|---|---|
total | decimal |
|
location | integer |
|
staff | integer |
|
cleanliness | integer |
|
comfort | integer |
|
value | integer |
|
accuracy | integer |
|
communication | integer |
|
surroundings | integer |
|
tranquility | integer |
|
400
{
"analytics_listing_response": {
"error_code": "",
"error_message": ""
}
}Field | Type | Description |
|---|---|---|
error_code | string | Icnea internal error_id to help with debugging. |
error_message | string | Human readable description of error. |