API

Use Superstack’s wallet and trading APIs to access account balances, manage funds, and execute trades across a wide range of markets.

Superstack API provides programmatic access to your wallet assets and trading functionality on the Superstack platform. With this API, you can retrieve account balances, manage funds, and execute trades across supported markets.

Key Generation

To use the Superstack API, you must first generate an API key from your Superstack API Page. When creating an API key, you can:

  • Set Name: Provide a descriptive name for the API key to help identify it in your account.

  • Set Permissions: Choose which permissions to grant the API key.

  • IP Whitelisting: Optionally restrict API access to specific IP addresses for enhanced security.

After generating your API key, it will be displayed—this private key is highly sensitive. Never expose it to others or store it in insecure locations.

Note: Keep your API keys secure. Do not share them or expose them in public places.

Permissions

There are three types of permissions you can assign to an API key:

  • View (Read Only): Allows the API key to access account information and balances, but not to make any changes.

  • Trade: Grants the ability to place, modify, and cancel orders on your behalf.

  • Transfer: Permits the API key to initiate transfers of funds between accounts or to external addresses.

You can choose one or more of these permissions when creating an API key, depending on the level of access you require.

IP Whitelisting

You can optionally restrict API access to specific IP addresses for enhanced security. When creating an API key, you can specify a list of IP addresses that are allowed to use the API key. If no IP addresses are specified, the API key will be allowed to be used from any IP address. It is best practice to restrict API access to specific IP addresses.

Management

You can delete your API key from the Superstack API page at any time. After deleting the API key, it will no longer be valid and cannot be used to access the API.

Additionally, you can activate or deactivate your API key directly from this page as needed. This allows you to temporarily disable access without deleting the key.

SDK

Superstack provides a RESTful interface for the Superstack API. Users can use the RESTful interface to interact with the Superstack API.

Further, Superstack provides a Rust SDK for the Superstack API. Users can use this SDK to interact with the Superstack API in Rust projects: superstack-rust-sdk

Last updated