Sharing your API keys with third-party applications involves potential risks. The level of access is determined by the permissions you select when generating the key - for example, you may allow only read-only access (viewing account data) or grant additional permissions such as placing orders. We do not have official partnerships with any third-party apps, so we cannot guarantee their security or reliability. Please use caution and only share your API keys with apps you fully trust.
An API Key is a credential that enables information sharing and grants specific data access privileges, allowing you to fetch information or perform various actions. The API token generatable on our platform will give you access to instrument information, historical account information (such as all portfolio positions, paid-out dividends, etc.), and various others.
You can check applicable API documentation here, as well as the API Terms here.
How to Generate an API Key?
Before you can generate an API key, you must first accept a mandatory risk warning. This ensures you fully understand the risks of using third-party applications.
Once accepted, you can generate an API key from both web and mobile:
- Go to ‘Settings’ and open ‘API (Beta)’.
- Tap Generate API key and review the available permissions (e.g., account data, history, orders, portfolio).
- Fill out the New API Key form. You’ll be able to:
- Give your API key a name.
- Choose IP access restrictions
🤓 Tip
- Unrestricted (less secure): allows use from any IP address.
- Restrict access to trusted IPs (recommended): limits access only to the IPs or CIDR ranges you provide.
-
Submit the form to generate your keys. You will be presented with two credentials:
API Key (similar to before).
API Secret Key – this works like a password and will be shown only once after generation.
❗️ Important
The API Secret Key must be stored securely. If you lose it, you will need to generate a new key pair.
📄 Note
- API Keys may give access to sensitive information, so they should never be shared with unauthorized entities.
- API Key versions may differ between real and demo accounts.
- The API Secret Key is critical for authentication. Treat it with the same care as your account password.
- Currently, the Public API section is visible only for the General Invest Account and the Stock & Shares ISA Account.