Sygic Travel API
The Sygic Travel API is a REST JSON API providing access to the Sygic Travel Places Data.
Getting Started
Note: Version 1.2 of the API introduces breaking changes – please see the changelog a make sure you update your app prior switching to this version.
URL Prefix
https://api.sygictravelapi.com/{version}/{language}
Authentication
Each request must contain an authorization header x-api-key
that
identifies the requesting party. Missing or invalid authorization header will
result in an HTTP 401 Unauthorized
error.
Example request
Running the following code in terminal will return places for the search query „Eiffel“. If you are unfamiliar with using the terminal, please see the section Testing the API below.
curl -H "x-api-key: YOUR_API_KEY" https://api.sygictravelapi.com/1.2/en/places/list?query=eiffel
Testing the API
To test the API, you need an app that can send the HTTP authorization header. We recommend Postman (free). We have also prepared a collection configuration file for Postman that contains all endpoints preconfigured. Watch a short tutorial on how to configure Postman for testing the Sygic Travel API:
Versioning
{version}
: The latest API version is 1.2
. See the
changelog.
While we aim to keep the API stable, beware that new versions may introduce BC breaks and migration may be necessary. Older versions are supported for at least 12 months after a new version is introduced.
Languages
{language}
: Language is represented by ISO 639–1 code.
Supported values are: ar
, cs
, da
,
de
, el
, en
, es
,
fi
, fr
, he
, hu
,
it
, ja
, ko
, nl
,
no
, pl
, pt
, ro
,
ru
, sk
, sv
, th
,
tr
, uk
, zh
Please note that the availability of translated content is limited. When
translation is unavailable, the API automatically falls back to English.
Conversely, some content may only be available in other languages, such as in
cases where there is a Wikipedia article about a place in e.g. Italian that does
not have English translation. Such content is however not used as a fallback
when requesting en
language.
Status
You can check the API availability at the Status page.
First Steps
The key functionality of the Sygic Travel API is place search / listing. The most frequent use cases are outlined below. For a more detailed description, refer to the Places endpoint.
Fulltext search
Use the query
parameter to perform a fulltext search
by name:
https://api.sygictravelapi.com/1.2/en/places/list?query=London%20Eye
This query will return worldwide places that match the query „London Eye“. The search uses a broad match, so it will return multiple places worldwide. Nonetheless, since the results are always ordered by popularity, the famous London attraction will be on top.
Filtering by administrative level
Each place has a level
property, which specifies its
administrative level. If you want to return only particular levels, use the
levels
query parameter.
https://api.sygictravelapi.com/1.2/en/places/list?parents=country:77&levels=poi
The query will list places from New Zealand only. See the endpoint description for the list of available levels.
Filtering by categories and tags
Sometimes you only want to show certain types of places, such as museums. You can easily achieve this by using categories or tags. While there are only a handful of categories to allow easy broad matching, there are also more than 3600 different tags to allow the finest levels of filtering. See the endpoint description for the full list of available categories and tags.
The query below uses the discovering category to match museums, science centers, libraries, zoos and similar:
https://api.sygictravelapi.com/1.2/en/places/list?categories=discovering&levels=poi
Using a tag Railway Museum will only match railway museums:
https://api.sygictravelapi.com/1.2/en/places/list?tags=Railway%20Museum&levels=poi
Prefering or filtering locations
There are two different ways to incorporate location in your query: Boosting the ordering of places based on proximity or limiting the results to a particular area only.
Boosting the ordering based on proximity
If the user is searching for something locally, e.g. on a mobile device, you
may want to boost the results from the local area. A good example is
„Chinatown“, which exists in many cities around the globe.
Using parameter location
, you can tell the API to boost results
that are close. In the following example, we search for
Chinatown near Melbourne, Australia:
https://api.sygictravelapi.com/1.2/en/places/list?query=Chinatown&location=-37.820,144.981
Note that this query does not limit results in other locations – it simply
boosts the ordering of places in proximity of location
.
Limiting the search area
If you want to show results only from a particular area, you can use the following parameters to limit the query:
map_tiles
– to limit by map tiles using quadkeybounds
– to limit by rectangular boundsarea
– to limit by a circle of given center and radiusparents
– to limit by geographical bounds, such as only in Paris, using the parent ids.
https://api.sygictravelapi.com/1.2/en/places/list?parents=country:77
The query above will list places from New Zealand. You will find more information on where to obtain IDs or use other parameters in the endpoint descripiton.
Limiting and iterating through the results
By default, the API returns maximum of 10 results. You can add parameter
limit
to return more (up to 1024 at a time) or less:
https://api.sygictravelapi.com/1.2/en/places/list?query=London%20Eye&limit=1
Normally, there should be little need for pagination and you should design
your application to use more specific filters instead. If you still need
pagination, set the offset
parameter to retrieve a specific subset
of results.
URL prefix
https://api.sygictravelapi.com/1.2/{lang}
Parameters
name | type | example | description | |
---|---|---|---|---|
lang | inlined in path |
enum["ar", "cs", "da", "de", "el", "en", "es", "fi", "fr", "he", "hu", "it", "ja", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sv", "th", "tr", "uk", "zh"]
|
Postman
Collections #
Collections are lists of pre-selected, high ranking places for a given
location (parent_place_id
). Collections typically contain top
places that meet certain popularity as well as content quality criteria.
Collections are only generated for locations where such content is
available.
Example collections:
Parameters
name | type | example | description | |
---|---|---|---|---|
parent_place_id | optional |
string
|
"country:1" |
Limit results to collections for location (such as London) |
place_ids | optional |
string
|
"poi:530,poi:531" |
Limit results to collections that contain given places. It is possible to
pass multiple places IDs using separators |
tags | optional |
string
|
"Restaurant" |
Comma separated tag names (logical AND) |
tags_not | optional |
string
|
"Hotel,Bar" |
Comma separated tags to exclude (logical AND) |
query | optional |
string
|
"Best Restaurants" |
Search query in collection names |
limit | optional |
int
1…30
|
5 |
Default value is 10 |
offset | optional |
int
0…∞
|
10 |
Default offset is 0 |
prefer_unique | optional |
bool
|
1 |
Affects ordering by penalizing collections that are very similar to any
collection ranked above, effectively removing duplicates. Applicable only
together with |
Body
Parameters
name | type | example | description | |
---|---|---|---|---|
id | inlined in path |
int
|
111 |
Body
Places #
Use this endpoint to query places data from the Sygic Places database. A quick tutorial is available in the Getting started guide.
IDs, Parent IDs
Each place has a unique and (for most purposes) stable ID (property
id
). These IDs can also be used to navigate the
destination tree.
Each place lists all its parents in parents
property.
parents.id
represents ID of the respective parent.
You can use IDs to limit the search to a specific location – e.g. the
following query will list top 10 places in Prague based on its ID:
https://api.sygictravelapi.com/1.2/en/places/list?parents=city:5&limit=10
Best way to find an ID is to search for it using the
/places/match
or /places/list
endpoint.
For your convenience, you can find the country and city IDs also in the
following files. You can browse them in Google Sheets or download them in the
CSV format:
- List of countries: Google
Sheets, CSV
- List of top cities: Google
Sheets, CSV
Levels
Each place has a level
property that describes the type of the
place by administration level.
Supported levels are:
continent
, country
, state
,
region
, county
, city
, town
,
village
, settlement
, locality
,
neighbourhood
, archipelago
,
island
, poi
Top 10 cities in the United Kingdom:
https://api.sygictravelapi.com/1.2/en/places/list?parents=country:1&levels=city&limit=10
Categories
The API uses 11 categories for places to allow easy selection without the
need to use complex tag queries. Each place can have multiple categories
assigned, describing different kinds of visitor interest. Supported categories
are: discovering
(used for museums, galleries etc.),
eating
(restaurants), going_out
(nightlife),
hiking
(outdoors), playing
(places interesting for
families with children), relaxing
, shopping
,
sightseeing
, sleeping
(accommodation),
doing_sports
, traveling
(transportation).
You can find categories relevant to your query by calling the
/places/stats
endpoint, or see Tags
and categories popularity. You can also browse Sygic Maps to get an idea of what is returned
for each category.
sleeping
category uses data from Booking.com and it is only available to partners that
have a valid API access contract with Booking.com.Top 10 places in London in the sightseeing category:
https://api.sygictravelapi.com/1.2/en/places/list?parents=city:1&categories=sightseeing&limit=10
Tags
Each place can have multiple tags which describe the place or its properties.
Tags can be used to filter places using the tags
parameter. You can
find all tags relevant to your query by calling the /places/stats
endpoint, or see Tags
and categories popularity. Please note that new tags are being added
continuously as we improve the data.
The following query selects places with a Bar tag in London:
https://api.sygictravelapi.com/1.2/en/places/list?parents=city:1&tags=Bar
Class
Class (property class
) specifies the type of the place. Each
class has a unique class.slug
that is stable across languages and
class.name
which is intended for displaying in the UI.
See also the List of values.
Markers
Each place has a marker
property that specifies which icon from
the standard icon set can be used when displaying the place in user
interface.
We recommend that you load markers from a mainteined set of markers available at content delivery network with base URL https://cdn.travel.sygic.com/web/markers/. Markers are available in .png (white over transparent background). Alternatively, you can download the markers and host it in your app.
Example:
https://cdn.travel.sygic.com/…nt-pizza.png
(note that the marker is white over transparent background, it will not be
visible when displayed over white browser background)
Geographical Attributes
Places have geographical attributes describing their location and area.
- location
– Object with lat
(latitude) and
lng
(longitude) in degrees.
- bounding_box
– Object with south
,
west
, north
, east
in degrees. Specifies
bounds of places that have an area.
- quadkey
– Map tile coordinate using Mercator (Google/Bing)
projection. For details see Bing Maps docs
or Maptiler.org.
- geometry
– actual geometry in GeoJSON. Available on a separate
endpoint (/places/{id}/geometry
)
Places within a specified bounding box:
https://api.sygictravelapi.com/1.2/en/places/list?bounds=51.487744,-0.1879067,51.526849,-0.0464577&levels=poi
Places within a specified quadkey:
https://api.sygictravelapi.com/1.2/en/places/list?map_tiles=120220011010%7C120220011012&levels=poi
References
References are entities that represent place's relations to other websites, articles, social networks, rentals, city passes, tickets, tours, and accomodation providers, parking, transfers, and other information. Using references, you can get relevant links for the place (official website, Facebook page, Twitter account, etc.), find out what tickets, city passes, tours and activities are relevant for the place or get a list of possible transfers to/from the place.
References are included as a references
array in response to
Places API calls. They have a structural type system – reference
type
is represented by a string that contains a top-level type and
may contain various nested subtypes that define the reference type more
precisely. Depending on the reference type, clients can decide if, how, and
where to display particular references. A priority
attribute can be
used for simple sorting.
The following top-level reference types are supported – link
,
wiki
, guide
, buy
, book
,
rent
, tour
, pass
, transfer
,
parking
, map
, article
. For a complete
list of nested reference types see the References
sheet.
Some references have multiple language variants – in such cases the
reference's language is specified by the language_id
property
and appropriate language variants are selected by the API according to language
specified in URL. When reference localization is not found, English variant is
used as a fallback. Some references have no particular language variants
(Facebook page, official website, etc.) – in such cases the
language_id
property is null
.
Attribution Requirements
Sygic Places uses OpenStreetMap.org as a base data layer. When using the Sygic Travel API, you need to attribute OpenStreetMap.org at your website or app as described here.
Depending on the provider of the place description, it may be required to
display attribution along with the description. Each description
object contains a provider
field. The attribution must be displayed
as follows:
1) Sygic Travel (provider: null
) – you do not need to
attribute anything.
2) Wikipedia (provider: wikipedia
) – you need to attribute
Wikipedia and link the respective article.
3) Wikivoyage (provider: wikivoyage
) – you need to attribute
Wikivoyage and link the respective article.
Some place descriptions are translated from the original description written
in another language. Such descriptions have is_translated
property set to true
and the translation must be attributed as
follows:
1) Human translator (translation_provider: null
) – you do not
need to attribute the translation.
2) Google Translate (translation_provider: google
) – you need to
attribute Google Translate as required by their Attribution
Requirements.
Place media (photos and videos) must be attributed as specified in the Media Attribution section.
This endpoint returns basic information about places. It is designed for fast performance for usecases such as fulltext search, place lists, map, etc.
Parameters
name | type | example | description | |
---|---|---|---|---|
query | optional |
string
|
"Eiffel Tower" |
Fulltext search query. Supports partial prefix & fuzzy matching, matches also against names of parent places, and works in multiple languages. |
levels | optional |
string
|
"city" |
Limit results by levels. Pass multiple levels using separators |
categories | optional |
string
|
"sightseeing|restaurant" |
Limit results by categories. Pass multiple categories using separators
|
categories_not | optional |
string
|
"sightseeing|restaurant" |
Limit results by excluding categories. It is possible to pass multiple
categories to exclude using separators |
map_tiles | optional |
string
|
"210313123|210313122" |
Limit results to area defined by quadkey. See section Geographical attributes. You can provide
multiple map_tiles separeated by |
map_spread | optional |
int
|
1 |
In combination with |
bounds | optional |
string
|
"48.858,2.294,48.860,2.296" |
Limit results to area defined by bounds. Bounds are defined by string
composed of four floats in format |
map_tile_bounds | optional |
string
|
"12021230,12021131" |
Limit results to area defined by quadkeys. See section Geographical attributes. You should provide two quadkeys separated by comma. The first one represents south west corner of the area and the second one the north east corner of the area. |
area | optional |
string(~^-?(\d+|\d*\.\d+),-?(\d+|\d*\.\d+),(\d+|\d*\.\d+)$~)
|
"48.858,2.294,1000" |
Limit results to area defined by a centre and a radius in meters. The units
of the centre are in degrees of latitude/longitude. See also parameter
|
tags | optional |
string
|
"Restaurant|Bar" |
Limit results by tags. Pass multiple tags using separators |
tags_not | optional |
string
|
"Restaurant|Bar" |
Limit results by excluding tags. Pass multiple tags to exclude using
separators |
parents | optional |
string
|
"city:14" |
Limit results by ID of parent place. Pass multiple IDs using separators
|
id_iata | optional |
string
|
"LHR|STN|LGW" |
Limit results by IATA codes of airports. |
rating | optional |
string
|
"0.001:1" |
Limit results by rating range. The rating reflects how popular the place is.
It is distributed so that 50% places have rating < 0.001, 80% places have
rating < 0.003, 95% places have rating < 0.01. Minimum value is 0 and
maximum is technically unlimited so to get top values leave the higher range
boundary unspecified, e.g. |
hotel_star_rating | optional |
string
|
"4:5" |
(Only available for Booking.com hotels) Limit results by checking if
hotel_star_rating or hotel_star_rating_unofficial of the accommodation is
within the given range. Values in range |
customer_rating | optional |
string
|
"7:9" |
(Only available for Booking.com hotels) Limit results by accommodation
customer_rating range. Values in range |
limit | optional |
int
1…1024
|
200 |
Limit the number of returned results. Value must be in range
|
offset | optional |
int
0…10000
|
512 |
Specify offset for pagination. Allowed range is
|
preferred_location | optional |
string
|
"48.858,2.294" |
Preferred location parameter boosts up places within the 300km radius area
around given GPS coordinates. Format is |
Body
See section Place categories.
tag_keys: [ "Museum" string 0…∞ ]Tag keys, always in English. Full tags property is only available in /places/{id} endpoint response.
rating: 9.555 floatAbsolute popularity rating of the place. Higher rating means higher
popularity. See parameter rating
for more info.
Local adjusted rating of a place. This value is based on rating
,
but adjusts for general popularity of the locality. Local rating is useful for
more uniform distribution of map markers between cities and surroundings.
See section Geographical attributes.
location: { lat: 45.456 float lng: 2.456 float }See section Geographical attributes.
bounding_box: { south: 50.076 float west: 14.412 float north: 50.078 float east: 14.414 float }|nullSee section Geographical attributes.
name: "Eiffel Tower" stringName of the place.
name_suffix: "Paris, France" string|nullSuffix contains parent location. Useful for distinguishing ambiguous locations such as „Chinatown“.
name_local: "Tour Eiffel" string|nullName as used locally, in local language.
name_en: "Eiffel Tower" string|nullEnglish name, if set
name_translated: "Torre Eiffel" string|nullName in requesteed language, if known
perex: "The most iconic sight in all of Paris. Do not miss this iron lady known all around the world. The views from the top are..." string|nullBeginning of place description, up to 160 characters. See description property in Place detail.
url: "https://travel.sygic.com/go/poi:530" string|nullURL of place overview on Sygic Travel. Custom Places do not have an url.
thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null150×150 pixels thumbnail. Get more images using Place detail or Place Media
marker: "sightseeing-tower-lookout" stringName of the suggested marker icon from Sygic Travel default marker icon set. See Place markers.
class: { slug: "sightseeing:tower:lookout" stringType of the place. This can be used e.g. to show a custom marker.
name: "Lookout Tower" string|nullType of the place intended to be shown in the UI.
} parents: [ { id: "city:54" string name: "Brno" string|nullName of the place.
level: "city" enum["continent", "country", "state", "region", "county", "city", "town", "village", "settlement", "locality", "neighbourhood", "archipelago", "island", "poi"] } 0…∞ ] hotel_star_rating: float|null(Booking.com hotels only) Rating in stars (official) from 0 to 5.
hotel_star_rating_unofficial: float|null(Booking.com hotels only) Rating of the hotel (not according to official scale, must not be displayed as stars).
customer_rating: float|nullThe customer rating on scale from 0 to 10 (the higher the better).
duration_estimate: 3600 int|nullEstimated duration of visit in seconds.
} 0…∞ ] } }Bulk request place details based on their ids.
Parameters
name | type | example | description | |
---|---|---|---|---|
ids |
string
|
"poi:530|poi:531|poi:532|poi:533" |
Concatenate Place IDs by |
Body
Area of the place in square meters.
is_deleted: false boolIf a place is deleted (e.g. out of business), it is still returned by the API when requesting by its ID for backward compatibility.
tags: [ { key: "Restaurant" string name: "Ristorante" string } 0…∞ ] description: { text: "The most iconic sight in all of Paris. Do not miss this iron lady known all around the world. The views from the top are breath-taking." string provider: "wikipedia" enum["wikipedia", "booking.com", null] translation_provider: "google" enum["bing", "google", null] link: string|nullLink contains an URL of the source. It is recommended to use it for attribution together with the provider.
language_id: "en" string|nullLanguage of the description. Description may be delivered in a fallback language, typically English (en).
}|null address: "Purkyňova 649/127" string|null address_details: { country: "Czechia" string|null state: "Alabama" string|null province: "Alberta" string|null city: "Prague" string|null postcode: "12000" string|null district: "Old Town" string|null street: "Staromestska" string|null place: "Staromestske namesti" string|null number: "1a" string|null }[EXPERIMENTAL] Structured address is currently only available for a subset of places.
address_is_approximated: false bool admission: "Adults: €11" string|nullUnstructured, in English
email: "email@example.com" string|null opening_hours_note: "Closed during monsoon season" string|nullNote related to opening hours. In some cases, this property may contain legacy (unstructured) opening hours data.
opening_hours_raw: "Mo-Fr 08:00-12:00,13:00-17:30; Sa 08:00-12:00; PH 09:00-12:00" string|nullStructured opening hours in OSM format. Use Opening hours endpoint to get parsed data for a specific period.
phone: "+33 892 70 12 39" string|null media_count: 15 intIndicated how many photos (videos) is associated with the place.
main_media: { usage: { square: "m:62951" string landscape: "m:62951" string portrait: "m:62951" string video_preview: "m:62951" string|null }Recommended media for specific display cases
media: [ { id: "m:1234" string type: "photo" enum["photo", "photo360", "video", "video360"] url_template: "https://media-cdn.sygictraveldata.com/media/{size}/612664395a40232133447d33247d383235343637373932.jpg" string{size}
is to be replaced i.e. by 400x300
. For the
full description of size please see the Media endpoint description.
Path to original.
?original: { size: 1017931 int|nullSize of original media file
width: 1024 int|nullWidth of original media
height: 768 int|nullHeight of original media
} suitability: [ enum["portrait", "landscape", "square", "video_preview"] 0…∞ ]List of preferred suitability
created_at: "2016-07-10T12:47:51+0000" string source: { provider: "user_upload" string name: "Fotolia" string|null external_id: 123456 string|null } created_by: "55963aff54537" string|null attribution: { title_url: "Nice tower" string|null license: "CC-BY-SA" string|null other: string|null author_url: "http://www.example.com/author" string|null author: "Lojza Bojza" string|null title: "Eiffel Tower" string|null license_url: "http://creativecommons.org/licenses/by/4.0/" string|null } location: { lat: 10.51 float lng: 20.52 float }|null } 0…∞ ] }|null timezone: "America/Toronto" string|nullTimezone according to IANA TZ database. See https://en.wikipedia.org/…e_time_zones
has_shape_geometry: true boolIndicates whether the /places/geometry enpoint will return a shape for this place.
collection_count: 5 intNumber of collections for the place in given language (collections that have the place as parent). See also the Collections endpoint.
references: [ { id: 123 intReference ID.
title: "Official website" stringReference title that can be displayed in UI.
type: "link:official" stringReference type. For a full list of reference types see References sheet.
language_id: "en" string|nullReference language for references that exist in language-specific variants.
Others have null
.
URL of the website linked by reference.
supplier: "facebook" enum["instagram", "facebook", "google_plus", "osm", "twitter", "viator", "wiki", "youtube", "get_your_guide", "booking_com", "rental_cars", "car_trawler", "wikivoyage", null] priority: 0 intCan be used for simple ordering (the higher value the higher priority).
currency: "EUR" string|nullCurrency of reference price
.
[DEPRECATED] Linked product minimum price in USD, applies for hotels.
flags: [ "top_seller" enum["all_inclusive", "destination_menu", "instant_confirmation", "private_guide", "skip_the_line", "special_offer", "bestseller", "mobile_voucher"] 0…∞ ] } 0…∞ ]Place references. For details see section References.
external_ids: [ { id: "node:1234" string type: "openstreetmap" string language_id: "en" string|null } 0…∞ ] ?owner_id: "4afe456ff45e" stringId of the user who created the custom place.
satellite: { image_url: "https://api.sygictraveldata.com/satellite?zoom=17&location=48.8582609%2C2.294499&size=640x480" string bounding_box: { south: 50.076 float west: 14.412 float north: 50.078 float east: 14.414 float }See section Geographical attributes.
}|null attributes: "info:population: 293362" { ^(?![_:])(?!.*?[_:]$)(:?[a-zA-Z0-9]_?)+$: string }|null[EXPERIMENTAL] Additional attributes related to a particular place. Contents is not specified currently.
id: "poi:530" string level: "poi" enum["continent", "country", "state", "region", "county", "city", "town", "village", "settlement", "locality", "neighbourhood", "archipelago", "island", "poi"] categories: [ "sightseeing" enum["discovering", "eating", "going_out", "hiking", "playing", "relaxing", "shopping", "sightseeing", "sleeping", "doing_sports", "traveling"] 0…∞ ]See section Place categories.
tag_keys: [ "Museum" string 0…∞ ]Tag keys, always in English. Full tags property is only available in /places/{id} endpoint response.
rating: 9.555 floatAbsolute popularity rating of the place. Higher rating means higher
popularity. See parameter rating
for more info.
Local adjusted rating of a place. This value is based on rating
,
but adjusts for general popularity of the locality. Local rating is useful for
more uniform distribution of map markers between cities and surroundings.
See section Geographical attributes.
location: { lat: 45.456 float lng: 2.456 float }See section Geographical attributes.
bounding_box: { south: 50.076 float west: 14.412 float north: 50.078 float east: 14.414 float }|nullSee section Geographical attributes.
name: "Eiffel Tower" stringName of the place.
name_suffix: "Paris, France" string|nullSuffix contains parent location. Useful for distinguishing ambiguous locations such as „Chinatown“.
name_local: "Tour Eiffel" string|nullName as used locally, in local language.
name_en: "Eiffel Tower" string|nullEnglish name, if set
name_translated: "Torre Eiffel" string|nullName in requesteed language, if known
perex: "The most iconic sight in all of Paris. Do not miss this iron lady known all around the world. The views from the top are..." string|nullBeginning of place description, up to 160 characters. See description property in Place detail.
url: "https://travel.sygic.com/go/poi:530" string|nullURL of place overview on Sygic Travel. Custom Places do not have an url.
thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null150×150 pixels thumbnail. Get more images using Place detail or Place Media
marker: "sightseeing-tower-lookout" stringName of the suggested marker icon from Sygic Travel default marker icon set. See Place markers.
class: { slug: "sightseeing:tower:lookout" stringType of the place. This can be used e.g. to show a custom marker.
name: "Lookout Tower" string|nullType of the place intended to be shown in the UI.
} parents: [ { id: "city:54" string name: "Brno" string|nullName of the place.
level: "city" enum["continent", "country", "state", "region", "county", "city", "town", "village", "settlement", "locality", "neighbourhood", "archipelago", "island", "poi"] } 0…∞ ] hotel_star_rating: float|null(Booking.com hotels only) Rating in stars (official) from 0 to 5.
hotel_star_rating_unofficial: float|null(Booking.com hotels only) Rating of the hotel (not according to official scale, must not be displayed as stars).
customer_rating: float|nullThe customer rating on scale from 0 to 10 (the higher the better).
duration_estimate: 3600 int|nullEstimated duration of visit in seconds.
} 0…∞ ] } }Returns complete information about a single place. Note that this does not include a complete list of media and geometry – these are available as separate requests as they may contain large amounts of data in some cases.
Parameters
name | type | example | description | |
---|---|---|---|---|
id | inlined in path |
string
|
"poi:530" |
Body
Area of the place in square meters.
is_deleted: false boolIf a place is deleted (e.g. out of business), it is still returned by the API when requesting by its ID for backward compatibility.
tags: [ { key: "Restaurant" string name: "Ristorante" string } 0…∞ ] description: { text: "The most iconic sight in all of Paris. Do not miss this iron lady known all around the world. The views from the top are breath-taking." string provider: "wikipedia" enum["wikipedia", "booking.com", null] translation_provider: "google" enum["bing", "google", null] link: string|nullLink contains an URL of the source. It is recommended to use it for attribution together with the provider.
language_id: "en" string|nullLanguage of the description. Description may be delivered in a fallback language, typically English (en).
}|null address: "Purkyňova 649/127" string|null address_details: { country: "Czechia" string|null state: "Alabama" string|null province: "Alberta" string|null city: "Prague" string|null postcode: "12000" string|null district: "Old Town" string|null street: "Staromestska" string|null place: "Staromestske namesti" string|null number: "1a" string|null }[EXPERIMENTAL] Structured address is currently only available for a subset of places.
address_is_approximated: false bool admission: "Adults: €11" string|nullUnstructured, in English
email: "email@example.com" string|null opening_hours_note: "Closed during monsoon season" string|nullNote related to opening hours. In some cases, this property may contain legacy (unstructured) opening hours data.
opening_hours_raw: "Mo-Fr 08:00-12:00,13:00-17:30; Sa 08:00-12:00; PH 09:00-12:00" string|nullStructured opening hours in OSM format. Use Opening hours endpoint to get parsed data for a specific period.
phone: "+33 892 70 12 39" string|null media_count: 15 intIndicated how many photos (videos) is associated with the place.
main_media: { usage: { square: "m:62951" string landscape: "m:62951" string portrait: "m:62951" string video_preview: "m:62951" string|null }Recommended media for specific display cases
media: [ { id: "m:1234" string type: "photo" enum["photo", "photo360", "video", "video360"] url_template: "https://media-cdn.sygictraveldata.com/media/{size}/612664395a40232133447d33247d383235343637373932.jpg" string{size}
is to be replaced i.e. by 400x300
. For the
full description of size please see the Media endpoint description.
Path to original.
?original: { size: 1017931 int|nullSize of original media file
width: 1024 int|nullWidth of original media
height: 768 int|nullHeight of original media
} suitability: [ enum["portrait", "landscape", "square", "video_preview"] 0…∞ ]List of preferred suitability
created_at: "2016-07-10T12:47:51+0000" string source: { provider: "user_upload" string name: "Fotolia" string|null external_id: 123456 string|null } created_by: "55963aff54537" string|null attribution: { title_url: "Nice tower" string|null license: "CC-BY-SA" string|null other: string|null author_url: "http://www.example.com/author" string|null author: "Lojza Bojza" string|null title: "Eiffel Tower" string|null license_url: "http://creativecommons.org/licenses/by/4.0/" string|null } location: { lat: 10.51 float lng: 20.52 float }|null } 0…∞ ] }|null timezone: "America/Toronto" string|nullTimezone according to IANA TZ database. See https://en.wikipedia.org/…e_time_zones
has_shape_geometry: true boolIndicates whether the /places/geometry enpoint will return a shape for this place.
collection_count: 5 intNumber of collections for the place in given language (collections that have the place as parent). See also the Collections endpoint.
references: [ { id: 123 intReference ID.
title: "Official website" stringReference title that can be displayed in UI.
type: "link:official" stringReference type. For a full list of reference types see References sheet.
language_id: "en" string|nullReference language for references that exist in language-specific variants.
Others have null
.
URL of the website linked by reference.
supplier: "facebook" enum["instagram", "facebook", "google_plus", "osm", "twitter", "viator", "wiki", "youtube", "get_your_guide", "booking_com", "rental_cars", "car_trawler", "wikivoyage", null] priority: 0 intCan be used for simple ordering (the higher value the higher priority).
currency: "EUR" string|nullCurrency of reference price
.
[DEPRECATED] Linked product minimum price in USD, applies for hotels.
flags: [ "top_seller" enum["all_inclusive", "destination_menu", "instant_confirmation", "private_guide", "skip_the_line", "special_offer", "bestseller", "mobile_voucher"] 0…∞ ] } 0…∞ ]Place references. For details see section References.
external_ids: [ { id: "node:1234" string type: "openstreetmap" string language_id: "en" string|null } 0…∞ ] ?owner_id: "4afe456ff45e" stringId of the user who created the custom place.
satellite: { image_url: "https://api.sygictraveldata.com/satellite?zoom=17&location=48.8582609%2C2.294499&size=640x480" string bounding_box: { south: 50.076 float west: 14.412 float north: 50.078 float east: 14.414 float }See section Geographical attributes.
}|null attributes: "info:population: 293362" { ^(?![_:])(?!.*?[_:]$)(:?[a-zA-Z0-9]_?)+$: string }|null[EXPERIMENTAL] Additional attributes related to a particular place. Contents is not specified currently.
id: "poi:530" string level: "poi" enum["continent", "country", "state", "region", "county", "city", "town", "village", "settlement", "locality", "neighbourhood", "archipelago", "island", "poi"] categories: [ "sightseeing" enum["discovering", "eating", "going_out", "hiking", "playing", "relaxing", "shopping", "sightseeing", "sleeping", "doing_sports", "traveling"] 0…∞ ]See section Place categories.
tag_keys: [ "Museum" string 0…∞ ]Tag keys, always in English. Full tags property is only available in /places/{id} endpoint response.
rating: 9.555 floatAbsolute popularity rating of the place. Higher rating means higher
popularity. See parameter rating
for more info.
Local adjusted rating of a place. This value is based on rating
,
but adjusts for general popularity of the locality. Local rating is useful for
more uniform distribution of map markers between cities and surroundings.
See section Geographical attributes.
location: { lat: 45.456 float lng: 2.456 float }See section Geographical attributes.
bounding_box: { south: 50.076 float west: 14.412 float north: 50.078 float east: 14.414 float }|nullSee section Geographical attributes.
name: "Eiffel Tower" stringName of the place.
name_suffix: "Paris, France" string|nullSuffix contains parent location. Useful for distinguishing ambiguous locations such as „Chinatown“.
name_local: "Tour Eiffel" string|nullName as used locally, in local language.
name_en: "Eiffel Tower" string|nullEnglish name, if set
name_translated: "Torre Eiffel" string|nullName in requesteed language, if known
perex: "The most iconic sight in all of Paris. Do not miss this iron lady known all around the world. The views from the top are..." string|nullBeginning of place description, up to 160 characters. See description property in Place detail.
url: "https://travel.sygic.com/go/poi:530" string|nullURL of place overview on Sygic Travel. Custom Places do not have an url.
thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null150×150 pixels thumbnail. Get more images using Place detail or Place Media
marker: "sightseeing-tower-lookout" stringName of the suggested marker icon from Sygic Travel default marker icon set. See Place markers.
class: { slug: "sightseeing:tower:lookout" stringType of the place. This can be used e.g. to show a custom marker.
name: "Lookout Tower" string|nullType of the place intended to be shown in the UI.
} parents: [ { id: "city:54" string name: "Brno" string|nullName of the place.
level: "city" enum["continent", "country", "state", "region", "county", "city", "town", "village", "settlement", "locality", "neighbourhood", "archipelago", "island", "poi"] } 0…∞ ] hotel_star_rating: float|null(Booking.com hotels only) Rating in stars (official) from 0 to 5.
hotel_star_rating_unofficial: float|null(Booking.com hotels only) Rating of the hotel (not according to official scale, must not be displayed as stars).
customer_rating: float|nullThe customer rating on scale from 0 to 10 (the higher the better).
duration_estimate: 3600 int|nullEstimated duration of visit in seconds.
} } }Returns GeoJSON shape with place geometry. Some places are points only and do
not have a geometry – use area
property from place detail to
determine whether geometry will be available. Note that the geometry may be very
large for some regions.
Parameters
name | type | example | description | |
---|---|---|---|---|
id | inlined in path |
string
|
"poi:576" |
Body
Null or valid GeoJSON format
is_shape: boolDescribes if geometry is only a point or a geometry with a shape.
} }Returns array with opening times for a particular date range. Only applicable
to places with machine readable opening hours. Generally, such places have
opening_hours_raw
property set. Beware that parsing is based on
user input and the the request may still return null in case we are unable to
parse the source data.
Parameters
name | type | example | description | |
---|---|---|---|---|
from |
date (YYYY-MM-DD)
|
"2018-12-01" |
Start of the interval. |
|
to |
date (YYYY-MM-DD)
|
"2019-01-31" |
End of the interval (included). |
|
id | inlined in path |
string
|
"poi:530" |
Body
h:m:s (24h) format.
closing: "18:30:00" string(~\d{2}:\d{2}:\d{2}~)h:m:s (24h) format.
note: "Closed in bad weather" null|stringNote related to this particular interval
} 0…∞ ] }|nullNull if we do not have data or data is invalid.
} }Returns stats of tags and categories usage for a subset of places defined by search parameters. The search parameters are mostly identical to the Places list endpoint, which is useful to get categories and/or tags to display to the user to allow drill down into the Places data.
Parameters
name | type | example | description | |
---|---|---|---|---|
query | optional |
string
|
"Eiffel Tower" |
Fulltext search query. Supports partial prefix & fuzzy matching, matches also against names of parent places, and works in multiple languages. |
levels | optional |
string
|
"city" |
Limit results by levels. Pass multiple levels using separators |
categories | optional |
string
|
"sightseeing|restaurant" |
Limit results by categories. Pass multiple categories using separators
|
categories_not | optional |
string
|
"sightseeing|restaurant" |
Limit results by excluding categories. It is possible to pass multiple
categories to exclude using separators |
map_tiles | optional |
string
|
"210313123|210313122" |
Limit results to area defined by quadkey. See section Geographical attributes. You can provide
multiple map_tiles separeated by |
bounds | optional |
string
|
"48.858,2.294,48.860,2.296" |
Limit results to area defined by bounds. Bounds are defined by string
composed of four floats in format |
map_tile_bounds | optional |
string
|
"12021230,12021131" |
Limit results to area defined by quadkeys. See section Geographical attributes. You should provide two quadkeys separated by comma. The first one represents south west corner of the area and the second one the north east corner of the area. |
area | optional |
string(~^-?(\d+|\d*\.\d+),-?(\d+|\d*\.\d+),(\d+|\d*\.\d+)$~)
|
"48.858,2.294,1000" |
Limit results to area defined by a centre and a radius in meters. The units
of the centre are in degrees of latitude/longitude. See also parameter
|
tags | optional |
string
|
"Restaurant|Bar" |
Limit results by tags. Pass multiple tags using separators |
tags_not | optional |
string
|
"Restaurant|Bar" |
Limit results by excluding tags. Pass multiple tags to exclude using
separators |
parents | optional |
string
|
"city:14" |
Limit results by ID of parent place. Pass multiple IDs using separators
|
hotel_star_rating | optional |
string
|
"1:3" |
(Only available for Booking.com hotels) Limit results by checking if
hotel_star_rating or hotel_star_rating_unofficial of the accommodation is
within the given range. Values in range |
customer_rating | optional |
string
|
"1:7" |
(Only available for Booking.com hotels) Limit results by accommodation
customer_rating range. Values in range |
Body
Number of available places with given category.
} 0…∞ ] tags: [ { key: "Restaurant" string name: "Ristorante" string count: 1359 intNumber of available places with given tag.
} 0…∞ ] } } }Detect parent IDs for given GPS coordinates. The places are ordered by area size.
Parameters
name | type | example | description | |
---|---|---|---|---|
location |
string
|
"49.1943639,16.5994451" |
|
Body
See section Place categories.
tag_keys: [ "Museum" string 0…∞ ]Tag keys, always in English. Full tags property is only available in /places/{id} endpoint response.
rating: 9.555 floatAbsolute popularity rating of the place. Higher rating means higher
popularity. See parameter rating
for more info.
Local adjusted rating of a place. This value is based on rating
,
but adjusts for general popularity of the locality. Local rating is useful for
more uniform distribution of map markers between cities and surroundings.
See section Geographical attributes.
location: { lat: 45.456 float lng: 2.456 float }See section Geographical attributes.
bounding_box: { south: 50.076 float west: 14.412 float north: 50.078 float east: 14.414 float }|nullSee section Geographical attributes.
name: "Eiffel Tower" stringName of the place.
name_suffix: "Paris, France" string|nullSuffix contains parent location. Useful for distinguishing ambiguous locations such as „Chinatown“.
name_local: "Tour Eiffel" string|nullName as used locally, in local language.
name_en: "Eiffel Tower" string|nullEnglish name, if set
name_translated: "Torre Eiffel" string|nullName in requesteed language, if known
perex: "The most iconic sight in all of Paris. Do not miss this iron lady known all around the world. The views from the top are..." string|nullBeginning of place description, up to 160 characters. See description property in Place detail.
url: "https://travel.sygic.com/go/poi:530" string|nullURL of place overview on Sygic Travel. Custom Places do not have an url.
thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null150×150 pixels thumbnail. Get more images using Place detail or Place Media
marker: "sightseeing-tower-lookout" stringName of the suggested marker icon from Sygic Travel default marker icon set. See Place markers.
class: { slug: "sightseeing:tower:lookout" stringType of the place. This can be used e.g. to show a custom marker.
name: "Lookout Tower" string|nullType of the place intended to be shown in the UI.
} parents: [ { id: "city:54" string name: "Brno" string|nullName of the place.
level: "city" enum["continent", "country", "state", "region", "county", "city", "town", "village", "settlement", "locality", "neighbourhood", "archipelago", "island", "poi"] } 0…∞ ] hotel_star_rating: float|null(Booking.com hotels only) Rating in stars (official) from 0 to 5.
hotel_star_rating_unofficial: float|null(Booking.com hotels only) Rating of the hotel (not according to official scale, must not be displayed as stars).
customer_rating: float|nullThe customer rating on scale from 0 to 10 (the higher the better).
duration_estimate: 3600 int|nullEstimated duration of visit in seconds.
} 0…∞ ] } }Detect places that cover enough of the given bounds. Can be used to detect prevailing destination in the current map bounds. The places are ordered by the coverage of the area.
Parameters
name | type | example | description | |
---|---|---|---|---|
bounds | optional |
string
|
"49.08825778,11.27197265,50.67383524,21.46728515" |
Bounds are defined by string composed of four floats in format
|
map_tile_bounds | optional |
string
|
"12021230,12021131" |
Quadkeys defining the area. See section Geographical attributes. You should provide two quadkeys separated by comma. The first one represents south west corner of the area and the second one the north east corner of the area. |
Body
See section Place categories.
tag_keys: [ "Museum" string 0…∞ ]Tag keys, always in English. Full tags property is only available in /places/{id} endpoint response.
rating: 9.555 floatAbsolute popularity rating of the place. Higher rating means higher
popularity. See parameter rating
for more info.
Local adjusted rating of a place. This value is based on rating
,
but adjusts for general popularity of the locality. Local rating is useful for
more uniform distribution of map markers between cities and surroundings.
See section Geographical attributes.
location: { lat: 45.456 float lng: 2.456 float }See section Geographical attributes.
bounding_box: { south: 50.076 float west: 14.412 float north: 50.078 float east: 14.414 float }|nullSee section Geographical attributes.
name: "Eiffel Tower" stringName of the place.
name_suffix: "Paris, France" string|nullSuffix contains parent location. Useful for distinguishing ambiguous locations such as „Chinatown“.
name_local: "Tour Eiffel" string|nullName as used locally, in local language.
name_en: "Eiffel Tower" string|nullEnglish name, if set
name_translated: "Torre Eiffel" string|nullName in requesteed language, if known
perex: "The most iconic sight in all of Paris. Do not miss this iron lady known all around the world. The views from the top are..." string|nullBeginning of place description, up to 160 characters. See description property in Place detail.
url: "https://travel.sygic.com/go/poi:530" string|nullURL of place overview on Sygic Travel. Custom Places do not have an url.
thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null150×150 pixels thumbnail. Get more images using Place detail or Place Media
marker: "sightseeing-tower-lookout" stringName of the suggested marker icon from Sygic Travel default marker icon set. See Place markers.
class: { slug: "sightseeing:tower:lookout" stringType of the place. This can be used e.g. to show a custom marker.
name: "Lookout Tower" string|nullType of the place intended to be shown in the UI.
} parents: [ { id: "city:54" string name: "Brno" string|nullName of the place.
level: "city" enum["continent", "country", "state", "region", "county", "city", "town", "village", "settlement", "locality", "neighbourhood", "archipelago", "island", "poi"] } 0…∞ ] hotel_star_rating: float|null(Booking.com hotels only) Rating in stars (official) from 0 to 5.
hotel_star_rating_unofficial: float|null(Booking.com hotels only) Rating of the hotel (not according to official scale, must not be displayed as stars).
customer_rating: float|nullThe customer rating on scale from 0 to 10 (the higher the better).
duration_estimate: 3600 int|nullEstimated duration of visit in seconds.
} 0…∞ ] } }Finds places that best match based on known properties. This endpoint is designed to be used to match places from external data sources. Every property used in search query can rise confidence by maximum of value within table below. This endpoint is designed to work with incomplete or incorrect data, i.e. it will still yield results even if names, location, tags etc. do not exactly match. Confidence scores from all properties are summed up. Up to 50 possible matches are returned ranked by confidence and rating. Places must have a minimum confidence of 0.3 to be included.
Confidences for properties are:
Property | Confidence | Note |
-------------- | ------------ | ---------------------------------- |
Id | 1.0 | Per matched ID |
Name | 0.6 | Levenshtein distance penalisation |
Location | 0.6 | Gaussian penalisation on distance |
Parent | 0.3 | |
Levels | 0.2 | |
Tags | 0.1 | Per tag |
Body
Distance in meters where no penalisation is given
?scale: 500 intDistance in meters where half penalisation is given using gaussian distribution
}|null parent: "country:7" string|null ids: [ { id: "Q23086" string type: enum["iata", "icao", "booking.com", "osm", "wikidata", "wikipedia"] } 0…∞ ] tags: [ "Restaurant" string 0…∞ ]Tags expected in matched places.
levels: [ "island" enum["continent", "country", "state", "region", "county", "city", "town", "village", "settlement", "locality", "neighbourhood", "archipelago", "island", "poi", null] 0…∞ ]Expected levels of matched places.
}Body
Places Media #
Media API provides photos and videos for Sygic Places together with detailed metadata, photo resizing and video previews.
How to use media
– You will obtain a basic thumbnail image information directly in the
/places/lists
call. The thumbnail is intended to lead to a place
detail, where the full image is shown (and properly attributed).
- You will get the preferred photo information in the /places/{id}
call, including a template URL to dynamically resize the photo.
- Use a separate call to /places/media
to list all media associated
to the place, e.g. for showing a gallery.
Attribution Requirements
Every medium entity returned from the API contains the
attribution
property that defines the title, author and license of
the medium.
When displaying media in your user interface, you need to state the following
data from the attribution object somewhere on the screen
where the medium is used:
– Media title
, including a link when title_url
is
set.
- Media author
(if set), including a link when
author_url
is set.
- Media licence
, including a link when license_url
is set.
Parameters
name | type | example | description | |
---|---|---|---|---|
id | inlined in path |
string
|
"poi:576" |
Value of property url_template
can be used to request a resized
photo or video that better match user interface requirements.
{size}
placeholder has to be replaced by valid size value. Media
always maintain aspect ratio when resized.
Photos:
Supported size values are ({W}
– width in pixels,
{H}
– height in pixels):
{W}x{H}
– Image is resized to fill the requested rectangle. If one edge overlaps, image is cropped.{W}x{H}nc
(no-crop) One edge matches the requested size, other may be smaller according to the aspect ratio.{W}x{H}ncfill
(no-crop-fill) One edge matches the requested size, other may be bigger according to the aspect ratio.
Videos:
- For videos the above values will generate thumbnails using the same rules as for photos. Thumbnails are cropped from the center for 360° videos (where the image is least distorted)
- Optionally, for 360° videos you may request a full screenshot with
fullsize
placeholder. - For 360° videos you can also use
1080p
and720p
for respective lower resolutions. Lower resolution dramatically improves download times.
Body
{size}
is to be replaced i.e. by 400x300
. For the
full description of size please see the Media endpoint description.
Path to original.
?original: { size: 1017931 int|nullSize of original media file
width: 1024 int|nullWidth of original media
height: 768 int|nullHeight of original media
} suitability: [ enum["portrait", "landscape", "square", "video_preview"] 0…∞ ]List of preferred suitability
created_at: "2016-07-10T12:47:51+0000" string source: { provider: "user_upload" string name: "Fotolia" string|null external_id: 123456 string|null } created_by: "55963aff54537" string|null attribution: { title_url: "Nice tower" string|null license: "CC-BY-SA" string|null other: string|null author_url: "http://www.example.com/author" string|null author: "Lojza Bojza" string|null title: "Eiffel Tower" string|null license_url: "http://creativecommons.org/licenses/by/4.0/" string|null } location: { lat: 10.51 float lng: 20.52 float }|null } 0…∞ ] } }Tours #
Tours API provides online access to tours, tickets, attractions, and other activities, using data from multiple providers. These activities can be searched and filtered by various parameters and a booking link with custom affiliate ID can be presented to end users. At the moment, we support the following providers:
- Get Your Guide – tours from https://www.getyourguide.com with live data, rich filtering, and stats endpoint with counts for selected filters.
- Viator – tours from https://www.viator.com with filters by parent place ID.
Parameters
name | type | example | description | |
---|---|---|---|---|
parent_place_id |
string
|
"city:11" | ||
page | optional |
int
1…∞
|
2 |
Requested page. Each page contains 20 tours. |
sort_by | optional |
enum["price", "rating", "top_sellers"]
|
"price" |
Field used for sorting. Default is |
sort_direction | optional |
enum["asc", "desc"]
|
"asc" |
Descending ordering is not available for |
Body
Tour title.
perex: "See Paris from the sky..." stringShort tour description.
url: "https://www.getyourguide.com/paris-l16/paris-eiffel-tower-ticket-with-priority-access-t69655/?partner_id=J6QH2HY" stringTour URL on provider's website including customizable affiliate ID.
rating: 4.0164 floatTour rating from user reviews on scale from 0 (the worst) to 5 (the best).
review_count: 152 intCount of user reviews.
photo_url: "https://cdn.getyourguide.com/img/tour_img-453833-[format_id].jpg" stringIn case of get_your_guide
supplier the url contains a
placeholder [format_id]
which has to be replaced with valid format
id (see the
list).
Final tour price in USD.
original_price: 50 floatTour price in USD without any discounts.
duration: "3 hours and 30 minutes" string|nullDuration of the tour or activity as text.
duration_min: 7200 int|nullMinimum duration of the tour or activity in seconds.
duration_max: 21600 int|nullMaximum duration of the tour or activity in seconds.
flags: [ enum["bestseller", "instant_confirmation", "portable_ticket", "wheelchair_access", "skip_the_line"] 0…∞ ]Special flags of the tour as defined by Get Your Guide.
} 0…∞ ] } }bounds
or parent_place_id
parameter must be present.
Parameters
name | type | example | description | |
---|---|---|---|---|
query | optional |
string
|
"eiffel+tower" | |
bounds | optional |
string
|
"41.78,12.34,41.99,12.64" |
Limit results to area defined by bounds. Bounds are defined by string
composed of four floats in format |
parent_place_id | optional |
string
|
"city:11" |
Limits results by parent place. This parameter is exclusive with
|
tags | optional |
string
|
"11,10" |
Comma separated tag ids (logical AND) |
from | optional |
localdatetime (YYYY-mm-ddTHH:ii:ss)
|
"2017-10-20T08:00:00" | |
to | optional |
localdatetime (YYYY-mm-ddTHH:ii:ss)
|
"2017-10-22T23:00:00" | |
duration | optional |
string
|
"3600:7200" |
Tour duration range in seconds. Accepts open intervals, e.g.
|
page | optional |
int
|
2 | |
count | optional |
int
|
10 |
Requested count per page. |
sort_by | optional |
enum["price", "duration", "rating", "popularity"]
|
"price" |
Field used for sorting. Default value: |
sort_direction | optional |
enum["asc", "desc"]
|
"asc" |
Body
Tour title.
perex: "See Paris from the sky..." stringShort tour description.
url: "https://www.getyourguide.com/paris-l16/paris-eiffel-tower-ticket-with-priority-access-t69655/?partner_id=J6QH2HY" stringTour URL on provider's website including customizable affiliate ID.
rating: 4.0164 floatTour rating from user reviews on scale from 0 (the worst) to 5 (the best).
review_count: 152 intCount of user reviews.
photo_url: "https://cdn.getyourguide.com/img/tour_img-453833-[format_id].jpg" stringIn case of get_your_guide
supplier the url contains a
placeholder [format_id]
which has to be replaced with valid format
id (see the
list).
Final tour price in USD.
original_price: 50 floatTour price in USD without any discounts.
duration: "3 hours and 30 minutes" string|nullDuration of the tour or activity as text.
duration_min: 7200 int|nullMinimum duration of the tour or activity in seconds.
duration_max: 21600 int|nullMaximum duration of the tour or activity in seconds.
flags: [ enum["bestseller", "instant_confirmation", "portable_ticket", "wheelchair_access", "skip_the_line"] 0…∞ ]Special flags of the tour as defined by Get Your Guide.
} 0…∞ ] } }Parameters
name | type | example | description | |
---|---|---|---|---|
query | optional |
string
|
"eiffel+tower" | |
bounds | optional |
string
|
"41.78,12.34,41.99,12.64" |
Limit results to area defined by bounds. Bounds are defined by string
composed of four floats in format |
parent_place_id | optional |
string
|
"city:11" |
Limits results by parent place. This parameter is exclusive with
|
tags | optional |
string
|
"11,10" |
Comma separated tag ids (logical AND) |
from | optional |
localdatetime (YYYY-mm-ddTHH:ii:ss)
|
"2017-10-22T23:00:00" | |
to | optional |
localdatetime (YYYY-mm-ddTHH:ii:ss)
|
"2017-10-22T23:00:00" | |
duration | optional |
string
|
"3600:7200" |
Tour duration range in seconds. Accepts open intervals, e.g.
|
Body
/tours/viator
instead.Parameters
name | type | example | description | |
---|---|---|---|---|
destination_id |
string
|
"city:11" | ||
page | optional |
int
1…∞
|
2 |
Requested page. Each page contains 20 tours. |
sort_by | optional |
enum["price", "rating", "top_sellers"]
|
"price" |
Field used for sorting. Default is rating_count |
sort_direction | optional |
enum["asc", "desc"]
|
"asc" |
DESC is not supported for top_sellers sorting. |
Body
Tour title.
perex: "See Paris from the sky..." stringShort tour description.
url: "https://www.getyourguide.com/paris-l16/paris-eiffel-tower-ticket-with-priority-access-t69655/?partner_id=J6QH2HY" stringTour URL on provider's website including customizable affiliate ID.
rating: 4.0164 floatTour rating from user reviews on scale from 0 (the worst) to 5 (the best).
review_count: 152 intCount of user reviews.
photo_url: "https://cdn.getyourguide.com/img/tour_img-453833-[format_id].jpg" stringIn case of get_your_guide
supplier the url contains a
placeholder [format_id]
which has to be replaced with valid format
id (see the
list).
Final tour price in USD.
original_price: 50 floatTour price in USD without any discounts.
duration: "3 hours and 30 minutes" string|nullDuration of the tour or activity as text.
duration_min: 7200 int|nullMinimum duration of the tour or activity in seconds.
duration_max: 21600 int|nullMaximum duration of the tour or activity in seconds.
flags: [ enum["bestseller", "instant_confirmation", "portable_ticket", "wheelchair_access", "skip_the_line"] 0…∞ ]Special flags of the tour as defined by Get Your Guide.
} 0…∞ ] } }Trips #
Trips API provides data about specific trip itineraries. You can use it to get trip templates – suggested trip itineraries for selected cities, regions or countries.
A trip template consists of a list of suggested places to visit; sorted in the recommended order of visiting. Trip templates are available for one-day trips as well as for trips spanning several days. Each trip template has a descriptive name (English only).
Please note that trip templates are only available for selected destinations. See Trip Templates Destinations for the list of destinations with at least one trip template.
Get full data about a trip itinerary using its ID.
Parameters
name | type | example | description | |
---|---|---|---|---|
id | inlined in path |
string
|
"58db672c280b5" |
Trip ID. |
Body
ID of the user that created the trip
name: "My Trip to Prague" string|null version: 20 intVersion is incremented with each change
url: "https://travel.sygic.com/go/trip:58db672c280b5" string updated_at: "2017-03-30T08:01:39+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) is_deleted: false boolTrip was soft deleted and should not be displayed.
privacy_level: "shareable" enum["private", "shareable", "public"] privileges: { edit: true bool manage: true bool delete: true bool join: true boolThe property is false if the trip is private or user is already joined or is trip owner.
}Privileges of the current user to the trip.
starts_on: "2017-03-27" date (YYYY-MM-DD)|null ends_on: "2017-03-29" date (YYYY-MM-DD)|null day_count: 3 int days: [ { itinerary: [ { place_id: "poi:530" string start_time: 32400 int|nullNumber of seconds from midnight.
duration: 3600 int|nullTime in seconds planned to spend visiting place.
note: "Don't forget to use promo code: 456789" string|null transport_from_previous: { mode: "car" enum["car", "pedestrian", "bike", "plane", "bus", "train", "boat", "public_transit"] avoid: [ enum["tolls", "highways", "ferries", "unpaved"] 0…∞ ] start_time: 32400 int|nullNumber of seconds from midnight.
duration: 3600 int|nullTime in seconds spent on the transport.
note: "Ticket Number: 1234" string|null waypoints: [ { place_id: "poi:12727" string|null location: { lat: 50.05546 float lng: 0.05546 float } } 0…∞ ] ?route_id: "12345:45612" string|null }|null } 0…∞ ] note: string|null } 0…∞ ] media: null|{ square: { id: "m:1234" string url_template: "https://media-cdn.sygictraveldata.com/photo/{size}/612664395a40232133447d33247d383234313431323731.jpg" string } landscape: { id: "m:1234" string url_template: "https://media-cdn.sygictraveldata.com/photo/{size}/612664395a40232133447d33247d383234313431323731.jpg" string } portrait: { id: "m:1234" string url_template: "https://media-cdn.sygictraveldata.com/photo/{size}/612664395a40232133447d33247d383234313431323731.jpg" string } video_preview: { id: "m:1234" string url_template: "https://media-cdn.sygictraveldata.com/photo/{size}/612664395a40232133447d33247d383234313431323731.jpg" string }|null } user_is_subscribed: true boolUser is subscribed to a trip when he is the owner of the trip or one of the collaborators. The value is related to the currently authenticated user.
destinations: [ "city:1" string 0…∞ ]Summary of trip destinations. Beware that destinations might not be available for some trips.
} } }Get a list of suggested trip itineraries for a specific city, region or
country. The response contains only basic trip data, use the
/trips/{id}
endpoint to get the details.
Parameters
name | type | example | description | |
---|---|---|---|---|
parent_place_id |
string
|
"city:1" |
The endpoint returns an array of trip entities.
Body
ID of the user that created the trip
name: "My Trip to Prague" string|null version: 20 intVersion is incremented with each change
url: "https://travel.sygic.com/go/trip:58db672c280b5" string updated_at: "2017-03-30T08:01:39+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) is_deleted: false boolTrip was soft deleted and should not be displayed.
privacy_level: "shareable" enum["private", "shareable", "public"] privileges: { edit: true bool manage: true bool delete: true bool }Privileges of the current user to the trip.
starts_on: "2017-03-27" date (YYYY-MM-DD)|null ends_on: "2017-03-29" date (YYYY-MM-DD)|null day_count: 3 int media: null|{ square: { id: "m:1234" string url_template: "https://media-cdn.sygictraveldata.com/photo/{size}/612664395a40232133447d33247d383234313431323731.jpg" string } landscape: { id: "m:1234" string url_template: "https://media-cdn.sygictraveldata.com/photo/{size}/612664395a40232133447d33247d383234313431323731.jpg" string } portrait: { id: "m:1234" string url_template: "https://media-cdn.sygictraveldata.com/photo/{size}/612664395a40232133447d33247d383234313431323731.jpg" string } video_preview: { id: "m:1234" string url_template: "https://media-cdn.sygictraveldata.com/photo/{size}/612664395a40232133447d33247d383234313431323731.jpg" string }|null } } 0…∞ ] } }