Sygic Travel API

The Sygic Travel API is a REST JSON API providing an access to the Sygic Travel Places data.

Authentication

To start using the Sygic Travel API you need to obtain an API key. To get the key please contact us. Each request must contain an authorization header x-api-key.

Versioning

The latest API version is 1.1. See changelog.

The API always requires a version parameter in the URL. Changes made in the new versions will be documented in a changelog. Old versions will be supported together with the new ones following end-of-life policies which will be specified in future.

Testing the API

You can test if everything works correctly by searching the Eiffel Tower using the following API query that should give you a list of places matching the search query:

  • https://api.sygictravelapi.com/1.1/en/places/list?query=eiffel

    (Do not forget to include the x-api-key header.)

Status

You can check the API availability at the status page

Languages

Data in Sygic Travel API is available in multiple languages. You can select the language using the parameters.

URL prefix

https://api.sygictravelapi.com/1.1/{lang}


Headers

name type example description
x-api-key
string
"{{__X-API-KEY__}}"

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"]
"en"

Alerts #

Travel Alerts API returns a list of alerts about severe weather conditions (e.g. strong wind, heavy rain and snow) and natural disasters (e.g. earthquakes, tornadoes, cyclones) in a specific area.

#

Parameters

name type example description
from
date (YYYY-MM-DD)
"2017-12-24"

Lower boundary date of the alert.

to
date (YYYY-MM-DD)
"2017-12-31"

Upper boundary date of the alert.

types optional
string
"rain|fog|snow|wind"

Limit results by type. It is possible to pass multiple types. Separators have to be url-encoded and the only allowed option is: | (logical OR). For possible values please see the list of values in response.

severities optional
string
"severe|extreme"

Limit results by severity. It is possible to pass multiple severities. Separators have to be url-encoded and the only allowed option is: | (logical OR). Possible values are: minor, moderate, severe, extreme and unknown.

states optional
string
"active|outadated"

Limit results by state. It is possible to pass multiple states. Separators have to be url-encoded and the only allowed option is: | (logical OR). Possible values are: active, outdated, insufficient data, canceled.

place_ids optional
string
"poi:141|poi:156"

Limit results by ID of place. It is possible to pass multiple place ids. Separators have to be url-encoded and the only allowed option is: | (logical OR).

bounds optional
string
"48.858,2.294,48.860,2.296"

Limit results to alerts that interescts with area defined by bounds. Bounds are defined by string composed of four floats in format {south},{west},{north},{east}. The units are in degrees of latitude/longi­tude."

map_tile_bounds optional
string
"12021230,12021131"

Limit results to alerts that interescts with 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.

limit optional
int 1…1000
100

Limit the number of returned results. Default limit is 100, maximal accepted value is 1000.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { alerts: [ { id: 213 int name: "Flood Advisory issued March 25 at 8:35PM MDT by NWS GreatFalls" string perex: "THE FLOOD ADVISORY FOR SNOWMELT FOR MINOR FLOODING IN POOR DRAINAGE AREAS REMAINS IN EFFECT UNTIL 600 PM MDT MONDAY FOR JUDITH BASIN AND FERGUS COUNTIES" string|null type: "flood" enum["air_polution", "wind", "tornado", "rain", "fog", "freeze", "snow", "blizzard", "flood", "avalanche", "storm", "severe_weather", "earthquake", "icing", "coastal_hazards", "unknown", "volcano", "cold_front"] severity: "minor" enum["minor", "moderate", "severe", "extreme", "unknown"] origin: "cap_collator_bot" string provider: "aemet.es" string|null provider_url: "http://www.aemet.es/es/eltiempo/prediccion/avisos" string|null affected_area: any

Area affected by alert as valid GeoJSON

updated_at: "2018-09-25T23:47:05+02:00" datetime (YYYY-mm-ddTHH:ii:ssZ)

Date and time ol last update

state: "active" enum["active", "insufficient data", "outdated", "canceled"] valid_from: "2018-09-25T23:47:05+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ)

Date and time alert comes into effect

valid_to: "2018-10-26T17:00:00+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ)

Date and time alert ends

}
0…∞
]
}
}
#

This endpoint provides complete information about an alert. The response also includes basic information from the /alerts/list endpoint.

Parameters

