Preparation

Environment Requirements

Supported OS: Windows / macOS / Linux
Programming Language: Python 3.4 or later

Install Python

For the best support and to reduce compatibility issues, we recommend installing the latest version of Python. Versions earlier than Python 3.4 may not run properly. You may check your Python version or verify your installation by typing python3 -V in your terminal or command prompt.

Installing the Latest Version of Python

Visit the official Download page on the Python website
Select your operating system, download the installation package, and install as prompted

Install TradeUP OpenAPI Python SDK

Method 1: Using pip (Recommended)

In Terminal or cmd, enter the following command to install the OpenAPI Python SDK:

pip3 install tigeropen

For subsequent version upgrades, you can use:

pip3 install tigeropen --upgrade

Method 2: Github

The source code of the OpenAPI SDK project is also available on Github.

To install:

Clone the project into your local directory
Run setup.py in your directory directory using the following command:

python3 setup.py install

Install IDE

We recommend using PyCharm as your integrated development environment (IDE).

Developer Registration Information

In order to access OpenAPI, you will need to open and fund your TradeUP account, and then apply for OpenAPI permissions.

For detailed instructions for individual investors, see the Developer Registration Information

For detailed instructions for institutional investors, see the Developer Registration Information

RSA Keys

OpenAPI uses RSA encryption for authentication. The RSA bidirectional signature authentication mechanism is used to prevent interface requests from being maliciously tampered with. Users must save their private keys locally.

❗️
Please store your private key in a local and secure place to prevent unauthorized exposure or loss of personal information.
Your private key will not be stored on TradeUP’s server and will disappear automatically when the page is refreshed. If you fail to save your private key, it may be replaced by clicking the re-generate button.

⚠️
Attention:
The Python SDK private key format is different from that used by the Java SDK. The Python private key uses PKCS#1. Please ensure your private key is in the correct format.