Skip to content
ScryaHelp Centre

Verifying with OKX

To verify a balance you hold on OKX, you create an API key with only the Read permission and paste it into Scrya. An API key is a set of codes that lets an app look at your account without your password. OKX keys have three parts: an API key, a secret key and a passphrase you choose. No funds move.

What permission to choose

Tick Read and nothing else. Scrya only reads your account balances, so that’s all it needs.

Never tick Trade or Withdraw for Scrya, or any other permission OKX offers, such as Transfer. Scrya doesn’t need them. Keeping the key read-only is up to you, so check it before you paste it in.

Choosing your passphrase

OKX asks you to set a passphrase when you create the key. It’s a password for this key only, not your OKX login password. Scrya needs it too.

  • Write it down. OKX can’t show it again or recover it. If you lose it, delete the key and create a new one.
  • Type it exactly. It’s case-sensitive.
  • Keep it Scrya-friendly. Scrya accepts passphrases of 4 to 128 characters that don’t include any of these: < > ' " & ;

Which balances Scrya counts

  • Trading and Funding accounts. Scrya reads both and adds them together, including amounts locked in open orders. It doesn’t read other OKX products, such as Earn.
  • One account. Scrya reads only the account the key was created on. If the asset is in a sub-account, create the key under that sub-account.

US, Australian and European accounts

OKX runs separate sites by region: app.okx.com for the US and Australia, my.okx.com for the European Economic Area, and okx.com for everywhere else. A key only works on the site you created it on.

You don’t need to tell Scrya which site you use. Just create the key on the site you normally sign in to.

Create the key on OKX

  1. Sign in to OKX on the web, on the site you normally use: okx.com, app.okx.com (US and Australia) or my.okx.com (European Economic Area).
  2. Open your profile menu and select API (on some OKX sites it’s API and connections).
  3. Click Create API key.
  4. Give the key a name you’ll recognise, such as “Scrya read-only”.
  5. Set a passphrase. See Choosing your passphrase.
  6. Under permissions, tick Read only.
  7. Leave the IP address field empty.
  8. Complete OKX’s security verification.
  9. Copy the API key and Secret key, and keep your passphrase handy.

Add the key in Scrya

  1. Open your verification request and click Start Verification next to the asset.
  2. Choose Centralised exchange, then OKX.
  3. Paste OKX’s API key into API Key and its Secret key into API Secret.
  4. Type your passphrase into Passphrase.
  5. Click Connect exchange.

Scrya encrypts all three values before storing them, then checks your balance straight away. When the check succeeds you’ll see Verified and your Verified balance. Click Close.

Verified with OKX before? Scrya may offer a saved key under Use a saved API key or add a new one. Choose it and click Reuse and verify. You won’t need to enter the passphrase again.

Should I restrict the key to an IP address?

No. Leave the IP address field empty. Scrya’s checks don’t come from one fixed address, so there’s nothing you could add. If the key only works from certain addresses, OKX refuses Scrya’s check, and Scrya asks you to remove the restriction or create a new key without one.

Troubleshooting

  • Invalid credentials: a value looks too short or too long, or contains characters Scrya can’t accept. If it’s the passphrase, it must be 4 to 128 characters with none of < > ' " & ;. If your OKX passphrase uses one of those, create a new key with a different passphrase.
  • Couldn’t connect to OKX: OKX refused the key. Check you copied the key and secret in full, typed the passphrase exactly (it’s case-sensitive), and ticked Read.
  • OKX doesn’t recognise this API key: none of OKX’s regional sites knows this key. Check you copied the whole API key and that the key hasn’t been deleted. If it has, create a new one.
  • This API key only accepts requests from certain IP addresses: remove the IP restriction from the key on OKX, or create a new key with the IP address field left empty.
  • Balance lower than expected: the asset may be in Earn or in a sub-account. See Which balances Scrya counts.
  • Something went wrong on our side: this one’s on us. Note the reference (ERR-XXXX-XXXX) and see Error references.

More help: Troubleshooting.

Revoke the key

Once your verification shows Verified, you can delete the key. Go back to the API page in your OKX profile, find the key you named for Scrya and delete it.

After that, Scrya can’t reuse the key, so you’d create a new one for a future request. Scrya deletes its own encrypted copy, including your passphrase, 30 days after your verification completes. See Revoking your API key.