name type example description
id inlined in path
int
123

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { alert: { external_id: "NOAA-NWS-ALERTS-MT125A992A014C.FloodAdvisory.125A993B85ACMT.TFXFLSTFX.5e519e4ca3c6a8d84dfe20c8b6d37d7e" string web_url: "https://example.com/" string|null description: "Something will go wrong." string|null geometry: any|null

Detailed area affected by alert as valid GeoJSON. Detailed area is provided only for some alerts.

id: 213 int name: "Flood Advisory issued March 25 at 8:35PM MDT by NWS GreatFalls" string perex: "THE FLOOD ADVISORY FOR SNOWMELT FOR MINOR FLOODING IN POOR DRAINAGE AREAS REMAINS IN EFFECT UNTIL 600 PM MDT MONDAY FOR JUDITH BASIN AND FERGUS COUNTIES" string|null type: "flood" enum["air_polution", "wind", "tornado", "rain", "fog", "freeze", "snow", "blizzard", "flood", "avalanche", "storm", "severe_weather", "earthquake", "icing", "coastal_hazards", "unknown", "volcano", "cold_front"] severity: "minor" enum["minor", "moderate", "severe", "extreme", "unknown"] origin: "cap_collator_bot" string provider: "aemet.es" string|null provider_url: "http://www.aemet.es/es/eltiempo/prediccion/avisos" string|null affected_area: any

Area affected by alert as valid GeoJSON

updated_at: "2018-09-25T23:47:05+02:00" datetime (YYYY-mm-ddTHH:ii:ssZ)

Date and time ol last update

state: "active" enum["active", "insufficient data", "outdated", "canceled"] valid_from: "2018-09-25T23:47:05+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ)

Date and time alert comes into effect

valid_to: "2018-10-26T17:00:00+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ)

Date and time alert ends

}
}
}

GeoIP #

GeoIP API provides detection of geographical attributes such as location and country code using client's IP address. The country codes follow ISO 3116 standard with the addition of a few region-specific codes as defined by MaxMind GeoIP database.

#

This endpoint returns geographical location and country code as detected from request IP address. For a full list of supported country codes see MaxMind GeoIP database country codes list.

No request data.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { geoip: { location: { lat: 49.2 float lng: 16.6333 float } country_code: "cz" string }|null } }

Media #

Media API provides photos and videos for Sygic Travel places together with detailed metadata, photo resizing and video previews.

Attribution

Every medium entity returned from the API contains attribution property that defines 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, as a link when title_url is set.
  • Media author (if set), as a link when author_url is set.
  • Media licence, as a link when license_url is set.
#

Parameters

name type example description
id inlined in path
string

Value of property url_template returned within the response contains {size} placeholder which has to be replaced by valid size value.

Photos:
Supported size values are ({W} – width in pixels, {H} – height in pixels):

  • {W}x{H} – Image is resized to match exactly the requested size. 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.
  • Optionally, for 360° videos you may want get an original thumbnail without the center cropping; use fullsize placeholder for this.
  • To get the original resized video (a video with lower quiality), put a 1080p and 720p as placeholder. A 1080p video may redirect to lower quality if 1080p not present.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { 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} has to be relpaced i.e. by 400x300. For full description of size see media endpoint description.

url: "https://media-cdn.sygictraveldata.com/media/612664395a40232133447d33247d383235343637373932.jpg" string

Path to original.

?original: { size: 1017931 int|null

Size of original media file

width: 1024 int|null

Width of original media

height: 768 int|null

Height 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…∞
]
}
}

Places #

The Places API provides detailed information about Sygic Places. It enables you to query places in a specified location or get the places from a selected destination. You can filter the places using administrative levels, categories and tags.

Examples

Please note the following examples do not work in a browser since the x-api-key header is mandatory. You can use tools such as Postman.

  • Top twenty restaurants in London: https://api.sygictravelapi.com/1.1/en/places/list?parents=city:1&categories=eating&limit=20
  • Top ten restaurants in an area: https://api.sygictravelapi.com/1.1/en/places/list?bounds=51.487744,-0.1879067,51.526849,-0.0464577&categories=eating
  • Top ten pois an area: https://api.sygictravelapi.com/1.1/en/places/list?bounds=51.487744,-0.1879067,51.526849,-0.0464577&levels=poi
  • Fulltext query search in an area: https://api.sygictravelapi.com/1.1/en/places/list?query=Tower&bounds=51.487744,-0.1879067,51.526849,-0.0464577
  • Detailed information about the Eiffel Tower: https://api.sygictravelapi.com/1.1/en/places/poi:530
  • Eiffel Tower photos and videos: https://api.sygictravelapi.com/1.1/en/places/poi:530/media

