> For the complete documentation index, see [llms.txt](https://docs.superstate.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.superstate.com/investors/api/api-keys.md).

# API Keys

Create and manage API keys to access your Superstate data programmatically.

API keys let you read your Superstate balances and transactions programmatically.

### Who can manage keys

| Role     | View keys | Create and revoke keys |
| -------- | :-------: | :--------------------: |
| Admin    |    Yes    |           Yes          |
| Operator |    Yes    |           No           |
| Viewer   |    Yes    |           No           |

### Create an API key

{% hint style="info" %}
Don't see the **Developer** tab? Contact Superstate to enable API access for your organization.
{% endhint %}

1. Sign in and go to **Settings** → **Developer**.
2. If prompted, click **Verify with 2FA**. Two-factor verification is required to create or revoke keys.
3. Click **Create API key** and fill in:

   | Field          | What to enter                                                                                                                                                                                                                                                                                                                                                                                                                          |
   | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | **Name**       | Something memorable, e.g. `Treasury reconciliation`                                                                                                                                                                                                                                                                                                                                                                                    |
   | **Permission** | <p><strong>Issuer Roles:</strong></p><p><strong>View Instrument:</strong> read your fund's transactions and shareholders</p><p><strong>Manage Instrument:</strong> create shareholders and record subscriptions and redemptions</p><p></p><p><strong>Investor Roles:</strong></p><p><strong>Read balances</strong>: query entity and subaccount balances<br><strong>Read transactions</strong>: list transactions and their status</p> |
   | **Scope**      | **All entities** in your organization, or a single entity                                                                                                                                                                                                                                                                                                                                                                              |
4. Click **Create API key**.
5. Copy the **API key** and **API secret**, then click **Done**.

{% hint style="danger" %}
The secret is shown **only once**. Store it in a secrets manager before clicking **Done**. If you lose it, revoke the key and create a new one.
{% endhint %}

Each key has one permission. To read both balances and transactions, create two keys.

### Manage your keys

The **Developer** tab lists every key you have access to, with its name, permission, and when it was last used. Use the search bar to find a key by name or key value, or filter the list by permission. Keys that have expired are marked **Expired**.

Open a key's **Actions** menu to:

* **Details**: view the key's name, permission, scope, and API key, plus who created it, when, its status (Active or Expired), and when it was last used. The secret is never shown again after creation.
* **Duplicate key**: open a new key form pre-filled with the same name (with "(copy)" added), permission, and scope. Duplicating creates a new key with a new secret; the original keeps working.
* **Revoke key**: permanently disable the key. It stops working immediately, and this cannot be undone.

> **Rotating a key?** Duplicate it, update your integration with the new key and secret, then revoke the old one.
