|
| 1 | +# API Keys & Secrets |
| 2 | + |
| 3 | +rotki premium uses API Keys and Secrets to connect your subscription to the rotki application. This guide explains how to create, manage, and secure your API credentials. |
| 4 | + |
| 5 | +## What are rotki Premium API Keys? |
| 6 | + |
| 7 | +API Keys and Secrets are authentication credentials that: |
| 8 | + |
| 9 | +- Link your rotki app to your premium subscription |
| 10 | +- Enable premium features in the application |
| 11 | +- Allow cloud backup and sync across devices |
| 12 | +- Identify your account for device limit management |
| 13 | + |
| 14 | +## Creating API Keys |
| 15 | + |
| 16 | +### First-Time Creation |
| 17 | + |
| 18 | +After purchasing a subscription, you need to manually generate your API credentials: |
| 19 | + |
| 20 | +1. Go to your [subscription page](https://rotki.com/home/subscription) |
| 21 | +2. Navigate to the **API Keys** section |
| 22 | +3. Click the **Create** button |
| 23 | +4. Your credentials will be generated and displayed: |
| 24 | + - **API Key** - Your public identifier |
| 25 | + - **API Secret** - Your private authentication token |
| 26 | +5. You can view both credentials anytime from your subscription page |
| 27 | + |
| 28 | +::: info Manual Generation Required |
| 29 | +API Keys and Secrets are not automatically created after payment. You must click the button to generate them for the first time. |
| 30 | +::: |
| 31 | + |
| 32 | +### Where to Find Existing Keys |
| 33 | + |
| 34 | +You can view both your API Key and Secret anytime: |
| 35 | + |
| 36 | +1. Visit your [subscription page](https://rotki.com/home/subscription) |
| 37 | +2. Look in the API Keys section |
| 38 | +3. Both your API Key and Secret will be displayed |
| 39 | + |
| 40 | +## Using API Keys in the App |
| 41 | + |
| 42 | +After creating your API credentials, add them to rotki: |
| 43 | + |
| 44 | +1. Open the rotki application |
| 45 | +2. Navigate to **API Keys** → **rotki Premium** in the sidebar |
| 46 | +3. Enter your **API Key** |
| 47 | +4. Enter your **API Secret** |
| 48 | +5. Click **Save** |
| 49 | + |
| 50 | +For detailed app setup instructions, see the [API Keys Usage Guide](/usage-guides/api-keys#rotki-premium). |
| 51 | + |
| 52 | +## Managing API Keys |
| 53 | + |
| 54 | +### Viewing Your Keys |
| 55 | + |
| 56 | +From your [subscription page](https://rotki.com/home/subscription): |
| 57 | + |
| 58 | +- Both your API Key and Secret are always visible |
| 59 | +- You can copy them anytime you need |
| 60 | +- You can see when the key was created |
| 61 | + |
| 62 | +### Regenerating Keys |
| 63 | + |
| 64 | +If you need to create new credentials: |
| 65 | + |
| 66 | +1. Go to your [subscription page](https://rotki.com/home/subscription) |
| 67 | +2. Click the **Regenerate** button |
| 68 | +3. Your new API Key and Secret will be generated and displayed |
| 69 | +4. Update credentials on all your devices |
| 70 | + |
| 71 | +::: tip When to Regenerate |
| 72 | + |
| 73 | +- If you suspect your credentials have been compromised |
| 74 | +- If you want to revoke access from all devices |
| 75 | + ::: |
| 76 | + |
| 77 | +## Security Best Practices |
| 78 | + |
| 79 | +### Protecting Your Credentials |
| 80 | + |
| 81 | +::: danger Keep Your Secret Safe |
| 82 | + |
| 83 | +- **Never** share your API Secret with anyone |
| 84 | +- **Never** post it in public forums or Discord |
| 85 | +- **Never** commit it to version control (Git, etc.) |
| 86 | +- **Never** send it via unencrypted channels |
| 87 | + ::: |
| 88 | + |
| 89 | +### Storage Recommendations |
| 90 | + |
| 91 | +Store your API credentials securely: |
| 92 | + |
| 93 | +- Use a password manager (1Password, Bitwarden, KeePass, etc.) |
| 94 | +- Keep backups in a secure location |
| 95 | +- Don't save them in plain text files |
| 96 | +- Don't email them to yourself |
| 97 | + |
| 98 | +### If Credentials are Compromised |
| 99 | + |
| 100 | +If you believe your API credentials have been exposed: |
| 101 | + |
| 102 | +1. **Immediately** regenerate your API credentials from the [subscription page](https://rotki.com/home/subscription) by clicking **Regenerate** |
| 103 | +2. Update all your legitimate devices with the new credentials |
| 104 | +3. Monitor your account for unusual activity |
| 105 | + |
| 106 | +## API Keys and Device Limits |
| 107 | + |
| 108 | +Each premium tier has a device limit. When you add your API credentials to rotki: |
| 109 | + |
| 110 | +- The device is registered to your account |
| 111 | +- It counts toward your device limit |
| 112 | +- You can view and manage devices from the [devices page](/premium/devices) |
| 113 | + |
| 114 | +### Checking Device Usage |
| 115 | + |
| 116 | +From your [subscription page](https://rotki.com/home/subscription): |
| 117 | + |
| 118 | +- View current device count |
| 119 | +- See your tier's device limit |
| 120 | +- Access the [device list](https://rotki.com/home/devices) for details |
| 121 | + |
| 122 | +### Device Limit Exceeded |
| 123 | + |
| 124 | +If you reach your device limit: |
| 125 | + |
| 126 | +- New devices cannot authenticate |
| 127 | +- You'll see an error in the rotki app |
| 128 | +- Remove unused devices to free up slots |
| 129 | + |
| 130 | +See [Device Management](/premium/devices) for details on managing devices. |
| 131 | + |
| 132 | +## Troubleshooting |
| 133 | + |
| 134 | +### Invalid API Key/Secret Error |
| 135 | + |
| 136 | +If you see authentication errors: |
| 137 | + |
| 138 | +1. Verify you copied the credentials correctly (no extra spaces) |
| 139 | +2. Ensure your subscription is active (check [subscription page](https://rotki.com/home/subscription)) |
| 140 | +3. Verify your API credentials are still visible on the subscription page |
| 141 | +4. Try regenerating your credentials |
| 142 | + |
| 143 | +### Can't See My API Key/Secret |
| 144 | + |
| 145 | +If you can't see your credentials on the subscription page: |
| 146 | + |
| 147 | +1. Verify you're logged in to the correct rotki.com account |
| 148 | +2. Ensure you've already generated API credentials (if not, click the generate button) |
| 149 | +3. Refresh the page |
| 150 | +4. Contact [[email protected]](mailto:[email protected]) if the issue persists |
| 151 | + |
| 152 | +### Premium Features Not Working |
| 153 | + |
| 154 | +If premium features aren't activating: |
| 155 | + |
| 156 | +1. Verify API credentials are entered correctly in the app |
| 157 | +2. Check your subscription is active and not expired |
| 158 | +3. Ensure you haven't exceeded your device limit |
| 159 | +4. Try removing and re-adding the credentials |
| 160 | +5. Check the app logs for specific errors |
| 161 | + |
| 162 | +### Multiple Devices Not Syncing |
| 163 | + |
| 164 | +If sync isn't working across devices: |
| 165 | + |
| 166 | +1. Verify all devices use the same API credentials |
| 167 | +2. Ensure "Allow data sync with rotki Server" is enabled (see [Sync Guide](/usage-guides/#sync-data-with-rotki-server)) |
| 168 | +3. Check you haven't exceeded device limits |
| 169 | +4. Manually trigger sync from the toolbar |
0 commit comments