Country and city IDs

You can find the country and city IDs, that can be used in the API queries, in the following files. You can browse them in Google Sheets or download them in CSV format:

Place 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, islandpoi

Query example:

  • Top 10 cities in the United Kingdom: https://api.sygictravelapi.com/1.1/en/places/list?parents=country:1&levels=city&limit=10

Place 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 use our trip planner app to browse the categories.

Please note that sleeping category is using the data from Booking.com and it is only available to partners that have a valid API access contract with Booking.com.

Query example:

  • Top 10 places in London in the Sightseeing category: https://api.sygictravelapi.com/1.1/en/places/list?parents=city:1&categories=sightseeing&limit=10

Place tags

Each place can have multiple tags which describe the place or its properties. Tags can be used to filter places. See the list of available tags.

Query example:

  • Places with the Bar tag in London: https://api.sygictravelapi.com/1.1/en/places/list?parents=city:1&tags=Bar

Place markers

Each place has a marker property that specifies which icon can be used when displaying the place in user interface. Markers have hierarchical structure that allows usage of very specific icons as well as a smaller general icon set. Levels of marker string are delimited by : where right part describes the left part more in detail.

A maker value can be for instance eating but when a more detailed information is available, the type of eating will be included as well, i.e. eating:restaurant. There can be multiple nesting levels describing more and more details, i.e. eating:restaurant:asian or eating:restaurant:burgers:burger_king. Such detailed marker allows you to display a very specific icon (i.e. Burger King's logo), but if there is no such icon available, it will fallback to eating:restaurant:burgers, eating:restaurant, or eating.

For a full list of all available markers see Markers sheet.

You can use the provided default marker icon set for free. Note that not all markers have default icons – a very detailed marker set is provided to allow usage of specific custom icons, but when an icon is not available a fallback should be used. You can download a full package of the default markers here.

Geographical attributes

Places and certain other objects can have geographical attributes describing their location and area. Supported attributes are:

  • 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.

Query examples:

  • Places within a specified bounding box: https://api.sygictravelapi.com/1.1/en/places/list?bounds=51.487744,-0.1879067,51.526849,-0.0464577&levels=poi
  • Places within a specified quadkey: https://api.sygictravelapi.com/1.1/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.

Please note that tickets, tours, city passes and transfers will be available to you only if the products from Viator/GetYourGuide were enabled in your API key. If you have an affiliate account at Viator/GetYou­rGuide, your affiliate ID can be added to your API key and you can offer these products to your customers and earn affiliate commission. For more information please contact us.

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 reference type, clients can decide if, how, and where to display particular references. For simple sorting a preset priority can be used.

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 References sheet.

Some references have multiple language variants – in such cases the reference's lan­guage is specified by 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

Sygic Places uses OpenStreetMap.org as a base data. When using the Sygic Travel API, you need to attribute OpenStreetMap.org somewhere at your website or app as described here.

Depending on the provider of 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 original description written in other 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 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. It is possible to pass multiple levels. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed. See section Place levels.

categories optional
string
"sightseeing|restaurant"

Limit results by categories. It is possible to pass multiple categories. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed. See section Place categories.

categories_not optional
string
"sightseeing|restaurant"

Limit results by excluding categories. It is possible to pass multiple categories. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed. See section Place categories.

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 | (logical OR). All map tiles have to be same length. Using multiple map_tiles with map_spread will also change behaviour of limit parameter, so that limit is applied per each tile.

map_spread optional
int
1

Possible values are from <0-3> interval (1 subdivides area to 4 subareas, 2 to 16, and 3 to 64). Equal amount of pois is being picked for each area to fill the limit. This makes pois being laid out evenly. Otherwise pois from center of the city would suppress pois with lower rating from the outer districts of city, because the city center would take all the limit.

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 {south},{west},{north},{east}. The units are in degrees of latitude/longi­tude."

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.

tags optional
string
"Restaurant|Bar"

Limit results by tags. It is possible to pass multiple tags. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed.

tags_not optional
string
"Restaurant|Bar"

Limit results by excluding tags. It is possible to pass multiple tags. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed.

parents optional
string
"city:14"

Limit results by ID of parent place. It is possible to pass multiple parents. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed.

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. 0.5:.

star_rating optional
string
"1:3"

Limit results by checking if star_rating or star_rating_u­nofficial of the place is within the given range. Maximum value is 5 and minimum 0. Possible representations of the range :3, 1:3, 1:

customer_rating optional
string
"1:7"

Limit results by customer_rating range. Maximum value is 10 and minimum 0. Possible representations of the range :3, 1:3, 1:

limit optional
int 1…1024
200

Limit the number of returned results. Default value is 10, max value is 1024. With map_spread the value must be divisible by 4map_spread e.g. 4<sup>2</sup>.

offset optional
int 0…10000
512

Specify offset. Default value is 0, max value is 10000.

location optional
string
"48.858,2.294"

Location parameter boosts up places within the 300km radius area around given GPS coordinates. Format is {latitude},{longitude}.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { places: [ { 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.

rating: 9.555 float

Popularity rating of the place in range <0-10>. Higher rating means higher popularity.

rating_local: 1.123456 float

Experimental

quadkey: "120212302033313333" string

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 }|null

See section Geographical attributes.

name: "Eiffel Tower" string name_suffix: "Paris, France" string|null original_name: "Tour Eiffel" string|null 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|null

Beginning of place description, up to 160 characters.

url: "https://travel.sygic.com/go/poi:530" string|null

URL of place overview on Sygic Travel. Custom Places do not have an url.

thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null

Image of place in dimensions 150×150 pixels.

marker: "sightseeing:tower:lookout" string

Name of the suggested marker icon. Each part after ‚:‘ character makes it more specific. You can use only prefix of the name with more common icon. Default value is default.

parent_ids: [ "city:14" string 0…∞ ]

Array of IDs of parent places.

star_rating: float|null

Rating in stars from 0 to 5.

star_rating_unofficial: float|null

Star rating which is not officially confirmed.

customer_rating: float|null

The customer rating on scale from 0 to 10 (the higher the better).

duration: 3600 int|null

Expected duration of visit in seconds.

}
0…∞
]
}
}
#

