Skip to main content


Hyper API is available for Python, C++ and Java supporting Windows, Mac and Linux each. Depending on the language, the installation can be complex. This page contains the detailed requirements and installation instructions for all languages.


The Hyper API packages are released under the Apache 2.0 License. The exact license text can be found inside the packages, after unzipping. The documentation is licensed under the MIT License. The source code of the documentation can be found on GitHub.

Hardware requirements

The Hyper API only supports 64-bit platforms. It has the following minimum hardware requirements:

  • Intel Nehalem, Apple Silicon or AMD Bulldozer processor or newer
  • 2 GB memory
  • 1.5 GB minimum free disk space

Supported platforms

  • macOS 10.13 or newer (for Intel)
  • macOS 13.0 or newer (for Apple Silicon)
  • Microsoft Windows 8 or newer (64-bit)
  • Microsoft Windows Server 2016, 2012, 2012 R2, 2008 R2, 2019
  • Ubuntu 18.04 LTS, 20.04 LTS and 22.04 LTS
  • Amazon Linux 2, Red Hat Enterprise Linux (RHEL) 7.3+ and 8.3+, CentOS 7.9+, Oracle Linux 7.3+

Language-specific Requirements

  • Python 3.8 (or newer) is required.
    • Install the 64-bit version (for example, for Windows, the download is listed as Windows x86-64).
    • On Windows, we recommend to select the option Add Python 3.x to PATH during installation.



The following instructions assume that you have set up a virtual environment for Python. For more information on creating virtual environments, see venv - Creation of virtual environments in the Python Standard Library.

  1. Open a terminal and navigate to the venv directory.

  2. Install the tableauhyperapi module using pip.

    pip install tableauhyperapi

    If you previously installed the tableauhyperapi, you can upgrade to the latest version using the following command.

    pip install --upgrade tableauhyperapi

    Linux installations require pip version 19.3 or newer. Note that pip versions 20.0 and 20.1 are not working because of issues with pip.

    Alternatively, you can download the Python Hyper API wheel package (.whl file) for your operating system. Use pip to install the .whl file you downloaded.

    • On Windows: Scripts\pip install [*path_to_whl_file*]
    • On Linux/macOS: bin/pip install [*path_to_whl_file*]
  3. Try out the examples:

    • Download the samples from Github.
    • Run the Python examples (for example, try
      • On Windows: [venv_directory]\Scripts\python hyper-api-samples\Tableau-Supported\Python\
      • On Linux/macOS: [venv_directory]/bin/python hyper-api-samples/Tableau-Supported/Python/