Triposo API Documentation - 20200803

Request/response format

Requests to the API should be made as an HTTPS GET to a URL in the following format:

https://www.triposo.com/api/20200803/endpoint.json?parameters

The response in the case of success will be JSON in the following format:

{
  "results": [an array of objects according to the return type of the endpoint],
  "more": true if there are more objects that could be retrieved using a higher offset or a larger count
}

In case of an error, an appropriate HTTP error code will be set and the body of the response will be JSON in the following format:

{
  "code": an error code,
  "error": a string explaining the error
}

Authentication information can either be supplied as account and token parameters, containing your account ID and a valid token respectively, or using the X-Triposo-Account and X-Triposo-Token HTTP headers.

Endpoints

article /api/20200803/article.json Credit cost 1

retrieve article about a subject

Return type

article

Parameters

Name Query type Required? Deprecated? Default value Description
annotate exact no no add a value to each returned object; possible annotations are defined on each model
count exact no no 10 the maximum number of objects to return (max: 100)
countrycode exact no no select objects within a country specified by two-letter ISO country code
exclude_fields exact no no a comma-separated list of fields not to return, either from the default fields or from all fields if fields=all is specified
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
id exact_list_or_negated no no the machine-readable identifier for this article
language exact no no en set preferred language
location_ids contains_location no no the locations that this article applies to
offset exact no no 0 the index of the object in the result set to start from
order_by exact no no the field to order the results by (the field must be orderable). for reverse order prefix the field name with "-"
poi_id exact no no retrieving related articles by specifying one or more POI IDs, for now only applicable to museums and articles about artworks
score range no no an indicator of the importance of the article, generally between 0 and 10 but best suited to relative comparisons and ordering
tag_labels contains_tag no no the labels of the tags that apply to this article
type exact_negatable no no the type of the article
us_statecode exact no no select objects specified by two-letter US state code

Possible values for 'type'

animal articles about animals
art articles about works of art
background background articles
cuisine articles about dishes and cuisines
festival articles about festivals
language_description main articles about a language
language_phrasebook articles containing a phrasebook for a language
language_pronunciation articles about the pronunciation of a language

city_walk /api/20200803/city_walk.json Credit cost 12

create a city walk for a certain city

Return type

city_walk

Parameters

Name Query type Required? Deprecated? Default value Description
exclude_poi_fields exact no no a comma-separated list of fields not to return, either from the default fields or from all fields if poi_fields=all is specified
exclude_poi_ids exact no no a comma-separated list of ids of the POIs you do not want to include in the city walk
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
go_inside exact no no True boolean to decide if you want to enter the POIs encountered en route, default true
include_poi_ids exact no no a comma-separated list of ids of the POIs you want to include in the city walk
latitude exact no no latitude of starting point
location_id exact yes no the id of the city for which you want to create a walk
longitude exact no no longitude of the starting point
optimal exact no no false boolean to only use the top POIs in the city, default false. When true no random factor is used in the calculation
poi_fields exact no no a comma-separated list of return fields for the POI objects
seed exact no no unsigned integer used for seeding a random factor in the creation of the city walk. It can be used to retrieve specific past responses
tag_labels contains_tag no no only include POIs matching these tag labels (otherwise all are included). use | for OR and ! for NOT. for AND, specify the parameter multiple times
total_time exact yes no maximum length of the city walk in minutes. (min=20 max=360)
type exact no yes sightseeing type of city walk (sightseeing, pub_crawl), default sightseeing (deprecated - use tag_labels instead)

common_tag_labels /api/20200803/common_tag_labels.json Credit cost 0

retrieves list of common tag labels that can be used to filter API responses

Return type

common_tag_label

Parameters

Name Query type Required? Deprecated? Default value Description
annotate exact no no add a value to each returned object; possible annotations are defined on each model
exclude_fields exact no no a comma-separated list of fields not to return, either from the default fields or from all fields if fields=all is specified
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
language exact no no en set preferred language
order_by exact no no the field to order the results by (the field must be orderable). for reverse order prefix the field name with "-"

day_planner /api/20200803/day_planner.json Credit cost 10

produce an itinerary for one or more days for a particular location

Return type

day_plan

Parameters

Name Query type Required? Deprecated? Default value Description
arrival_time exact no no 08:00 the arrival time on the first day in HH:MM format
departure_time exact no no 22:00 the departure time on the last day in HH:MM format
end_date exact no no the date of the last day of the itinerary in YYYY-mm-dd format (default is the day after start_date)
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
hotel_poi_id exact no no the optional POI ID of the hotel, to plan the day(s) around staying at this hotel
items_per_day exact no no 4 how many sightseeing items to include in the itinerary per day
latitude exact no no the latitude of the location to plan the day(s) around (leave blank if hotel_poi_id is specified)
location_id exact yes no the ID of the location to plan day(s) in
longitude exact no no the longitude of the location to plan the day(s) around (leave blank if hotel_poi_id is specified)
max_distance exact no no 500 the preferred maximum distance in metres for the itinerary to travel from one POI to another POI
seed exact no no unsigned integer used for seeding a random factor in the creation of the day plan. It can be used to retrieve specific past responses
start_date exact no no the date of the first day of the itinerary in YYYY-mm-dd format (default is today)

local_highlights /api/20200803/local_highlights.json Credit cost 8

create a optimized set of POIs centered around a coordinate, the resulting POIs are annotated with distance to the coordinate

Return type

local_highlights

Parameters

Name Query type Required? Deprecated? Default value Description
exclude_poi_fields exact no no a comma-separated list of fields not to return, either from the default fields or from all fields if poi_fields=all is specified
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
latitude exact yes no latitude of center point
longitude exact yes no longitude of center point
max_distance exact no no 700 maximum distance in meters to the center point for the POIs, default 700 meters
poi_fields exact no no a comma-separated list of return fields for the POI objects
tag_labels contains_tag no no only include POIs matching these tag labels (otherwise all are included). use | for OR and ! for NOT. for AND, specify the parameter multiple times

local_score /api/20200803/local_score.json Credit cost 10

calculate local scores for a set of coordinates

Return type

local_score

Parameters

Name Query type Required? Deprecated? Default value Description
coordinates exact yes no coordinates of the points for which the local score will be calculated (latitude,longitude), parameter can be specified up to 10 times
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.

location /api/20200803/location.json Credit cost 2

retrieve information about locations such as cities and countries

Return type

location

Parameters