This endpoint returns complete information about places. The response includes also basic information from /places/list endpoint.

Parameters

name type example description
ids
string
"poi:530|poi:531"

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { places: [ { area: 4110308670 int|null

Area of the place in square meters.

is_deleted: false bool

Some place can be no longer available for various reasons. The API still returns such a place when it is requested by id.

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: enum["wikipedia", "booking.com", null] translation_provider: enum["bing", "google", null] link: string|null

Link contains an URL of the source. It is recommended to use it for attribution together with the provider.

}
|null
address: "Purkyňova 649/127" string|null admission: "Adults: €11" string|null email: "email@example.com" string|null opening_hours: "Open daily: Mid-June - early Sep: 9 a.m. - 12:45" string|null opening_hours_raw: "Mo-Fr 08:00-12:00,13:00-17:30; Sa 08:00-12:00; PH 09:00-12:00" string|null phone: "+33 892 70 12 39" string|null media_count: 15 int 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} has to be relpaced i.e. by 400x300. For full description of size see media endpoint description.

url: "https://media-cdn.sygictraveldata.com/media/612664395a40232133447d33247d383235343637373932.jpg" string

Path to original.

?original: { size: 1017931 int|null

Size of original media file

width: 1024 int|null

Width of original media

height: 768 int|null

Height 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
collection_count: 5 int

Number of collections for place in given language (collections that have the place as parent).

references: [ { id: 123 int

Reference ID.

title: "Official website" string

Reference title that can be displayed in UI.

type: "link:official" string

Reference type. For a full list of reference types see References sheet.

language_id: "en" string|null

Reference language for references that exist in language-specific variants. Others have null.

url: "http://www.tour-eiffel.com/" string

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 int

Can be used for simple ordering (the higher value the higher priority).

currency: "EUR" string|null

Currency of reference price.

price: 99.9 float|null

Linked product price.

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" string

Id 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
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.

rating: 9.555 float

Popularity rating of the place in range <0-10>. Higher rating means higher popularity.

rating_local: 1.123456 float

Experimental

quadkey: "120212302033313333" string

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 }|null

See section Geographical attributes.

name: "Eiffel Tower" string name_suffix: "Paris, France" string|null original_name: "Tour Eiffel" string|null 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|null

Beginning of place description, up to 160 characters.

url: "https://travel.sygic.com/go/poi:530" string|null

URL of place overview on Sygic Travel. Custom Places do not have an url.

thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null

Image of place in dimensions 150×150 pixels.

marker: "sightseeing:tower:lookout" string

Name of the suggested marker icon. Each part after ‚:‘ character makes it more specific. You can use only prefix of the name with more common icon. Default value is default.

parent_ids: [ "city:14" string 0…∞ ]

Array of IDs of parent places.

star_rating: float|null

Rating in stars from 0 to 5.

star_rating_unofficial: float|null

Star rating which is not officially confirmed.

customer_rating: float|null

The customer rating on scale from 0 to 10 (the higher the better).

duration: 3600 int|null

Expected duration of visit in seconds.

}
0…∞
]
}
}
#

