> For the complete documentation index, see [llms.txt](https://docs.guestlogix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.guestlogix.io/traveler/api.md).

# Traveler API

## Documentation

The Traveler REST API utilizes Swagger to autogenerate the specification. It can be found [here](https://traveler.dev.guestlogix.io/v1/swagger/index.html). The conventions around naming, data types etc. can be found in the [API Convention](/glossary/api-convention.md#api-convention) page.

## Device Information

Any request made to the Traveler API must include device specific information. This required headers are outlined below.

| Header             | Type   | Example Value                          | Purpose                                                                                                                                                                                  |
| ------------------ | ------ | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x-device-id`      | String | `50565c00-6bba-4b7f-bfc2-593c50520e21` | A value representing a unique installation of the application on a user's device.                                                                                                        |
| `x-os-version`     | String | `iOS12.1`                              | The version of the operating system of the device making the request.                                                                                                                    |
| `x-language`       | String | `en`                                   | The [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) two letter language code of the user's device.                                                                    |
| `x-locale`         | String | `en-US`                                | The Locale as defined by [Apple guidelines](https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPInternational/LanguageandLocaleIDs/LanguageandLocaleIDs.html). |
| `x-region`         | String | `CA`                                   | The [ISO-3166](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) two character country code from which the requesting device is from.                                        |
| `x-application-id` | String | `com.guestlogix.traveler`              | The Unique identifier of the application that is using the SDK or API.                                                                                                                   |
| `x-timezone`       | String | `UTC`                                  | The [timezone abbreviation](https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations) that the device is displaying time in.                                                        |