Name Query type Required? Deprecated? Default value Description
also_visited exact no no selects locations that are also visited by people who visit the location specified by this parameter. Adds a field "also_visited_score" with value 0..1 to each returned location, indicating how likely it is that a person who has visited the specified location has also visited the returned location
annotate exact no no add a value to each returned object; possible annotations are defined on each model
child_tag_labels contains_tag no no filter based on the labels of tags contained within this location
count exact no no 10 the maximum number of objects to return (max: 100)
countrycode exact no no select objects within a country specified by two-letter ISO country code
exclude_fields exact no no a comma-separated list of fields not to return, either from the default fields or from all fields if fields=all is specified
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
id exact_list_or_negated no no the machine-readable identifier for the location
language exact no no en set preferred language
musement_locations exact no no list of musement locations associated with this location
offset exact no no 0 the index of the object in the result set to start from
order_by exact no no the field to order the results by (the field must be orderable). for reverse order prefix the field name with "-"
parent_id exact_negatable no no the ID of the parent location
part_of exact_negatable no no the ancestor locations (country, region, etc.) that this location is part of
score range no no an indicator of the importance of the location, generally between 0 and 10 but best suited to relative comparisons and ordering
tag_labels contains_tag no no the labels of the tags that apply to this location
type exact_list_or_negated no no the general type of this location
us_statecode exact no no select objects specified by two-letter US state code

Annotations

Name Description Result type Result query type Result orderable? Result nullable? Annotates the score?
distance annotate each result object with its distance in metres from a specified point or line integer range True False False
 

Syntax:

annotate=distance:[a point as decimal latitude,longitude, or a line as a sequence of decimal latitude,longitude pairs separated by commas, or a polyline encoded in the Google format]
trigram annotate each result object with the trigram similarity (0..1) of its name to a string float range True False False
 

Syntax:

annotate=trigram:[string to compare the name field to]

Possible values for 'type'

city a city
city_state a city-state
country a country
island an island
national_park a national park
region a region

poi /api/20200803/poi.json Credit cost 2

retrieve information about points of interest

Return type

poi

Parameters

Name Query type Required? Deprecated? Default value Description
annotate exact no no add a value to each returned object; possible annotations are defined on each model
bookable exact no no specifying a value of 1 or true restricts results to bookable POIs
count exact no no 10 the maximum number of objects to return (max: 100)
countrycode exact no no select objects within a country specified by two-letter ISO country code
exclude_fields exact no no a comma-separated list of fields not to return, either from the default fields or from all fields if fields=all is specified
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
has_similarity exact no no specifying a value of 1 or true restricts results to POIs that have a similarity dimension, i.e. that can be used for similarity queries
id exact_list_or_negated no no the machine-readable identifier of this POI
language exact no no en set preferred language
location_id contains_location no no the ID of the nominal location for this POI, which may be different from any location specified in the query - see also the location_ids field
musement_venue_id exact_negatable no no Musement venue identifier for this POI
offset exact no no 0 the index of the object in the result set to start from
order_by exact no no the field to order the results by (the field must be orderable). for reverse order prefix the field name with "-"
score range no no an indicator of the importance of this POI, generally between 0 and 10 but best suited to relative comparisons and ordering
tag_labels contains_tag no no the labels of the tags that apply to this POI
us_statecode exact no no select objects specified by two-letter US state code

Annotations

Name Description Result type Result query type Result orderable? Result nullable? Annotates the score?
distance annotate each result object with its distance in metres from a specified point or line integer range True False False
 

Syntax:

annotate=distance:[a point as decimal latitude,longitude, or a line as a sequence of decimal latitude,longitude pairs separated by commas, or a polyline encoded in the Google format]
persona annotate each object with the persona specific score with the property name persona_xxx_score float range True False True
 

Syntax:

annotate=persona:[name of persona (food_lover, culture_buff, nature, party, shopper, budget, mid_range, splurge, family, couples) for which to add a score]
similarity annotate each object with the similarity score (-1..1) compared with the given object float range True True False
 

Syntax:

annotate=similarity:[id of the object with which the comparison is made]
trigram annotate each result object with the trigram similarity (0..1) of its name to a string float range True False False
 

Syntax:

annotate=trigram:[string to compare the name field to]

property /api/20200803/property.json Credit cost 1

retrieve information about metadata relating to locations, POIs or tours

Return type

property

Parameters

Name Query type Required? Deprecated? Default value Description
annotate exact no no add a value to each returned object; possible annotations are defined on each model
count exact no no 10 the maximum number of objects to return (max: 100)
exclude_fields exact no no a comma-separated list of fields not to return, either from the default fields or from all fields if fields=all is specified
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
key exact_negatable no no a machine-readable identifier for this property (unique for the POI, tour or location that the property relates to)
language exact no no en set preferred language
location_id exact_negatable no no the ID of the location this property applies to, if it applies to one
offset exact no no 0 the index of the object in the result set to start from
order_by exact no no the field to order the results by (the field must be orderable). for reverse order prefix the field name with "-"
poi_id exact_negatable no no the ID of the POI this property applies to, if it applies to one
tour_id exact_negatable no no the ID of the tour this property applies to, if it applies to one

source /api/20200803/source.json Credit cost 0

retrieve information about sources and the way to attribute them

Return type

source

Parameters

Name Query type Required? Deprecated? Default value Description
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
id exact no no the machine-readable identifier of the source

tag /api/20200803/tag.json Credit cost 2

retrieve information about tags and the tag labels that correspond to POIs, tours and articles

Return type

tag

Parameters