This endpoint returns complete information about place. The response includes also basic information from /places/list endpoint.

Parameters

name type example description
id inlined in path
string
"poi:530"

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { place: { area: 4110308670 int|null

Area of the place in square meters.

is_deleted: false bool

Some place can be no longer available for various reasons. The API still returns such a place when it is requested by id.

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: enum["wikipedia", "booking.com", null] translation_provider: enum["bing", "google", null] link: string|null

Link contains an URL of the source. It is recommended to use it for attribution together with the provider.

}
|null
address: "Purkyňova 649/127" string|null admission: "Adults: €11" string|null email: "email@example.com" string|null opening_hours: "Open daily: Mid-June - early Sep: 9 a.m. - 12:45" string|null opening_hours_raw: "Mo-Fr 08:00-12:00,13:00-17:30; Sa 08:00-12:00; PH 09:00-12:00" string|null phone: "+33 892 70 12 39" string|null media_count: 15 int 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} has to be relpaced i.e. by 400x300. For full description of size see media endpoint description.

url: "https://media-cdn.sygictraveldata.com/media/612664395a40232133447d33247d383235343637373932.jpg" string

Path to original.

?original: { size: 1017931 int|null

Size of original media file

width: 1024 int|null

Width of original media

height: 768 int|null

Height 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
collection_count: 5 int

Number of collections for place in given language (collections that have the place as parent).

references: [ { id: 123 int

Reference ID.

title: "Official website" string

Reference title that can be displayed in UI.

type: "link:official" string

Reference type. For a full list of reference types see References sheet.

language_id: "en" string|null

Reference language for references that exist in language-specific variants. Others have null.

url: "http://www.tour-eiffel.com/" string

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 int

Can be used for simple ordering (the higher value the higher priority).

currency: "EUR" string|null

Currency of reference price.

price: 99.9 float|null

Linked product price.

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" string

Id 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
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.

rating: 9.555 float

Popularity rating of the place in range <0-10>. Higher rating means higher popularity.

rating_local: 1.123456 float

Experimental

quadkey: "120212302033313333" string

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 }|null

See section Geographical attributes.

name: "Eiffel Tower" string name_suffix: "Paris, France" string|null original_name: "Tour Eiffel" string|null 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|null

Beginning of place description, up to 160 characters.

url: "https://travel.sygic.com/go/poi:530" string|null

URL of place overview on Sygic Travel. Custom Places do not have an url.

thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null

Image of place in dimensions 150×150 pixels.

marker: "sightseeing:tower:lookout" string

Name of the suggested marker icon. Each part after ‚:‘ character makes it more specific. You can use only prefix of the name with more common icon. Default value is default.

parent_ids: [ "city:14" string 0…∞ ]

Array of IDs of parent places.

star_rating: float|null

Rating in stars from 0 to 5.

star_rating_unofficial: float|null

Star rating which is not officially confirmed.

customer_rating: float|null

The customer rating on scale from 0 to 10 (the higher the better).

duration: 3600 int|null

Expected duration of visit in seconds.

}
}
}
#

