Skip to content

▪ Basic Info

Pricing Tier Licence Type

Basic Info API returns basic information for a Point of Interest.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/poi/{poi_id}/data/basic

Path Parameters

Name                       Description Type Examples
*{billing_plan} Billing plan to be applied to the call. string licence
ondemand
*{account_id} Provided identifier of the account. string
*{poi_id} Identifier of the POI to retrieve data for.
Value obtainable either :
- if {billing_plan}= licence, from $.results[*].resource.id field of List Licences Response Body
- if {billing_plan}= ondemand, from $.results.pois[*].id field of any Search API Response Body.		 string XXeUNbmtYZTsH7UGvNfXWo

Header Parameters

Name                          Description Type Examples                         
*x-api-key Provided API key {x_api_key} that allows authentication. string
*Authorization Provided token {jwt_bearer} that allows authorization. string Bearer {jwt_bearer}
Example 
curl -X GET 'https://api.datappeal.io/v4/licence/account/{account_id}/poi/HF8xjSQW4W43NGr56denSh/data/basic' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Basic info has been successfully returned.

Body

BasicInfo

Field                     Description Type Examples
*id Hashed identifier of the POI. string Fx1iZYDScrSAy1yD57wktx
*name Description of the POI. string Albert Cuyp Market
*address Textual address of the POI along with its spatial coordinates. Address
:fontawesome-solid-exclamation-circle: *type Identifies the super-typology of the POI. string Dictionary
*category Identifies the sub-typology of the POI. string Dictionary
:fontawesome-solid-sync-alt: industry Identifies the super-typology of the POI. string Dictionary
rooms Number of rooms, only for POI with "type": "hotel". int 326
stars Hotel stars rating in the range [1,5], only for POI with "category": "hotel". int 4
picture URL of an image related to the POI. string https://media-cdn.tripadvisor.com/media/photo-s/0d/8f/e0/42/solarium.jpg
Address
Field Description Type Examples
*fullAddress Textual address. string Joulumaantie 1, 96930 Rovaniemi, Finland
*latitude Latitude expressed in the range [-90, 90]. decimal 66.54362
*longitude Longitude expressed in the range [-180, 180]. decimal 25.847197
Example 
{
    "address": {
        "fullAddress": "Via Montepellegrino, 62, 90142 Palermo PA, Italy",
        "latitude": 38.1394445,
        "longitude": 13.3574275
    },
    "id": "XXeUNbmtYZTsH7UGvNfXWo",
    "name": "Astoria Palace Hotel",
    "type": "hotel",
    "category": "hotel",
    "industry": "hospitality",
    "rooms": 326,
    "stars": 4,
    "picture": "https://dynamic-media-cdn.tripadvisor.com/media/photo-o/16/b8/2c/45/img-20190221-171241-largejpg.jpg?w=2400&h=-1&s=1"
}