---
title: Using the RealEye API
description: Learn how to use the RealEye API to create studies, add participants, and get results with simple HTTP requests.
---

[Skip to content](https://support.realeye.io/realeye-api#main-content)

[![logotype](https://support.realeye.io/hs-fs/hubfs/logotype.png?width=140&height=57&name=logotype.png)](https://support.realeye.io/?hsLang=en)

Open main navigation

Close main navigation

- [Contact us](mailto:contact@realeye.io)

[Contact us](mailto:contact@realeye.io)

 How can we help you?

- There are no suggestions because the search field is empty.

1. [RealEye Knowledge Base](https://support.realeye.io/?hsLang=en)
2. [Advanced Features & Integrations](https://support.realeye.io/advanced-features-integrations?hsLang=en)

# Using the RealEye API

## Learn how to use the RealEye API to create studies, add participants, and get results with simple HTTP requests.

---

**The RealEye API is accessed via the HTTP protocol secured by TLS v2 (HTTPS)**. It requires a license that includes API access - see available license types on our [Pricing page](https://www.realeye.io/pricing).

There are two versions of the RealEye API:

- **API v2.6** – to create and manage studies ([API v2.6 documentation](https://app.swaggerhub.com/apis/realeyeio/platform/2.6.0))
- **API v1** – to download study results ([API v1 documentation](https://www.realeye.io/docs/api))

![line\_RealEye\_long](https://support.realeye.io/hs-fs/hubfs/line_RealEye_long.png?width=670&height=1&name=line_RealEye_long.png)

### Authentication

All API requests must include a private access token.

**How to Get Your API Token:**

- You need a License with the API module.
- Contact RealEye support to receive your personal API token.

Include your token in every request using this format:

`X-AUTH-TOKEN: YOUR_API_TOKEN`

**❗Keep your token secure. Do not share it or expose it publicly.**

 

---

💌 If you have any questions or need further assistance, feel free to reach out to our team at **support@realeye.io.**

- [Getting started](https://support.realeye.io/getting-started?hsLang=en)
- [(Webcam) Eye-Tracking Basics](https://support.realeye.io/webcam-eye-tracking-basics?hsLang=en#main-content)

    - [RealEye accuracy](https://support.realeye.io/webcam-eye-tracking-basics?hsLang=en#realeye-accuracy)
- [Licenses & Pricing](https://support.realeye.io/licenses-pricing?hsLang=en)
- [Account Settings](https://support.realeye.io/account-settings?hsLang=en)
- [Study Setup & Settings](https://support.realeye.io/study-setup-settings?hsLang=en#main-content)

    - [Study Types](https://support.realeye.io/study-setup-settings?hsLang=en#study-types)
- [Content Setup & Stimuli (Items) Settings](https://support.realeye.io/content-setup-stimuli-items-settings?hsLang=en)
- [Managing Participants](https://support.realeye.io/managing-participants?hsLang=en)
- [Analyzing Study Results](https://support.realeye.io/analyzing-study-results?hsLang=en)
- [Advanced Features & Integrations](https://support.realeye.io/advanced-features-integrations?hsLang=en)
- [Security & Privacy](https://support.realeye.io/security-privacy?hsLang=en)
- [Troubleshooting](https://support.realeye.io/troubleshooting?hsLang=en)
- [Ghost articles](https://support.realeye.io/ghost-articles?hsLang=en)

[![logotype](https://support.realeye.io/hs-fs/hubfs/logotype.png?width=140&height=57&name=logotype.png "logotype")](http://realeye.io)

RealEye sp. z o. o.  
Obornicka 330  
60-689 Poznań  
Tax: PL9721299175

<https://www.facebook.com/> [mailto:support@realeye.io](mailto:support@realeye.io)

Copyright © 2024, RealEye sp. z o. o.