Parameters

name type example description
id inlined in path
string

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { geometry: null|any

Null or valid GeoJSON format

is_shape: bool

Describes if geometry is only a point or a geometry with a shape.

}
}
#

Parameters

name type example description
from
date (YYYY-MM-DD)
"2018-12-01"
to
date (YYYY-MM-DD)
"2018-12-05"

Result includes this day.

id inlined in path
string
"poi:530"

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { opening_hours: { \d{4}-\d{2}-\d{2}: [ { opening: string(~\d{2}:\d{2}:\d{2}~)

In h:m:s format.

closing: string(~\d{2}:\d{2}:\d{2}~)

In h:m:s format.

note: null|string
}
0…∞
]
}
is_valid: true bool
}
}
#

This endpoint returns statistics of tag and category counts for places filtered by given parameters.

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. It is possible to pass multiple tags. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed. See section Place levels.

categories optional
string
"sightseeing|restaurant"

Limit results by categories. It is possible to pass multiple categories. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed. See section Place categories.

categories_not optional
string
"sightseeing|restaurant"

Limit results by excluding categories. It is possible to pass multiple categories. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed. See section Place categories.

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 | (logical OR). All map tiles have to be same length. Using multiple map_tiles with map_spread will also change behaviour of limit parameter, so that limit is applied per each tile.

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 {south},{west},{north},{east}. The units are in degrees of latitude/longi­tude."

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.

tags optional
string
"Restaurant|Bar"

Limit results by tags. It is possible to pass multiple tags. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed.

tags_not optional
string
"Restaurant|Bar"

Limit results by excluding tags. It is possible to pass multiple tags. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed.

parents optional
string
"city:14"

Limit results by ID of parent place. It is possible to pass multiple parents. Separators have to be url-encoded, allowed options are: | is logical OR, separator , is logical AND. AND and OR logic cannot be mixed.

star_rating optional
string
"1:3"

Limit results by checking if star_rating or star_rating_u­nofficial of the place is within the given range. Range of accepted values. Possible representations of the range :3, 1:3, 1:

customer_rating optional
string
"1:7"

Limit results by customer_rating range. Maximum value is 10 and minimum 0. Possible representations of the range :3, 1:3, 1:

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { stats: { categories: [ { key: "sightseeing" string name: "Attrazioni" string count: 4568 int } 0…∞ ] tags: [ { key: "Restaurant" string name: "Ristorante" string count: 1359 int } 0…∞ ] } } }
#

Detect parents of given GPS coordinates. The parents are ordered by area size.

Parameters

name type example description
location
string
"49.1943639,16.5994451"

Define GPS coordinates for parent detection. GPS coordinates are defined by string composed of two floats in format {latitude},{longitude}. The units are in degrees of latitude/longitude.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { places: [ { 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.

rating: 9.555 float

Popularity rating of the place in range <0-10>. Higher rating means higher popularity.

rating_local: 1.123456 float

Experimental

quadkey: "120212302033313333" string

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 }|null

See section Geographical attributes.

name: "Eiffel Tower" string name_suffix: "Paris, France" string|null original_name: "Tour Eiffel" string|null 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|null

Beginning of place description, up to 160 characters.

url: "https://travel.sygic.com/go/poi:530" string|null

URL of place overview on Sygic Travel. Custom Places do not have an url.

thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null

Image of place in dimensions 150×150 pixels.

marker: "sightseeing:tower:lookout" string

Name of the suggested marker icon. Each part after ‚:‘ character makes it more specific. You can use only prefix of the name with more common icon. Default value is default.

parent_ids: [ "city:14" string 0…∞ ]

Array of IDs of parent places.

star_rating: float|null

Rating in stars from 0 to 5.

star_rating_unofficial: float|null

Star rating which is not officially confirmed.

customer_rating: float|null

The customer rating on scale from 0 to 10 (the higher the better).

duration: 3600 int|null

Expected duration of visit in seconds.

}
0…∞
]
}
}
#

Detect place that covers enough of the area and his parents in area. The parents are selected and ordered by the coverage of the area.

Parameters

name type example description
bounds optional
string
"49.08825778,11.27197265,50.67383524,21.46728515"

