Skip to main content
Market data needs no key. An API key is for acting as your account: placing and cancelling orders, reading your orders, fills, positions and balance, and GET /account.

Create a key

Any signed-in account can create keys. On a desktop, open the avatar menu and choose API keys.
1

Start a key

Click New key. An account can hold up to 5 active keys.
2

Pick the environment and permissions

The form starts on Test (practice) with Read only, which can’t trade. To trade, pick Live (real money) and both Read and Trade. A key with Trade alone can place orders but can’t list or look them up.
3

Set limits (optional)

Narrow the key with the fields in Limits on a key, then click Create key.
4

Copy the secret

“Copy it now — it won’t be shown again.” Store it like a password.
You get a notification titled API key created for every new key on your account. Revoke a key from the same page: Revoke, then Revoke now.

What a key can and can’t do

A key is tied to one account and carries the permissions you gave it when you made it. A key can never withdraw, transfer or change your account. Moving money out stays in the app, behind your own sign-in. If a key leaks, the worst it can do is trade within the limits you set.

Test and live keys

Until the practice book opens, start with a live key and small limits (see below).

Key format

The key id identifies the key in lists and logs. The secret is shown once, when you create the key — updown stores only a one-way fingerprint of it and can never show it again. If you lose it, revoke the key and make a new one.

Sending a key

Send it as a bearer token on every request that needs it:
Call GET /account first whenever you set up a new key: it confirms the key works and shows exactly what it is allowed to do.

Limits on a key

When you create a key you can narrow it further. Every limit is optional. A trade key starts at $20 per order** and **$500 per day unless you set other limits. An account can have up to 5 active keys. GET /account shows a key’s limits and, as daily_used_usd, how much of the day’s limit is used: fills of the last 24 hours plus what rests right now, never a cancelled order. If you trade actively, set the daily limit well above your working capital; the limit is a brake on a leaked key, not a measure of activity.

When a key is refused

A refused key gets HTTP 401 with code UNAUTHORIZED and a message saying why: Repeated failed attempts from one address are locked out for a while and answer 429. Revoking a key takes effect within about 10 seconds.

Keeping keys safe

  • Keep keys in environment variables or a secrets manager — never in code, a repository, a chat or a screenshot.
  • Give each program its own key with only the permissions and limits it needs, so you can revoke one without stopping the others.
  • Use an IP allowlist for anything running on a fixed server.
  • If a key may have been seen by anyone else, revoke it straight away.