Network grid, worldwide
const url = 'https://api.wink.travel/api/public/network/grid/global';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"language":"en","page":0,"searchFilters":{"directOnly":true,"lifestyle":"LIFESTYLE_RELAX","nameSoundsLike":"The Siam Residences, Bangkok","radiusInMeters":2000,"starRating":5},"size":6,"sort":"RECOMMENDED"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.wink.travel/api/public/network/grid/global \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "language": "en", "page": 0, "searchFilters": { "directOnly": true, "lifestyle": "LIFESTYLE_RELAX", "nameSoundsLike": "The Siam Residences, Bangkok", "radiusInMeters": 2000, "starRating": 5 }, "size": 6, "sort": "RECOMMENDED" }'Returns a page of the best property of each country among those offered to the Wink Network, ordered by the requested sort; a default result set before any search term is entered. Each property carries priceBand, the Wink Network’s indicative band: the cheapest and dearest night (2 adults, one to three nights) the engine priced over seven consecutive check-in dates starting 21 days out, from the Network’s stored band, only for dates that were bookable then. It is absent when the Network has no band. Prices are indicative only.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Request Body
Section titled “Request Body”object
Language of the property descriptions returned, besides English which is always included. Omit for English only.
Example
enThe page to paginate to. Note: Page uses a 0-based index.
Example
0How the user likes to have results filtered. directOnly has no effect (the grid is the Wink Network’s) and neither does radiusInMeters (it only applies to a search around a point).
object
Show only properties with direct supplier relationships
Example
trueFilter properties by lifestyle category
Example
LIFESTYLE_RELAXCase-insensitive part of the property name. Narrows the results; it does not rank them.
Example
The Siam Residences, BangkokSearch radius in meters around the user’s location (0 = disabled)
Example
2000Minimum star rating for properties (0 = no filter)
Example
5Example
{ "directOnly": true, "lifestyle": "LIFESTYLE_RELAX", "nameSoundsLike": "The Siam Residences, Bangkok", "radiusInMeters": 2000, "starRating": 5}The result size to return.
Example
6Choose the criteria you want the results sorted on. Omit for RECOMMENDED.
Example
RECOMMENDEDExample
{ "language": "en", "page": 0, "searchFilters": { "directOnly": true, "lifestyle": "LIFESTYLE_RELAX", "nameSoundsLike": "The Siam Residences, Bangkok", "radiusInMeters": 2000, "starRating": 5 }, "size": 6, "sort": "RECOMMENDED"}Responses
Section titled “Responses”OK
Owned pagination envelope: a page of content plus flat page metadata.
object
The elements on this page.
object
Lightweight projection of a property aggregate, used for search results, listings, and map markers where not all property details are required.
object
Number of activites property has listed on its profile.
Number of add-ons property has on its profile.
Property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Aggregate score based on all current user reviews.
Supported OTA specification ARC code. See OTA geoname data
Number of attractions property has listed on its profile.
Whether property is available
Number of bookings for this property on the wink.travel platform.
Name of hotel brand
Name of hotel chain if applicable.
City location
object
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
Currency code for property.
Short and long welcome text
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
General manager of the property.
object
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Profile image of the general manager.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Name of GM currently managing the property.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Unique hotel record identifier.
Property images.
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Timestamp of the last update to this property aggregate record.
Hotel local name if different from the trade name or if it is the local language.
Geo-location
object
Supported OTA specification LOC code. See OTA geoname data
Number of meeting rooms property has on its profile.
Hotel trade name
Number of rooms / keys for this property.
Number of places property has listed on its profile.
Basic property policy record.
object
When the guest can check in, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
When the guest has to check out, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
Indicates whether property allows children
When a property allows children, it can also indicate what the minimum age is for children to be allowed.
Indicates the availability of internet on the property.
Indicates where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
Monetary amount value
ISO 4217 currency code
If pets are allowed, property can further limit on weight.
Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Contact details for reservations desk
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Number of restaurants property has on its profile.
Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.
Supported OTA specification SEG code. See OTA geoname data
Property’s social network accounts
Social network
object
URL or social network identifier to social network profile
Type of social network.
Number of spas property has on its profile.
Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Count of total reviews left by users at this property.
Event shorter name
Unique URL-friendly name slug of hotel
Property videos.
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Year the property was constructed.
object
Whether this is the first page.
Whether this is the last page.
Zero-based index of this page.
Number of elements on this page.
The requested page size.
Total number of elements across all pages.
Total number of pages for the current page size.
Example
{ "content": [ { "hotel": { "activities": 3, "addOns": 5, "address": { "city": "Bangkok", "countryCode": "TH", "line1": "3/2 Khao Road", "postalCode": "10300", "state": "Bangkok" }, "aggregateGreendexRating": 7, "aggregateReviewRating": 8.7, "architecturalStyle": "7", "attractions": 5, "available": true, "bookings": 6054, "brand": "The Siam Residences", "chain": "The Siam Collection", "currencyCode": "THB", "descriptions": [ { "description": "An elegant riverside sanctuary in the heart of Bangkok.", "language": "en", "title": "Luxury Riverside Retreat" } ], "hotelAmenityCodes": [ "1", "7" ], "hotelCategory": "45", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "images": [ { "entityId": "the-siam-residences/lobby-entrance", "identifier": "the-siam-residences/lobby-entrance", "sort": 10, "type": "IMAGE" } ], "lifestyleTypes": [ "LIFESTYLE_HEALTH_FITNESS" ], "localName": "เดอะสยาม เรสซิเดนซ์", "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "Point" }, "locationCategory": "34", "meetingRooms": 2, "name": "The Siam Residences, Bangkok", "numberOfRooms": 32, "places": 9, "propertyAccessibilityCodes": [ "1" ], "propertySecurityCodes": [ "7" ], "reservations": { "firstName": "Somchai", "lastName": "Phattanapong", "phone": "+66-2-123-4567" }, "restaurants": 2, "score": 70, "segmentCategory": "7", "socials": [ { "handle": "thesiamresidences", "platform": "INSTAGRAM" } ], "spas": 1, "starRating": 5, "thirdPartyReviews": [], "totalReviews": 989, "uniqueId": "siam-residences-bkk", "urlName": "the-siam-residences-bangkok-thailand", "videos": [], "whenBuilt": "1927" } } ], "first": true, "last": false, "number": 0, "numberOfElements": 20, "size": 20, "totalElements": 1234, "totalPages": 62}Bad Request — missing or invalid request parameter or body
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Unauthorized — authentication is required or the session has expired
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Forbidden — authenticated but lacking the required permission or scope
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Not Found — the requested resource does not exist
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Unsupported Media Type — use application/json
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Internal Server Error — an unexpected failure occurred on the server
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Service Unavailable — a downstream dependency is unreachable
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}