Define area for parent detection by bounds. Bounds are defined by string composed of four floats in format {south},{west},{north},{east}. The units are in degrees of latitude/longi­tude."

map_tile_bounds optional
string
"12021230,12021131"

Define area for parent detection 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.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { places: [ { 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.

rating: 9.555 float

Popularity rating of the place in range <0-10>. Higher rating means higher popularity.

rating_local: 1.123456 float

Experimental

quadkey: "120212302033313333" string

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 }|null

See section Geographical attributes.

name: "Eiffel Tower" string name_suffix: "Paris, France" string|null original_name: "Tour Eiffel" string|null 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|null

Beginning of place description, up to 160 characters.

url: "https://travel.sygic.com/go/poi:530" string|null

URL of place overview on Sygic Travel. Custom Places do not have an url.

thumbnail_url: "https://media-cdn.sygictraveldata.com/media/poi:530" string|null

Image of place in dimensions 150×150 pixels.

marker: "sightseeing:tower:lookout" string

Name of the suggested marker icon. Each part after ‚:‘ character makes it more specific. You can use only prefix of the name with more common icon. Default value is default.

parent_ids: [ "city:14" string 0…∞ ]

Array of IDs of parent places.

star_rating: float|null

Rating in stars from 0 to 5.

star_rating_unofficial: float|null

Star rating which is not officially confirmed.

customer_rating: float|null

The customer rating on scale from 0 to 10 (the higher the better).

duration: 3600 int|null

Expected duration of visit in seconds.

}
0…∞
]
}
}

References #

#

Parameters

name type example description
ids
string
"903|2|32"

list of reference ids connected with |

