How to Create a Read-Only API Key on OKX
Follow these steps to create a read-only API key to connect your OKX account to Flicker:
Prerequisites
- An active OKX account
- Completed email verification and 2FA setup
- Identity verification completed
Step-by-Step Instructions
-
Access API Management
- Log in to your OKX account
- Click on your profile icon in the top-right corner
- Select "API" from the dropdown menu
-
Select Account Type
- Choose the account you want to create API keys for:
- Trading Account (most common for Flicker)
- Funding Account
- Click "Create API Keys"
- Choose the account you want to create API keys for:
-
Create New API Key
- Enter a descriptive name for your API key (e.g., "Flicker Read-Only")
- Click "Next"
-
Set API Permissions (Important)
- Enable only "Read" permission
- This allows Flicker to view:
- Account balances
- Transaction history
- Open positions
- Trade history
- Do NOT enable:
- Trade
- Withdraw
- Transfer
-
Create a Passphrase
- Enter a strong passphrase for your API key
- Remember this passphrase - you'll need it when connecting to Flicker
- Important: The passphrase cannot be retrieved if forgotten
- Confirm the passphrase
-
Configure IP Restrictions (Optional but Recommended)
- For enhanced security, add trusted IP addresses
- Add Flicker's IP address:
34.175.102.17 - Alternatively, you can select "No restriction" for read-only API keys
- Note: API keys with read-only permissions or IP restrictions will not expire
- API keys with trading permissions will expire after 14 days of inactivity if not IP-restricted
-
Complete Security Verification
- Enter the verification code from your email
- Complete 2FA verification (authenticator app or SMS)
- Click "Confirm"
-
Save Your Credentials
- Immediately save:
- API Key
- Secret Key
- Passphrase
- Important: The Secret Key is shown only once and cannot be retrieved later
- Store them securely in a password manager
- Immediately save:
-
Connect to Flicker
- Use the saved API Key, Secret Key, and Passphrase to connect your OKX account to Flicker
Security Best Practices
- ✅ Only enable "Read" permission for account monitoring
- ✅ Use a strong, unique passphrase
- ✅ Store your credentials securely (password manager recommended)
- ✅ Consider binding your API key to specific IP addresses
- ✅ Regularly review your active API keys in API Management
- ❌ Never enable trading or withdrawal permissions for third-party integrations
- ❌ Never share your API credentials or passphrase with anyone
Important Notes
- Read-only API keys with no trading or withdrawal permissions are safe for third-party integrations
- API keys with only read permissions will not expire (unlike trading API keys)
- You can create multiple API keys for different purposes
- You can delete or modify API keys at any time from the API Management page
- Each API key can be individually managed and revoked
Troubleshooting
- Forgot your passphrase? You'll need to delete the API key and create a new one
- API key not working? Check if IP restrictions are preventing access
- Need to change permissions? You must create a new API key with different permissions
Need Help?
If you encounter any issues, please visit: