YapQ City Name Search

GET

YapQ City Name Search

Amadeus has partnered with YapQ to bring you point of interest APIs with the goal of offering you unbiased ratings of landmarks and tourist attractions. YapQ rates these points according to their interest on social media and provides Wikipedia content and Geonames ID in a given city.
YapQ's service indexes millions of points around the world, and provides content in 12 different languages. This allows you to ensure you catch the must-see sights in a YapQ supported city.
Each point of interest comes with links to content, grading information, location and directions to help make discovering your destination easy and fun.

This service is still under active development, and the response format may change without warning. We'd be interested in your feedback - send us an email.

Resource URL

https://api.sandbox.amadeus.com/v1.2 /points-of-interest/yapq-search-text

Query Parameters


Name Values Description
apikey
(required)

API Key provided for your account, to identify you for API access. Make sure to keep this API key secret.

city_name
(required)

The name of the supported city for which you are searching, in the selected language.

lang

The preferred language of the content related to each point of interest. Content will be returned in this language if available

category

Filters the resulting points_of_interest to include only results which have a least one category containing the given provided word. Good examples are museum, landmark or church

geonames

Setting this to true includes only points of interest with a geonames ID

vibes

Includes content that doesn't correspond to an active physical place, but which gives the user some background information, or vibe for the place they are visiting. An example of this may be information on an influential demolished building that used to exist at a certain location, or more information on a district of the city

social_media

Enabling this includes images from Instagram in the output results. This is disabled by default, since these images are often just pictures of people or food, which often have little relevance to the actual location

image_size

The size of the images you'd like to see in the response

number_of_images

Number of images to display

number_of_results

The maximum number of points of interest to return in the results set. This is a range from 1 to 100


Request Body

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

 

PointsOfInterestResponse

  • current_city : PointOfInterestCity
  • points_of_interest : List

PointOfInterestCity

  • name : String
    The name of the location that was searched for
  • geoname_id : String
    The Geonames ID of the location that was searched for
  • location : Geolocation
  • total_points_of_interest : Integer
    The total number of points_of_interest that YapQ has indexed for this city

PointOfInterestResult

  • title : String
    Display name of a given point of interest
  • main_image : String
    A link to an image of the given location
  • location : Geolocation
  • grades : PointOfInterestResult_grades
  • categories : List
    Array of descriptions indicating what type of point of interest this is. You can filter the results to include only certain categories of point of interest using the category input parameter.
  • details : PointOfInterestDetails
  • contextual_images : List
    Images taken at this point of interest. Note that these images might have nothing to do with the point itself, particularly if you have enabled the social_media parameter
  • geoname_id : Integer
    The GeonamesID of this point of interest, if available

PointOfInterestDetails

  • short_description : String
    A summary of the given point
  • description : String
    A paragraph describing this point of interest
  • wiki_page_link : String
    A link to this point of interest's wikipedia page

PointOfInterestResult_grades

  • yapq_grade : Integer
    Main YAPQ grade. A grade out of 5 for this point, rated against all points in the world and normalized among selected group of points. 5 is best, 0 is worst.
  • city_grade : Integer
    The ranking of this point of interest compared to other points in this city. 1 is the highest rated.

Geolocation

  • latitude : BigDecimal
    The north-south coordinate of this location, in decimal degrees, between -90 and 90
  • longitude : BigDecimal
    The east-west coordinate of this location, in decimal degrees, between -180 and 180
  • google_maps_link : String
    For YapQ APIs only - a link to a google map rendering of this location.

ImageSize

  • small : Image
  • medium : Image
  • large : Image
  • hd : Image

Image

  • category : String
    The enumerated category of this image type. Common values include EXTERIOR, GUEST_ROOM, SUITE, LOBBY, RESTAURANT, LOUNGE, LOGO, MAP, MISC and UNKNOWN.
  • width : Integer
    The pixel width of the image at the provided URL.
  • height : Integer
    The pixel height of the image at the provided URL.
  • url : String
    The URL of the hotel image of this given category and size, for display.
 

Example - YapQ Search By City Name

Find popular zoos in New York City, with HD images

https://api.sandbox.amadeus.com/v1.2/points-of-interest/yapq-search-text?city_name=New%20York&image_size=HD&category=zoo&;apikey=<YOUR_API_KEY_HERE>