date_from
date (YYYY-MM-DD)
"2018-11-01"
date_to
date (YYYY-MM-DD)
"2018-11-03"
persons
int 1…∞

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { availabilities: [ { id: int

Reference id.

is_available: bool price: null|float

null = unknown price

}
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:

#

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 top_sellers

sort_direction optional
enum["asc", "desc"]
"asc"

DESC is not supported for top_sellers sorting.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { tours: [ { id: "TE-E-Ticket" string supplier: "viator" string title: "TE-E-Ticket" string

Tour title.

perex: "See Paris from the sky..." string

Short tour description.

url: "https://www.getyourguide.com/paris-l16/paris-eiffel-tower-ticket-with-priority-access-t69655/?partner_id=J6QH2HY" string

Tour URL on provider's website including customizable affiliate ID.

rating: 4.0164 float

Tour rating from user reviews on scale from 0 (the worst) to 5 (the best).

review_count: 152 int

Count of user reviews.

photo_url: "https://cdn.getyourguide.com/img/tour_img-453833-[format_id].jpg" string

In 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).

price: 42 float

Final tour price in USD.

original_price: 50 float

Tour price in USD without any discounts.

duration: "3 hours and 30 minutes" string|null

Duration of the tour or activity as text.

duration_min: 7200 int|null

Minimum duration of the tour or activity in seconds.

duration_max: 21600 int|null

Maximum 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…∞
]
}
}
#

Query or bounds param 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 {south},{west},{north},{east}. The units are in degrees of latitude/longitude. This parameter is exclusive with parent_place_id"

parent_place_id optional
string
"city:11"

Limits results by parent place. This parameter is exclusive with bounds.

tags optional
string
"11,10"

Comma separated tag ids (logical AND)

from optional "2017-10-20T08:00:00+00:00"

Datetime in W3C format https://www.w3.org/…OTE-datetime

to optional "2017-10-22T23:00:00+00:00"

Datetime in W3C format https://www.w3.org/…OTE-datetime

duration optional
string
"3600:7200"

Duration range in seconds. Note: :7200 == 0:7200 and 3600: == 3600:43200.

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: defalult

sort_direction optional
enum["asc", "desc"]
"asc"

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { tours: [ { id: "TE-E-Ticket" string supplier: "viator" string title: "TE-E-Ticket" string

Tour title.

perex: "See Paris from the sky..." string

Short tour description.

url: "https://www.getyourguide.com/paris-l16/paris-eiffel-tower-ticket-with-priority-access-t69655/?partner_id=J6QH2HY" string

Tour URL on provider's website including customizable affiliate ID.

rating: 4.0164 float

Tour rating from user reviews on scale from 0 (the worst) to 5 (the best).

review_count: 152 int

Count of user reviews.

photo_url: "https://cdn.getyourguide.com/img/tour_img-453833-[format_id].jpg" string

In 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).

price: 42 float

Final tour price in USD.

original_price: 50 float

Tour price in USD without any discounts.

duration: "3 hours and 30 minutes" string|null

Duration of the tour or activity as text.

duration_min: 7200 int|null

Minimum duration of the tour or activity in seconds.

duration_max: 21600 int|null

Maximum 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 {south},{west},{north},{east}. The units are in degrees of latitude/longitude. This parameter is exclusive with destination_id"

parent_place_id optional
string
"city:11"

Limits results by parent place. This parameter is exclusive with bounds.

tags optional
string
"11,10"

Comma separated tag ids (logical AND)

from optional "2017-10-22T23:00:00+00:00"

Datetime in W3C format https://www.w3.org/…OTE-datetime

to optional "2017-10-22T23:00:00+00:00"

Datetime in W3C format https://www.w3.org/…OTE-datetime

duration optional
string
"3600:7200"

Duration range in seconds. Note: :7200 == 0:7200 and 3600: == 3600:43200.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { tag_stats: [ { id: 2 int name: "Sightseeing Tours" string count: 275 int } 0…∞ ] } }
#

This endpoint has been deprecated and will be removed in future API versions. Use /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

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { tours: [ { id: "TE-E-Ticket" string supplier: "viator" string title: "TE-E-Ticket" string

Tour title.

perex: "See Paris from the sky..." string

Short tour description.

url: "https://www.getyourguide.com/paris-l16/paris-eiffel-tower-ticket-with-priority-access-t69655/?partner_id=J6QH2HY" string

Tour URL on provider's website including customizable affiliate ID.

rating: 4.0164 float

Tour rating from user reviews on scale from 0 (the worst) to 5 (the best).

review_count: 152 int

Count of user reviews.

photo_url: "https://cdn.getyourguide.com/img/tour_img-453833-[format_id].jpg" string

In 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).

price: 42 float

Final tour price in USD.

original_price: 50 float

Tour price in USD without any discounts.

duration: "3 hours and 30 minutes" string|null

Duration of the tour or activity as text.

duration_min: 7200 int|null

Minimum duration of the tour or activity in seconds.

duration_max: 21600 int|null

Maximum 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 #

The 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 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 name and a short description (both available in English only).

Please note that trip templates are only available for selected destinations. See the Trip Templates Destinations for the list of destinations with at least one trip template.

#

Get full data about a trip itinerary using its ID.

Examples

  • Get data for one trip itinerary: https://api.sygictraveldata.com/1.1/en/trips/58db672c280b5

Parameters

name type example description
id inlined in path
string
"58db672c280b5"

Trip ID.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { trip: { id: "58db672c280b5" string owner_id: "58494e397c170" string name: "My Trip to Prague" string|null version: 20 int 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 bool

Trip 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 bool

The property is false if the trip is private or user is already joined or is trip owner.

}
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|null

Number of seconds from midnight.

duration: 3600 int|null

Time in seconds planned to spend visiting place.

note: "Don't forget to use promo code. 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|null

Number of seconds from midnight.

duration: 3600 int|null

Time 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 bool

User is subscribed to a trip when he is owner of the trip or one of the collaborators. The value is related to the user session of the api call.

destinations: [ "city:1" string 0…∞ ]

Experimental

}
}
}
#

Get a list of suggested trip itineraries for a specific city, region or country. The response contains only basic trip data. For full trip response with places data use the Trips API.

Example

  • Get trip templates for Prague: https://api.sygictraveldata.com/1.1/en/trips/templates?parent_place_id=city:5

Parameters

name type example description
parent_place_id
string
"city:1"

The endpoint returns an array of trip entities.

Body

{ status_code: 200 int server_timestamp: "2017-04-05T11:42:50+00:00" datetime (YYYY-mm-ddTHH:ii:ssZ) data: { trips: [ { id: "58db672c280b5" string owner_id: "58494e397c170" string name: "My Trip to Prague" string|null version: 20 int 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 bool

Trip 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 } 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…∞
]
}
}