Sygic Travel API
This API provides access to the Sygic Travel Places data.
Authentication
Each request must contain an authorization header x-api-key
. To
get the key please contact us.
Versioning
The latest API version is 1.0
. 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. While in beta, all versions are in the 0.x
format and versions are supported only for a short time period.
URL prefix
https://api.sygictravelapi.com/0.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
Media #
Media API provides photos and videos for Sygic Travel places together with detailed metadata, photo resizing and video previews.
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
and720p
as placeholder. A 1080p video may redirect to lower quality if 1080p not present.
Body
{size}
has to be relpaced i.e. by 400x300
. For full
description of size see 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…∞ ] } }Places #
Places API provides detailed information about Sygic Travel places as well as advanced search & filtering on whole places database.
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
,
island
, poi
Place categories
Each place can have multiple categories assigned describing different kinds
of visitor interest. Supported categories are:
discovering
, eating
, going_out
,
hiking
, playing
, relaxing
,
shopping
, sightseeing
, sleeping
,
doing_sports
, traveling
Place tags
Each place can have multiple tags which describe it or it’s properties. Tags can be used to filter places. See the list of available tags.
Geographical attributes
Places and certain other objects can have geographical attributes describing their location and area. Supported attributes are:
location
– Object withlat
(latitude) andlng
(longitude) in degrees.bounding_box
– Object withsouth
,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.
Examples
Please notice examples don't work in browser since the x-api-key
header is mandatory. You can use tools like Postman.
- Top twenty restaurants in London:
https://api.sygictravelapi.com/0.2/en/places/list?parents=city:1&categories=eating&limit=20
- Top ten restaurants in an area:
https://api.sygictravelapi.com/0.2/en/places/list?bounds=51.487744,-0.1879067,51.526849,-0.0464577&categories=eating
- Top ten pois an area:
https://api.sygictravelapi.com/0.2/en/places/list?bounds=51.487744,-0.1879067,51.526849,-0.0464577&levels=poi
- Fulltext query search in an area:
https://api.sygictravelapi.com/0.2/en/places/list?query=Tower&bounds=51.487744,-0.1879067,51.526849,-0.0464577
- Detailed information about the Eiffel Tower:
https://api.sygictravelapi.com/0.2/en/places/poi:530
- Eiffel Tower media:
https://api.sygictravelapi.com/0.2/en/places/poi:530/media
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 tags. Separator
|
categories | optional |
string
|
"sightseeing|restaurant" |
Limit results by categories. It is possible to pass multiple categories.
Separator |
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 |
Divide area to multiple subtiles to return places evenly spread on map.
Possible values are |
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 |
tags | optional |
string
|
"Restaurant|Bar" |
Limit results by tags. It is possible to pass multiple tags. Separator
|
parents | optional |
string
|
"city:14" |
Limit results by ID of parent place. It is possible to pass multiple parents.
Separator |
limit | optional |
int
|
200 |
Limit the number of returned results. Default value is 10, max value is
512. With |
Body
See section Place levels.
categories: [ "sightseeing" string 0…∞ ]See section Place categories.
rating: 9.555 floatPopularity rating of the place in range <0-10>
. Higher
rating means higher popularity.
Experimental
quadkey: "120212302033313333" stringSee 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" string name_suffix: "Paris, France" 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|nullBeginning of place description, up to 160 characters.
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|nullImage of place in dimensions 150×150 pixels.
marker: "sightseeing:tower:lookout" stringName 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
.
Approximate minimal price for places where fees are applicable. For hotels this represents price per person per night.
savings: 12.345 floatRepresents how much value
is cheaper compared to standard price
when discount is active.
Array of IDs of parent places.
duration: 3600 int|nullExpected 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:530" |
Body
See section Place levels.
categories: [ "sightseeing" string 0…∞ ]See section Place categories.
rating: 9.555 floatPopularity rating of the place in range <0-10>
. Higher
rating means higher popularity.
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" string name_suffix: "Paris, France" string|null is_deleted: false boolSome place can be no longer available for various reasons. The API still returns such a place when it is requested by id.
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.
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|nullImage of place in dimensions 150×150 pixels.
marker: "sightseeing:tower:lookout" stringName 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
.
Approximate minimal price for places where fees are applicable. For hotels this represents price per person per night.
savings: 12.345 floatRepresents how much value
is cheaper compared to standard price
when discount is active.
Array of IDs of parent places.
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: string|nullDescription has to be attributed. Display provider whenever you display description and provider is specified.
link: string|nullLink contains an URL of the source. It is recommended to use it for attribution together with the provider.
translation_provider: string|nullDescription translation has to be attributed. Display translation provider whenever you display description and translation_provider is specified.
}|null address: "Purkyňova 649/127" string|null admission: "Adults: €11" string|null duration: 3600 int|nullExpected duration of visit in seconds.
email: "email@example.com" string|null opening_hours: "Open daily: Mid-June - early Sep: 9 a.m. - 12:45" string|null phone: "+33 892 70 12 39" string|null 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.
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 references: [ { id: 123 int title: "Official website" string type: "link:official" string language_id: "en" string|null url: "http://www.tour-eiffel.com/" string supplier: "Wikipedia" string|null priority: 0 intUse for ordering (the higher value the higher priority).
currency: "EUR" string|null price: 99.9 float|null flags: [ "top_seller" string 0…∞ ] } 0…∞ ] } 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
See section Place levels.
categories: [ "sightseeing" string 0…∞ ]See section Place categories.
rating: 9.555 floatPopularity rating of the place in range <0-10>
. Higher
rating means higher popularity.
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" string name_suffix: "Paris, France" string|null is_deleted: false boolSome place can be no longer available for various reasons. The API still returns such a place when it is requested by id.
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.
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|nullImage of place in dimensions 150×150 pixels.
marker: "sightseeing:tower:lookout" stringName 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
.
Approximate minimal price for places where fees are applicable. For hotels this represents price per person per night.
savings: 12.345 floatRepresents how much value
is cheaper compared to standard price
when discount is active.
Array of IDs of parent places.
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: string|nullDescription has to be attributed. Display provider whenever you display description and provider is specified.
link: string|nullLink contains an URL of the source. It is recommended to use it for attribution together with the provider.
translation_provider: string|nullDescription translation has to be attributed. Display translation provider whenever you display description and translation_provider is specified.
}|null address: "Purkyňova 649/127" string|null admission: "Adults: €11" string|null duration: 3600 int|nullExpected duration of visit in seconds.
email: "email@example.com" string|null opening_hours: "Open daily: Mid-June - early Sep: 9 a.m. - 12:45" string|null phone: "+33 892 70 12 39" string|null 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.
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 references: [ { id: 123 int title: "Official website" string type: "link:official" string language_id: "en" string|null url: "http://www.tour-eiffel.com/" string supplier: "Wikipedia" string|null priority: 0 intUse for ordering (the higher value the higher priority).
currency: "EUR" string|null price: 99.9 float|null flags: [ "top_seller" string 0…∞ ] } 0…∞ ] } } }Parameters
name | type | example | description | |
---|---|---|---|---|
id | inlined in path |
string
|
Body
Null or valid GeoJSON format
is_shape: boolDescribes if geometry is only a point or a geometry with a shape.
} }Parameters
name | type | example | description | |
---|---|---|---|---|
from |
date (YYYY-MM-DD)
|
|||
to |
date (YYYY-MM-DD)
|
Result includes this day. |
||
id | inlined in path |
string
|
Body
In h:m:s format.
closing: string(~\d{2}:\d{2}:\d{2}~)In h:m:s format.
note: null|string } 0…∞ ] } } }Tours #
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
translated text about the length of the tour
} 0…∞ ] } }