Name Query type Required? Deprecated? Default value Description
ancestor_label exact_negatable no no retrieve tags that have the given tag label as an ancestor
annotate exact no no add a value to each returned object; possible annotations are defined on each model
article_count range no no the number of articles that have this tag
child_label exact_negatable no no retrieve tags that have the given tag label as a direct child
count exact no no 10 the maximum number of objects to return (max: 100)
countrycode exact no no select objects within a country specified by two-letter ISO country code
descendant_label exact_negatable no no retrieve tags that have the given tag label as a descendant
exclude_fields exact no no a comma-separated list of fields not to return, either from the default fields or from all fields if fields=all is specified
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
internal exact_or_any no no false whether or not this tag is intended for internal use (i.e. usually shouldn't be exposed to end users)
label exact_negatable no no a machine-readable label for this tag - only unique within a location_id
language exact no no en set preferred language
location_id exact_negatable no no the ID of the location this tag applies to
offset exact no no 0 the index of the object in the result set to start from
order_by exact no no the field to order the results by (the field must be orderable). for reverse order prefix the field name with "-"
parent_label exact_negatable no no retrieve tags that have the given tag label as a direct parent
poi_count range no no the number of POIs that have this tag
related_labels exact no no filter tags based on overlap in POIs, locations, articles or tours with other tags
score range no no the score of this tag, between 0 and a bit more than 10
tour_count range no no the number of tours that have this tag
us_statecode exact no no select objects specified by two-letter US state code

tour /api/20200803/tour.json Credit cost 1

retrieve information about bookable tours

Return type

tour

Parameters

Name Query type Required? Deprecated? Default value Description
annotate exact no no add a value to each returned object; possible annotations are defined on each model
count exact no no 10 the maximum number of objects to return (max: 100)
countrycode exact no no select objects within a country specified by two-letter ISO country code
exclude_fields exact no no a comma-separated list of fields not to return, either from the default fields or from all fields if fields=all is specified
fields exact no no a comma-separated list of fields to return, "all" to return all fields or as type:comma-separated list of fields to specify fields for a specific type. The parameter may be specified multiple times in order to specify the fields for different types.
id exact_list_or_negated no no the machine-readable identifier of this tour
language exact no no en set preferred language
location_ids contains_location no no the locations that this tour is related to
offset exact no no 0 the index of the object in the result set to start from
order_by exact no no the field to order the results by (the field must be orderable). for reverse order prefix the field name with "-"
poi_id exact no no retrieve tours associated with this POI ID. if no order_by is specified, tours will be ordered by their relevance to that POI (most relevant first)
price_is_per_person exact no no if true, it means that the price is the same for each person going on the tour. if false, it usually means that the prices for the second, third, etc. people are discounted in some way
score range no no an indicator of the importance of this tour, generally between 0 and 10 but best suited to relative comparisons and ordering
tag_labels contains_tag no no the labels of the tags that apply to this tour
us_statecode exact no no select objects specified by two-letter US state code
vendor exact_negatable no no the vendor offering this tour (viator, withlocals, bemyguest, tiqets, musement)

Annotations

Name Description Result type Result query type Result orderable? Result nullable? Annotates the score?
converted_price annotate each object with its price converted into a specified currency price range True False False
 

Syntax:

annotate=converted_price:[currency to convert the price to]
persona annotate each object with the persona specific score with the property name persona_xxx_score float range True False True
 

Syntax:

annotate=persona:[name of persona (food_lover, culture_buff, nature, party, shopper, budget, mid_range, splurge, family, couples) for which to add a score]
trigram annotate each result object with the trigram similarity (0..1) of its name to a string float range True False False
 

Syntax:

annotate=trigram:[string to compare the name field to]

Types

article

longer-form content related mostly to information about a location or a tag but could also be about works of art, composers etc.

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
content content the content of this article yes no yes no no
id string the machine-readable identifier for this article no no yes no no
intro string a medium-length version of the content of this article no no no yes yes
intro_language_info language_info information regarding the language of intro no no no yes no
location_ids string[] the locations that this article applies to no no no no no
name string a human-readable title for this article no no yes no yes
name_language_info language_info information regarding the language of name no no yes yes no
pois poi[] POIs associated with this article, for now only museums associated with an artwork no no no no no
score float an indicator of the importance of the article, generally between 0 and 10 but best suited to relative comparisons and ordering no yes yes no no
snippet string a short version of the content of this article no no yes yes yes
snippet_language_info language_info information regarding the language of snippet no no yes yes no
structured_content structured_content the structured content of this article (no machine translation) no no yes no yes
structured_content_language_info language_info information regarding the language of structured_content no no yes yes no
tag_labels string[] the labels of the tags that apply to this article no no no no no
tags tag_with_score[] the full tags that apply to this article no no no no no
type article_type the type of the article no no no no no

article_type

the general type of an article

attribution

attribution information for a specific piece of content

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
source_id string the ID of the source no no yes no no
url string the URL for this content at the source no no yes yes no

booking_info

information describing a bookable object

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
price price the cost of booking this object no no yes yes no
vendor vendor_identifier the vendor of this object (tour / hotel / restaurant) no no yes no no
vendor_object_id string the ID of this object in the vendor's system no no yes no no
vendor_object_url string the URL of this object on the vendor's website no no yes no no

boolean

"true" or "false"

city_walk

a city walk for a certain city

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
seed integer seed used to generate this city walk no no yes yes no
total_duration integer estimated duration of the city walk in minutes no no yes no no
walk_distance integer estimated length of the city walk in meters no no yes no no
walk_duration integer estimated duration of the walking part of the city walk in minutes no no yes no no
way_points way_point[] no no yes no no

climate

climate information

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
temperature climate_temperature climate information concerning temperature of the location no no yes yes no

climate_statistic

climate statistic

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
months float[] values for each month no no yes yes no

climate_temperature

climate information concerning temperature

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
average_max climate_statistic average daily maximum temperature in degrees Celsius no no yes yes no
average_min climate_statistic average daily minimum temperature in degrees Celsius no no yes yes no

common_tag_label

describes a common tag label

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
description string a description for this tag label no no yes yes yes
id string a machine-readable label for this tag label no yes yes no no
internal boolean whether or not this tag label is intended for internal use (i.e. usually shouldn't be exposed to end users) no no yes no no
name string a human-readable name for this tag label no no yes no yes
parents string[] the parent tag labels of this tag label no no yes no no

content

content, including attribution information

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
attribution attribution[] the attribution needed for this content no no yes no no
sections section[] the sections of this content no no yes no no
title string title of this content no no yes no no

day_plan

a planned itinerary for several days spent in a location

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
days itinerary[] day by day description of the day plan no no yes no no
hotel poi hotel description where the day plan is based from, if supplied no no yes yes no
location location location in which the walk takes place no no yes no no
seed integer seed used to generate this dayplan no no yes yes no

day_time

a description of a time in hours and minutes

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
hour integer number of hours of the time (24 hours based) no no yes no no
minute integer number of minutes of the time no no yes no no

duration_unit

the units of a duration

float

a floating-point number

image

an image, including metadata

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
attribution image_attribution attribution information for this image no no yes no no
caption string a suitable caption for this image no no yes yes no
license string the identifier of the license for this image (deprecated - use attribution field instead) yes no yes yes no
owner string the copyright owner of this image (deprecated - use attribution field instead) yes no yes no no
owner_url string the URL for the copyright owner of this image (deprecated - use attribution field instead) yes no yes no no
sizes image_sizes the available sizes for this image no no yes no no
source_id string the ID of the source for this image no no yes no no
source_url string where the image was found on the Web no no yes no no

image_attribution

attribution information for an image

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
attribution_link string the URL which the attribution text should link to no no yes no no
attribution_text string text to display in order to properly attribute the image no no yes no no
format string the format in which to attribute. The following substitutions need to be made: {attribution} needs to be substituted by the attribution_text and needs to link to the attribution_link URL, {license} needs to be substituted by the license_text and needs to link to the license_link URL, if license_link is set no no yes no no
license_link string the URL which the license text should link to no no yes yes no
license_text string the license text to display for the image no no yes yes no

image_format

the format of an image

image_size

metadata for a particular size of an image

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
bytes integer size of image in bytes no no yes no no
format image_format the format of the image no no yes no no
height integer height of image no no yes no no
url string url for image no no yes no no
width integer width of image no no yes no no

image_sizes

available sizes for an image

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
medium image_size image with largest dimension up to 640 pixels no no yes yes no
original image_size image in its original size no no yes no no
thumbnail image_size image with largest dimension up to 192 pixels no no yes no no

integer

an integer

itinerary

a planned itinerary for a day spent in a location

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
date string the date that the itinerary is for, in YYYY-mm-dd format no no yes no no
itinerary_items itinerary_item[] the items of the itinerary for this date no no yes no no

itinerary_item

an item on a planned itinerary

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
description string a longer description of this itinerary item no no yes no no
poi poi the POI object corresponding to this itinerary item no no yes no no
title string a title for this itinerary item no no yes no no

language_code

two-letter language code

language_info

information about translated content

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
language language_code the language the returned content is in (not necessarily requested language, if translation was not performed) no no yes no no
original_language language_code the original language of the content no no yes no no
translation_provider translation_provider the provider used for translation, if translation was performed no no yes yes no

local_highlights

a local guide centered around a lat/lng

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
poi_division poi_division_element[] which POIs were selected for which tag_labels no no yes no no
pois poi[] POIs which are local highlights, annotated with distance to specified point no no yes no no

local_score

the local score for a given set of tag labels

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
coordinates point coordinate of the point for which the scores are calculated no no yes no no
scores tag_label_with_score[] list of local scores per tag_label no no yes no no

location

describes cities, countries, islands, national parks and regions

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
attribution attribution[] information about the sources this content came from no no yes no no
climate climate climate information for the location no no no yes no
content content content describing this location yes no no yes no
coordinates point a point representing the geographical position of the location no no yes no no
country_id string the location ID of the country this location is contained within no no yes no no
id string the machine-readable identifier for the location no no yes no no
images image[] images of this location no no yes no no
intro string a medium-length string describing the location no no no yes yes
intro_language_info language_info information regarding the language of intro no no no yes no
musement_locations musement_location[] list of musement locations associated with this location no no no no no
name string the human-readable name of the location (in user's language where possible) no yes yes no yes
names string[] list of alternate names for this location no no no no no
parent_id string the ID of the parent location no no yes yes no
part_of string[] the ancestor locations (country, region, etc.) that this location is part of no no no no no
properties property[] the properties related to this location no no no no no
public_transport_maps image[] public transport maps for this location (currently available only for select cities) no no no no no
score float an indicator of the importance of the location, generally between 0 and 10 but best suited to relative comparisons and ordering no yes yes no no
snippet string a short string describing the location no no yes yes yes
snippet_language_info language_info information regarding the language of snippet no no yes yes no
structured_content structured_content structured content describing this location (no machine translation) no no no yes yes
structured_content_language_info language_info information regarding the language of structured_content no no no yes no
tag_labels string[] the labels of the tags that apply to this location no no no no no
tags tag_with_score[] the full tags that apply to this location no no no no no
type location_type the general type of this location no no yes no no

location_type

the general type of a location

musement_location

describes a Musement location

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
district_tag string optional tag to identify a district/suburb inside the Triposo location that this Musement location is referring to no no yes yes no
location_id string the ID of the Triposo location associated with this Musement location no no yes no no
musement_id string the ID of the Musement location no no yes no no
name string the name of the Musement location no no yes no no

opening_hours

structured representation of opening hours

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
days time_ranges_by_day collection of days with the information about the time ranges on that day no no yes no no
open_24_7 boolean boolean indicating if a POI is open 24/7 no no yes no no

poi

points of interest

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
attribution attribution[] information about the sources this content came from no no yes no no
best_for tag[] the tags for which this POI is best within the location no no no no no
booking_info booking_info information needed to book this POI (whether it's a hotel, a place that has entrance tickets, or a restaurant) no no yes yes no
content content content related to this POI yes no no yes no
coordinates point the geographical location of this POI no no yes no no
facebook_id string Facebook identifier for this POI no no no yes no
id string the machine-readable identifier of this POI no no yes no no
images image[] images of this POI no no yes no no
intro string a medium-length version of the content no no no yes yes
intro_language_info language_info information regarding the language of intro no no no yes no
location_id string the ID of the nominal location for this POI, which may be different from any location specified in the query - see also the location_ids field no no yes no no
location_ids string[] the locations that this POI belongs to no no no no no
musement_venue_id string Musement venue identifier for this POI no no no yes no
name string the human-readable name of this POI no yes yes no yes
opening_hours opening_hours a structured description of the opening hours on a normal week (public holidays and such are not taken into account) no no no yes no
price_tier integer price indication for this POI, if available. 1=cheap, 2=medium, 3=expensive no no yes yes no
properties property[] the properties related to this POI no no no no no
score float an indicator of the importance of this POI, generally between 0 and 10 but best suited to relative comparisons and ordering no yes yes no no
snippet string a short version of the content no no yes yes yes
snippet_language_info language_info information regarding the language of snippet no no yes yes no
structured_content structured_content structured content related to this poi (no machine translation) no no no yes yes
structured_content_language_info language_info information regarding the language of structured_content no no no yes no
tag_labels string[] the labels of the tags that apply to this POI no no no no no
tags tag_with_score[] the full tags that apply to this POI no no no no no
tour_ids string[] the IDs of the tours related to this POI no no no no no

poi_division_element

a tag label/POI ids structure to specify one element of the local highlights POI division

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
poi_ids string[] POI ids of belonging to this tag label no no yes no no
tag_label string the best tag label for the POIs specified no no yes no no
tag_name string human readable name for the tag label no no yes no no

point

a point on Earth

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
latitude float the latitude of the point no no yes no no
longitude float the longitude of the point no no yes no no

price

a price, including currency information

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
amount string the amount as a decimal string no no yes no no
currency string the three-digit ISO currency code no no yes no no

property

key/value pairs associated with POIs, tours or locations

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
key string a machine-readable identifier for this property (unique for the POI, tour or location that the property relates to) no no yes no no
location_id string the ID of the location this property applies to, if it applies to one no no no yes no
name string a human-readable name for the property no no yes no no
ordinal integer the position of this property in a natural ordering of the properties applying to this POI/tour/location no yes yes no no
poi_id string the ID of the POI this property applies to, if it applies to one no no no yes no
tour_id string the ID of the tour this property applies to, if it applies to one no no no yes no
value string the human-readable value of the property no no yes no no

section

a section of a content object

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
body string the content of this section, as HTML. References to objects in our database are represented using <a> tags with data-* attributes specifying which object it is. data-object_type gives the object type / endpoint (e.g. poi) and data-id gives the ID of the object no no yes yes no
image image an image related to this section no no yes yes no
title string the title of this section no no yes yes no

source

general information about a data source

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
attribution_text string text to display in order to properly attribute the content no no yes yes no
format string the format in which to attribute. The following substitutions need to be made: {attribution} needs to be substituted by the attribution_text and needs to link to the url specified in the url field in the corresponding attribution record, {license} needs to be substituted by the license_text and needs to link to license_link, if license_link is set no no yes no no
id string a machine-readable identifier for the source no no yes no no
license_link string the URL which the license text should link to no no yes yes no
license_text string the license text to display no no yes yes no

string

a string

structured_content

structured content, including attribution information

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
attribution attribution[] the attribution needed for this content no no yes no no
images image[] images for this content no no yes no no
sections structured_content_section[] the sections of this content no no yes no no

structured_content_section

a section of a structured_content object

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
body string the content of this section, as HTML. References to objects in our database are represented using <a> tags with data-* attributes specifying which object it is. data-object_type gives the object type / endpoint (e.g. poi) and data-id gives the ID of the object. References to images are represented using <img> tags, with data-index specifying the (0-offset) index into the list of images for the structured_content and data-caption optionally specifying a caption for the image no no yes yes no
body_images integer[] a list of (0-offset) indexes indicating which images are referenced in the body of this section no no yes no no
coordinates point the coordinates of the subject of this section, if known no no yes yes no
labels string[] a list of labels for this section no no yes no no
object_id string the ID of the object in our database that is the subject of this section, if known no no yes yes no
object_type string the type / endpoint (e.g. poi) for the object in our database that is the subject of this section, if known no no yes yes no
sections structured_content_section[] a list of subsections no no yes no no
summary string a shorter summary of this section (not present if body is already short enough) no no yes yes no
title string the title of this section no no yes yes no
topics structured_content_topic[] a list of topics covered in this section no no yes no no

structured_content_topic

a topic covered as part of a structured_content_section object

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
body string the content of this topic, as HTML, extracted from the parent section. References to objects in our database are represented using <a> tags with data-* attributes specifying which object it is. data-object_type gives the object type / endpoint (e.g. poi) and data-id gives the ID of the object. References to images are represented using <img> tags, with data-index specifying the (0-offset) index into the list of images for the structured_content and data-caption optionally specifying a caption for the image no no yes yes no
coordinates point the coordinates for this topic, if known no no yes yes no
object_id string the ID of the object in our database for this topic, if known no no yes yes no
object_type string the type / endpoint (e.g. poi) for the object in our database for this topic, if known no no yes yes no
title string the title of this topic no no yes yes no

tag

describes a tag and shows how many POIs/tours/articles have this tag

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
article_count integer the number of articles that have this tag no yes yes no no
child_labels string[] the child tag labels of this tag's label no no no no no
content content content related to this tag (only available for tag endpoint) yes no no yes no
internal boolean whether or not this tag is intended for internal use (i.e. usually shouldn't be exposed to end users) no no no no no
label string a machine-readable label for this tag - only unique within a location_id no no yes no no
location_id string the ID of the location this tag applies to no no yes yes no
name string a human-readable name for this tag no no yes no yes
name_language_info language_info information regarding the language of name no no yes yes no
parent_labels string[] the parent tag labels of this tag's label no no no no no
poi_count integer the number of POIs that have this tag no yes yes no no
score float the score of this tag, between 0 and a bit more than 10 no yes yes yes no
short_name string a short human-readable name for this tag no no yes no no
snippet string a short string describing this tag no no yes yes yes
snippet_language_info language_info information regarding the language of snippet no no yes yes no
structured_content structured_content structured content related to this tag (only available for tag endpoint) (no machine translation) no no no yes yes
structured_content_language_info language_info information regarding the language of structured_content no no no yes no
tour_count integer the number of tours that have this tag no yes yes no no

tag_label_with_score

a tag label, along with its score

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
count integer number of POIs with this tag label nearby no no yes no no
score float score for this tag label no no yes no no
tag_label string the tag label to which this score belongs no no yes no no

tag_type

the general type of a tag

tag_with_score

a tag, along with its score

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
object_score float score for this tag applied to this specific object no no yes no no
tag tag the tag to which this score belongs no no yes no no

time_range

a time of day range

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
end day_time end time of the range, null meaning it ends on a following day no no yes yes no
start day_time start time of the range, null meaning it starts on a previous day no no yes yes no

time_ranges_by_day

collection of time ranges for all days of the week

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
fri time_range[] time ranges for Friday no no yes no no
mon time_range[] time ranges for Monday no no yes no no
sat time_range[] time ranges for Saturday no no yes no no
sun time_range[] time ranges for Sunday no no yes no no
thu time_range[] time ranges for Thursday no no yes no no
tue time_range[] time ranges for Tuesday no no yes no no
wed time_range[] time ranges for Wednesday no no yes no no

tour

bookable tours

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
attribution attribution[] information about the sources this content came from no no yes no no
booking_info booking_info information needed to book this tour no no yes no no
content content content about this tour yes no no yes no
duration float how long the tour lasts (see the duration_unit field for units) no no yes yes no
duration_unit duration_unit the unit in which the duration field is expressed. can be "minute", "hour" or "day" no no yes yes no
highlights string[] tour highlights, as provided by the tour operator no no no yes no
id string the machine-readable identifier of this tour no no yes no no
images image[] images related to this tour no no yes no no
intro string a short version of the content about this tour no no no yes no
location_ids string[] the locations that this tour is related to no no no no no
name string a human-readable name of this tour no yes yes no no
poi_ids string[] the IDs of the POIs related to this tour no no no no no
price price the price of this tour in the currency of the tour operator no no yes no no
price_is_per_person boolean if true, it means that the price is the same for each person going on the tour. if false, it usually means that the prices for the second, third, etc. people are discounted in some way no no yes no no
properties property[] the properties related to this tour no no no no no
score float an indicator of the importance of this tour, generally between 0 and 10 but best suited to relative comparisons and ordering no yes yes no no
structured_content structured_content structured content about this tour no no no yes no
tag_labels string[] the labels of the tags that apply to this tour no no no no no
tags tag_with_score[] the full tags that apply to this tour no no no no no
vendor string the vendor offering this tour (deprecated - use booking_info field instead) (viator, withlocals, bemyguest, tiqets, musement) yes no yes no no
vendor_tour_url string the URL for this tour on the vendor's website (deprecated - use booking_info field instead) yes no yes no no

translation_provider

a translation provider

vendor_identifier

the identifier for the vendor of a bookable object

way_point

a point (POI or just lat/lng) along a city walk

Name Type Description Deprecated? Orderable? Included by default? May be null? I18n?
coordinates point the geographical location of this way point no no yes no no
poi poi corresponding POI for this way point or null if lat/long specified no no yes yes no
visit_time integer estimated time to visit this way point no no yes no no
walk_to_next_distance integer estimated distance of the walk to the next way point in meters no no yes no no
walk_to_next_duration integer estimated duration of the walk to the next way point in minutes no no yes no no

Common tag labels

Below you can find a list of the standard tag labels, with each tag label listed under its parents. Note that this list does not include all the tag labels in our database; for example, the tags for specific architectural styles are not listed here, but they can be obtained for any given location by querying the tag endpoint for descendants of the architectural_style tag.

Label Name Internal? Other parents Description
architectural_style Architectural style yes Ancestor label for all tags for specific architectural styles
background Background no
architecture Architecture no
art Art no
celebrations Festivals no
culture Culture no
customs Customs and etiquette no
feesandpermits Fees and permits no
food Food no Local dishes and specialities
history History no
intro Intro no
language Language no
literature Literature no
music Music no
public_holidays Public holidays no
wildlife Nature and Wildlife no Flora and fauna attractions
character Character yes Ancestor label for all tags describing the character of a place
character-Adult_content Adult content yes
character-Chain Chain no Means that it's a brand chain
character-Clean Mostly clean no Currently only applies to beaches. Means the beach/water is generally clean
character-Crowded Mostly crowded no Currently only applies to beaches.
character-Dangerous_swim Swimming can be dangerous no Currently only applies to beaches. Means it is dangerous to swim there.
character-Dirty Dirty or polluted no Currently only applies to beaches.
character-Gay_friendly Gay friendly no
character-Kid_friendly Kid friendly no
character-Popular_with_locals Popular with locals no
character-Quiet Mostly quiet no Currently only applies to beaches.
character-Reportedly_haunted Reportedly haunted location no
character-Reservation_recommended Reservation recommended no
character-Rocky_beach Rocky beach no
character-Romantic Romantic no
character-Rustic Rustic no
character-Safe_swim Generally safe to swim no Currently only applies to beaches. Means it is generally safe to swim there.
character-Sandy_beach Sandy beach no
character-Shingle_beach Shingle beach no
character-Wheelchair_friendly Wheelchair friendly no
character-World_heritage UNESCO World Heritage site no
climate Climate no
district Districts yes Ancestor label for all tags denoting city districts
district_airport Airports yes Ancestor label for all tags denoting airport districts
district_beach Beaches yes Ancestor label for all tags denoting beach districts
district_protected_area Protected areas yes Ancestor label for all tags denoting protected area districts
district_surfing Surfing spots yes Ancestor label for all tags denoting surfing districts
do Activities no Activities & things to do
adrenaline Adrenaline no Adventure & extreme sports activities
poitype-Free_flying Free flying no
air Air, Helicopter & Balloon Tours no Airborne tours in helicopters, planes & balloons
amusementparks Amusement parks no Theme parks, amusement parks and similar attractions
poitype-Amusement_ride Amusement ride no
poitype-Water_park Water park no swimming
beaches Beaches no Seaside beaches
camping Camping no Outdoor camping options
poitype-Campsite Campsite no
climbing Climbing no Rock climbing, mountain climbing & more
poitype-Climbing_spot Climbing spot no
cookingclasses Cooking classes no
poitype-Cooking_class Cooking class no
cruises River cruises no
poitype-River_cruise River cruise no
cycling Cycling no Everything to do with cycling - shops, trails, rentals, tours and more
poitype-Bike_path Bike path no
poitype-Bike_rental Bike rental no
poitype-Bike_shop Bike shop no
diving Diving no Snorkelling and diving spots
poitype-Diving_centre Diving centre no
poitype-Diving_spot Diving spot no
fishing Fishing no Fishing, angling and more
poitype-Fishing_shop Fishing shop no
poitype-Fishing_spot Fishing spot no
golf Golf no Golfing clubs and courses
poitype-Golf_course Golf course no
hiking Hiking no Hiking spots & trails
poitype-Alpine_hut Alpine hut no
poitype-Canopy_trail Canopy trail no
poitype-Hiking_trail Hiking trail no
poitype-Wilderness_hut Wilderness hut no
hunting Hunting no Hunting camps, spots and lodging
poitype-Hunting_stand Hunting stand no
iceskating Ice skating no Ice skating and rinks
poitype-Ice_rink Ice rink no
kayaking Kayaking no Kayaking, paddling & canoeing options
poitype-Kayak_rentals Kayak rentals no
northernlights Northern lights watching no Northern lights sightings
paragliding Paragliding no Paragliding tours
rafting Rafting no River rafting options
poitype-Rafting_company Rafting company no
riding Riding no Horseback riding options & tours
poitype-Equestrian_centre Equestrian centre no
safari Safaris no
poitype-Safari_company Safari company no
sailing Sailing no Sailing and boating options
poitype-Marina Marina no
poitype-Yacht_club Yacht club no
shopping Shopping no Shopping options
markets Markets no sightseeing Markets and bazaars
poitype-Boutique Boutique no
poitype-Department_store Department store no
poitype-Liquor_store Liquor store no
poitype-Shopping_centre Shopping centre no
poitype-Shopping_district Shopping district no
poitype-Tobacco_store Tobacco store no
subtype-Art_shops Art shops no
subtype-Bookshops Bookshops no
subtype-Clothing_shops Clothing shops no
subtype-Cosmetics_shops Cosmetics shops no
subtype-Jewelry_shops Jewelry shops no
subtype-Toy_shops Toy shops no
sports Sports no Sport and recreation options
poitype-Sport_venue Sport venue no
subtype-Football_stadiums Football stadiums no
subtype-Multi-purpose_stadiums Multi-purpose stadiums no
surfing Surfing no Surfing schools and zones
swimming Swimming no Water parks and swimming venues
poitype-Swimming_pool Swimming pool no
poitype-Water_park Water park no amusementparks
watersports Watersports no Parasailing, kitesurfing and other water sports
poitype-Kite_surfing Kite surfing no
poitype-Water_ski Water ski no
wellness Wellness no Spas, massages and other beauty treatments
poitype-Massage Massage no
poitype-Sauna Sauna no
poitype-Spa Spa no
poitype-Spa_hotel Spa hotel no hotels
whalewatching Whale watching no Whalewatching & dolphin tours
poitype-Whale_watching Whale watching no
wintersport Winter sport no Skiing, snowboarding and other winter sport options
poitype-Ski_area Ski area no
poitype-Ski_piste Ski piste no
poitype-Ski_school Ski school no
eatingout Eat and drink no Food and drink options
cuisine Cuisine yes Ancestor label for all tags for specific cuisines
coffee Coffee no Cafes and coffee places
cuisine-Afghan Afghan cuisine no
cuisine-African African cuisine no
cuisine-American American cuisine no
cuisine-Argentinian Argentinian cuisine no
cuisine-Asian Asian cuisine no
cuisine-Australian Australian cuisine no
cuisine-Austrian Austrian cuisine no
cuisine-Balkan Balkan cuisine no
cuisine-Baltic Baltic cuisine no
cuisine-Bangladeshi Bangladeshi cuisine no
cuisine-Basque Basque cuisine no
cuisine-Belgian Belgian cuisine no
cuisine-Brazilian Brazilian cuisine no
cuisine-British British cuisine no
cuisine-Burmese Burmese cuisine no
cuisine-Cajun Cajun cuisine no
cuisine-Cambodian Cambodian cuisine no
cuisine-Canadian Canadian cuisine no
cuisine-Caribbean Caribbean cuisine no
cuisine-Caucasian Caucasian cuisine no
cuisine-Central_american Central American cuisine no
cuisine-Central_european Central European cuisine no
cuisine-Chinese Chinese cuisine no
cuisine-Dutch Dutch cuisine no
cuisine-East_african East African cuisine no
cuisine-Filipino Filipino cuisine no
cuisine-French French cuisine no
cuisine-Fusion Fusion cuisine no
cuisine-German German cuisine no
cuisine-Greek Greek cuisine no
cuisine-Indian Indian cuisine no
cuisine-Indonesian Indonesian cuisine no
cuisine-International International cuisine no
cuisine-Irish Irish cuisine no
cuisine-Israeli Israeli cuisine no
cuisine-Italian Italian cuisine no
cuisine-Japanese Japanese cuisine no
cuisine-Korean Korean cuisine no
cuisine-Lao Lao cuisine no
cuisine-Malaysian Malaysian cuisine no
cuisine-Mediterranean Mediterranean cuisine no
cuisine-Mexican Mexican cuisine no
cuisine-Middle_eastern Middle Eastern cuisine no
cuisine-Mongolian Mongolian cuisine no
cuisine-Nepalese Nepalese cuisine no
cuisine-Nordic Nordic cuisine no
cuisine-North_african North African cuisine no
cuisine-Pakistani Pakistani cuisine no
cuisine-Persian Persian cuisine no
cuisine-Polynesian Polynesian cuisine no
cuisine-Portuguese Portuguese cuisine no
cuisine-Russian Russian cuisine no
cuisine-Seafood Seafood no
cuisine-Singaporean Singaporean cuisine no
cuisine-South_american South American cuisine no
cuisine-Southern Southern cuisine no
cuisine-Spanish Spanish cuisine no
cuisine-Sri_lankan Sri Lankan cuisine no
cuisine-Surinamese Surinamese cuisine no
cuisine-Sushi Sushi no
cuisine-Swiss Swiss cuisine no
cuisine-Tex-mex Tex Mex cuisine no
cuisine-Thai Thai cuisine no
cuisine-Tibetan Tibetan cuisine no
cuisine-Turkish Turkish cuisine no
cuisine-Uzbek Uzbek cuisine no
cuisine-Vegan Vegan no
cuisine-Vegetarian Vegetarian no
cuisine-Vietnamese Vietnamese cuisine no
icecream Icecream no Icecream, fudge & sundaes
eatingout_establishment Places to eat and drink no
breweries Brewery tours no Beer tasting and brewery tours
distilleries Distilleries no Whiskey tasting and distillery tours
poitype-Whiskey_distillery Whiskey distillery no
poitype-Bakery Bakery no
poitype-Bar Bar no nightlife
poitype-Cafe Cafe no
poitype-Chocolatier Chocolatier no
poitype-Restaurant Restaurant no
wineries Wine tours no Wine tasting & winery tours
eatingout_time Options for meal times yes Ancestor label for all tags for specific meal times
breakfast Breakfast no Breakfast and bakeries
coffeeandcake Cakes and pies no Cakes, cookies, pies and their ilk
dinner Dinner no Dinner options
drinks Drinks no nightlife Cocktails, beer and their ilk
lunch Lunch no Lunch options
foodexperiences Food experiences no Food-related tours, cruises & other experiences
feature Feature yes Ancestor label for all tags denoting features of places
feature-Dance_floor Dance floor no
feature-Darts Darts no
feature-Delivery Delivery no Offers home delivery
feature-Drive_through Drive through no Drive through restaurants and bars
feature-Fireplace Fireplace no
feature-Free_wifi Free wifi no
feature-Has_parking Nearby parking no Currently only applies to beaches. Means there are parking options nearby.
feature-Karaoke Karaoke no
feature-Live_music Live music no
feature-Lockers Lockers available no Currently only applies to beaches.
feature-Outdoor_seating Outdoor seating no
feature-Seasonal_lifeguard Seasonal lifeguard no Currently only applies to beaches. Means there is a lifeguard during peak season.
feature-Shower Shower available no Currently only applies to beaches. Means there is shower facility nearby/on the beach.
feature-Smoking_allowed Smoking allowed no
feature-Snooker Snooker no
feature-Takeaway Takeaway no
feature-Toilet Toilet available no Currently only applies to beaches. Means there is toilet facility nearby/on the beach.
feature-Transport_access Public transport access no Currently only applies to beaches.
hotels Hotels no Hotels, apartments & other accommodation
poitype-Hotel_casino Hotel casino no gambling
poitype-Spa_hotel Spa hotel no wellness
location Location yes Ancestor label for all tags denoting kinds of locations
city Cities no
country Countries no
island Islands no
national_park Nature reserves no
region Regions no
nightlife Nightlife no Pubs, party places & nightlife options
cinema Cinema no Cinemas
comedy Comedy clubs no Comedy venues
poitype-Comedy_club Comedy club no
dancing Dancing no Venues for dancing like clubs and bars
poitype-Club Club no
poitype-Entertainment_district Entertainment district no
drinks Drinks no eatingout_time Cocktails, beer and their ilk
gambling Gambling no Casinos and gambling options
poitype-Casino Casino no
poitype-Hotel_casino Hotel casino no hotels
poitype-Bar Bar no eatingout_establishment
redlight Red light no Adult entertainment
poitype-Brothel Brothel no
poitype-Red-light_district Red-light district no sightseeing
poitype-Strip_club Strip club no
person Person yes Ancestor label for all tags for places connected with a known person
person_architect Architect yes Ancestor label for all tags for places connected with an architect
person_artist Artist yes Ancestor label for all tags for places connected with an artist (author, composer, etc.)
practicalities Practicalities yes Ancestor label for all tags relating to practicalities
electricity Electricity plugs no
gettingthere Getting there no
groceries Groceries no Supermarkets, grocers and convenience stores
poitype-Convenience_store Convenience store no
poitype-Delicatessen Delicatessen no
poitype-Green_grocer Green grocer no
poitype-Supermarket Supermarket no
poitype-Variety_store Variety store no
health Health no Hospitals, doctors and pharmacies
poitype-Dentist Dentist no
poitype-Doctor Doctor no
poitype-Hospital Hospital no
poitype-Pharmacy Pharmacy no
laundry Laundry no Laundromats
poitype-Dry_cleaning Dry cleaning no
poitype-Laundry_shop Laundry shop no
money Money no ATMs and banks
poitype-Atm Atm no
poitype-Bank Bank no
poitype-Bureau_de_change Bureau de change no
orientation Orientation no
parking Parking no Parking garages and areas
postoffices Post offices no Post offices
prepaidwithdata Prepaid data no
safety Safety no Police stations and embassies
poitype-Embassy Embassy no
poitype-Police Police no
touristinfo Tourist information no
poitype-Information_centre Information centre no
poitype-Visitor_services_village Visitor services village no
transport Transport no Train & metro stations, airports and bus terminals
poitype-Aerial_tramway_station Aerial tramway station no
poitype-Airport Airport no
poitype-Airport_terminal Airport terminal no
poitype-Bus_station Bus station no
poitype-Bus_stop Bus stop no
poitype-Car_rental Car rental no
poitype-Ferry_wharf Ferry wharf no
poitype-Railway_station Railway station no
poitype-Subway_station Subway station no
poitype-Taxi_station Taxi station no
poitype-Tram_stop Tram stop no
visas Visa no
work Work no
sightseeing Sightseeing no Tourist sights and attractions
exploringnature Natural attractions no Waterfalls, mountains, geysers and their ilk
poitype-Butte Butte no
poitype-Canyon Canyon no
poitype-Cave Cave no
poitype-Cliff Cliff no
poitype-Fjord Fjord no
poitype-Forest Forest no
poitype-Geyser Geyser no
poitype-Hill Hill no
poitype-Hot_spring Hot spring no
poitype-Lake Lake no
poitype-Marine_reserve Marine reserve no
poitype-Mountain Mountain no
poitype-Mountain_pass Mountain pass no
poitype-Natural_feature Natural feature no
poitype-Natural_wonder Natural wonder no
poitype-Protected_area Protected area no
poitype-Rock Rock no
poitype-Sand_dune Sand dune no
poitype-Valley Valley no
poitype-Volcano Volcano no
subtype-Active_volcanoes Active volcanoes no
poitype-Waterfall Waterfall no
forts Forts and castles no Citadels, forts & castles
poitype-Castle Castle no
poitype-Citadel Citadel no
markets Markets no shopping Markets and bazaars
museums Museums no Museums
poitype-Art_gallery Art gallery no
poitype-Museum_district Museum district no
poitype-Planetarium Planetarium no
subtype-Archaeological_museums Archaeological museums no
subtype-Art_museums Art museums no
subtype-Fashion_museums Fashion museums no
subtype-History_museums History museums no
subtype-Maritime_museums Maritime museums no
subtype-Military_museums Military museums no
subtype-Modern_art_museums Modern art museums no
subtype-Natural_history_museums Natural history museums no
subtype-Sci-tech_museums Sci-tech museums no
poitype-Acropolis Acropolis no
poitype-Aerial_tramway Aerial tramway no
poitype-Amphitheatre Amphitheatre no
poitype-Aqueduct Aqueduct no
poitype-Arch Arch no
poitype-Archaeological_site Archaeological site no
poitype-Area Area no
poitype-Baths Baths no
poitype-Beguinage Beguinage no
poitype-Bridge Bridge no
poitype-Canal Canal no
poitype-Caravanserai Caravanserai no
poitype-Catacombs Catacombs no
poitype-Cemetery Cemetery no
poitype-Church Church no
poitype-City_gate City gate no
poitype-City_hall City hall no
poitype-City_wall City wall no
poitype-Concentration_camp Concentration camp no
poitype-Convention_centre Convention centre no
poitype-Country_house Country house no
poitype-Dam Dam no
poitype-Ferris_wheel Ferris wheel no
poitype-Fountain Fountain no
poitype-Interesting_neighbourhood Interesting neighbourhood no
poitype-Island Island no
poitype-Library Library no
poitype-Lighthouse Lighthouse no
poitype-Manor_house Manor house no
poitype-Mausoleum Mausoleum no
poitype-Memorial Memorial no
poitype-Minaret Minaret no
poitype-Mission Mission no
poitype-Monastery Monastery no
poitype-Mosque Mosque no
poitype-Music_venue Music venue no showstheatresandmusic
poitype-Necropolis Necropolis no
poitype-Neighbourhood Neighbourhood no
poitype-Obelisk Obelisk no
poitype-Pagoda Pagoda no
poitype-Palace Palace no
poitype-Pharaonic_tomb Pharaonic tomb no
poitype-Pier Pier no
poitype-Port Port no
poitype-Prehistoric_site Prehistoric site no
poitype-Prison Prison no
poitype-Pyramid Pyramid no
poitype-Red-light_district Red-light district no redlight
poitype-Royal_guard Royal guard no
poitype-Ruin Ruin no
poitype-School School no
poitype-Seminary Seminary no
poitype-Ship Ship no
poitype-Shipwrecks Shipwrecks no
poitype-Shrine Shrine no
poitype-Sight Sight no
poitype-Skyscraper Skyscraper no
poitype-Square Square no
poitype-Statue Statue no
poitype-Stela Stela no
poitype-Stock_exchange Stock exchange no
poitype-Street Street no
poitype-Synagogue Synagogue no
poitype-Temple Temple no
poitype-Tomb Tomb no
poitype-Tower Tower no
poitype-Tree Tree no
poitype-Tunnel Tunnel no
poitype-University University no
poitype-View_point View point no
poitype-Waterfront Waterfront no
poitype-Watermill Watermill no
poitype-Wayside_shrine Wayside shrine no
poitype-Windmill Windmill no
relaxinapark Relax in a park no Parks, gardens and picnic spots
poitype-Barbecue_spot Barbecue spot no
poitype-Botanical_garden Botanical garden no
poitype-Park Park no
poitype-Petting_zoo Petting zoo no zoos
poitype-Picnic_site Picnic site no
showstheatresandmusic Shows, theatres and music no
poitype-Concert_hall Concert hall no
poitype-Music_venue Music venue no sightseeing
poitype-Theatre Theatre no
subtype-Cabarets Cabarets no
subtype-Kabuki_theatres Kabuki theatres no
subtype-Ballet_venues Ballet venues no
subtype-Opera_houses Opera houses no
topattractions Top attractions no
zoos Zoos and aquariums no Zoos and aquariums
poitype-Aquarium Aquarium no
poitype-Petting_zoo Petting zoo no relaxinapark
tours Tours no
citypass City pass no Tickets and passes that allow access to a number of attractions and sightseeing places
daytrips Day trips no Day trips
hoponhopoff Hop-on hop-off no
multiday Multi-day tours no Multi-day tours
private_tours Private tours no Paid private tours, excursions & custom trips
pubcrawl Pub crawls no
skiptheline Skip the line no Tours that allow you to go directly to the attraction
tickets Attraction tickets no Tickets to attractions and sightseeing places
walkingtours Walking tours no Walking tours

Query types

contains_location query whether a set of location IDs contains the given location ID. may be specified multiple times, in which case the set of location IDs must contain every supplied location ID
contains_tag query the labels of tags. supports "|" for OR and "!" for NOT. for AND, specify the parameter multiple times
exact query by the exact value of the field
exact_list_or_negated query by the exact value of the field. supports "|" for OR. if only a single value is provided the condition can be negated by prepending it with !
exact_negatable query by the exact value of the field, or exclude an exact value by prepending the value with !
exact_or_any query by the exact value of the field, or specify * to allow any value
none querying this value is not possible
range ">=n", ">n", "<n", "<=n" or "m..n" (inclusive of m, exclusive of n)

Errors

Code Description
1 invalid value for boolean parameter
2 invalid range values
3 invalid order_by
4 unknown fields in exclude_fields
5 field not queryable
6 invalid parameter on endpoint
7 invalid annotation
8 invalid country or state code
9 missing required parameter
10 parameter out of bounds
11 both lat and lng need to be specified
12 given object does not have similarity content
13 invalid value for parameter
14 invalid value for datetime parameter
15 invalid value for persona annotation
16 invalid language
17 unrecognised currency
18 invalid parameter combination
101 object specified by ID does not exist
102 only id is queryable for the source endpoint
201 location_ids is only applicable to tours and articles
202 not enough POIs to plan a walk
301 maximum number of results exceeded (100)
401 missing or invalid authentication information
402 insufficient credit balance to make request
403 account is disabled
404 endpoint not found or invalid version
429 rate limit exceeded
500 internal error
504 query timeout