you will get a response that looks like this

{
    "points_of_interest": [
        {
            "main_image": "https://upload.wikimedia.org/wikipedia/commons/thumb/1/15/Central_Park_Zoo_area.jpg/400px-Central_Park_Zoo_area.jpg",
            "title": "Central Park Zoo",
            "contextual_images": [
                {
                    "hd": {
                        "url": "https://scontent.cdninstagram.com/t51.2885-15/s640x640/sh0.08/e35/12568216_911580198927440_703984693_n.jpg"
                    }
                },
                {
                    "hd": {
                        "url": "https://scontent.cdninstagram.com/t51.2885-15/s640x640/sh0.08/e35/12568716_743185055783719_1178162118_n.jpg"
                    }
                },
                {
                    "hd": {
                        "url": "https://scontent.cdninstagram.com/t51.2885-15/s640x640/sh0.08/e35/12568853_1553741831608193_1532918893_n.jpg"
                    }
                },
                {
                    "hd": {
                        "url": "https://scontent.cdninstagram.com/t51.2885-15/s640x640/sh0.08/e35/12519155_1742526809300319_61898108_n.jpg"
                    }
                }
            ],
            "geoname_id": 10338715,
            "grades": {
                "yapq_grade": 4.29,
                "city_grade": 38
            },
            "details": {
                "short_description": "The Central Park Zoo is a small 6.",
                "description": "The Central Park Zoo is a small 6.5-acre  zoo located in Central Park in New York City. It is part of an integrated system of four zoos and the New York Aquarium managed by the Wildlife Conservation Society , and is accredited by the Association of Zoos and Aquariums .\nThe zoo began in the 1860s as a menagerie, making it the first official zoo to open in New York. The zoo was modified in 1934, with the addition of many new buildings ranged in a quadrangle around the sea lion pool.  Finally, the zoo was renovated in the mid-1980s and reopened in 1988, replacing the old-fashioned cages with naturalistic environments.",
                "wiki_page_link": "https://en.wikipedia.org/wiki/Central Park Zoo"
            },
            "categories": [
                "Central Park",
                "Robert Moses projects"
            ],
            "location": {
                "latitude": 40.7678,
                "google_maps_link": "http://maps.google.com?q=40.7678,-73.9717",
                "longitude": -73.9717
            }
        },
        {
            "main_image": "https://upload.wikimedia.org/wikipedia/commons/thumb/7/7a/Bronx_Zoo_001.jpg/400px-Bronx_Zoo_001.jpg",
            "title": "Bronx Zoo",
            "contextual_images": [],
            "geoname_id": 6348798,
            "grades": {
                "yapq_grade": 3,
                "city_grade": 166
            },
            "details": {
                "short_description": "The Bronx Zoo is located in the Bronx, a borough of New York City, within Bronx Park.",
                "description": "The Bronx Zoo is located in the Bronx, a borough of New York City, within Bronx Park. It is among the largest metropolitan zoos in the world, and is the largest in North America, with some 6,000 animals representing about 650 species from around the world. The zoo comprises 265 acres  of park lands and naturalistic habitats, through which the Bronx River flows. The Bronx Zoo is part of an integrated system of four zoos and one aquarium managed by the Wildlife Conservation Society , and is accredited by the Association of Zoos and Aquariums .",
                "wiki_page_link": "https://en.wikipedia.org/wiki/Bronx Zoo"
            },
            "categories": [
                "1899 establishments in New York",
                "Beaux-Arts architecture in New York",
                "Buildings and structures in the Bronx",
                "Fordham, Bronx",
                "Heins and LaFarge buildings",
                "Landmarks in the Bronx",
                "Parks in the Bronx",
                "Visitor attractions in the Bronx",
                "Zoos established in 1899",
                "Zoos in New York City"
            ],
            "location": {
                "latitude": 40.8506,
                "google_maps_link": "http://maps.google.com?q=40.8506,-73.8754",
                "longitude": -73.8754
            }
        }
    ],
    "current_city": {
        "geoname_id": 5128581,
        "total_points_of_interest": 623,
        "name": "New York",
        "location": {
            "latitude": 40.71427,
            "longitude": -74.00597
        }
    }
}