JARVIS
Sign in Open Account
Documentation · Onboarding

Exchange API setup.

Step-by-step walkthrough to provision a Jarvis-compatible API key on each supported venue. Trade and close permissions only — withdrawals are never required and must remain disabled.

Kraken · primary Binance OKX Bybit
Required permissions · same on every venue Jarvis needs to read account state and place / cancel orders. It must never have permission to withdraw funds, transfer between accounts, or modify account settings. The exchange enforces this at the API layer; even a compromised Jarvis instance cannot move your money off the exchange.
PermissionRequired?Reason
Query Funds / BalancesYESRead available margin and free collateral
Query Open & Closed OrdersYESReconcile fills against expected positions
Query Ledger Entries / TradesYESRealised PnL attribution
Create & Modify OrdersYESOpen and adjust positions
Cancel / Close PositionsYESClose-on-stop, time-stop, take-profit
Withdraw FundsNO — LEAVE OFFJarvis never moves money off your exchange
Transfer between accountsNO — LEAVE OFFSame as above
Modify account / API settingsNO — LEAVE OFFStrictly unnecessary

On this page

Kraken — primary venue, full walkthrough Binance — Spot Margin API OKX — Margin API (passphrase required) Bybit — Spot & Margin API

Kraken — primary venue

Kraken is Jarvis's primary execution venue. The eight major pairs trade at 10× effective leverage; BNB at 5×. Spot Margin is granted automatically at the Intermediate verification tier.

Official Kraken references:

STEP 01

Verify your account to Intermediate

Sign in at kraken.com, then go to Profile → Verification. You need at least the Intermediate tier for Spot Margin and API trading.

  • Government-issued photo ID (passport / driving licence)
  • Proof of address — utility bill or bank statement < 3 months old
  • Source-of-funds declaration (typical turnaround 1–3 business days)
STEP 02

Open the API management page

Once verified, navigate to Settings → API (top-right profile menu → Settings → API). Click Create API key.

kraken Trade · Earn · Funding · History · Settings acct ▾ Settings — API Manage API keys for programmatic access to your Kraken account. DESCRIPTION CREATED LAST USED ACTIONS No API keys yet. CREATE API KEY click here
Schematic — Kraken API management screen
STEP 03

Set the key description

Use a recognisable label so you can revoke it independently of any other key, e.g. Jarvis — live.

STEP 04

Tick exactly these permissions

This is the most important step. Tick only the boxes Jarvis needs — nothing more.

  • Funds Permissions: Query Funds   [✓]
  • Funds Permissions: Deposit Funds [   ] — leave OFF
  • Funds Permissions: Withdraw Funds [   ] — LEAVE OFF
  • Orders & Trades Permissions: Query Open Orders & Trades [✓]
  • Orders & Trades Permissions: Query Closed Orders & Trades [✓]
  • Orders & Trades Permissions: Modify Orders [✓]
  • Orders & Trades Permissions: Cancel & Close Orders [✓]
  • Orders & Trades Permissions: Create & Modify Orders [✓]
  • Ledger Permissions: Query Ledger Entries [✓]
  • WebSockets Interface: Access WebSockets API [✓] (recommended)
Create API key Tick only the permissions Jarvis needs. FUNDS PERMISSIONS Query Funds Deposit Funds LEAVE OFF Withdraw Funds LEAVE OFF — CRITICAL ORDERS & TRADES PERMISSIONS Query Open Orders & Trades Query Closed Orders & Trades Create & Modify Orders Cancel & Close Orders LEDGER & WEBSOCKETS Query Ledger Entries Access WebSockets API GENERATE KEY
Schematic — required permission checkbox state (Kraken UI)
STEP 05

(Optional but recommended) IP allow-list

If your venue supports it, paste Jarvis's outbound IP into the Key IP Address Restrictions field. Contact support for the current address. This adds a network-layer guarantee on top of the permission scopes.

STEP 06

Generate the key

Click Generate Key. Kraken will display two values:

  • API Key — a 56-character public identifier
  • Private Key — a long base64 secret. This is shown once. Copy it immediately.
Your new API key PRIVATE KEY IS SHOWN ONCE — COPY BOTH VALUES NOW API KEY aB3kPq7ZxV2nL9wT4cR1Ej6oD8mY5sF0iG3hN7uXv COPY PRIVATE KEY 7QmK4LpZ8...base64...nT9wYxV2cRfH== COPY
Schematic — key reveal screen
STEP 07

Paste both into Jarvis

Sign in to Jarvis → Account → the Kraken card. Paste the API Key into API Key and the Private Key into API Secret. Save. Both values are encrypted at rest with Fernet (AES-128-CBC + HMAC) before they touch disk; the plaintext exists only in memory during request handling.

STEP 08

Confirm Spot Margin is enabled

From your Kraken dashboard, open any of the nine Jarvis pairs (e.g. XBT/USD) and verify the Margin tab is selectable. If the tab is greyed out, complete the Spot Margin enablement steps first — this is a one-click confirmation of the margin agreement at Intermediate tier.

Binance

Binance Spot Margin (cross or isolated) supports all nine Jarvis pairs.

Official references:

  1. Sign in to binance.com → profile menu → API Management.
  2. Create API → choose System generated. Label it Jarvis — live.
  3. Pass 2FA / email confirmation.
  4. On the new key row, click Edit restrictions. Tick Enable Reading, Enable Spot & Margin Trading. Leave Enable Withdrawals OFF.
  5. (Recommended) Restrict access to trusted IPs only and add Jarvis's outbound IP.
  6. Save. Copy the API Key and Secret Key. Paste both into the Binance card on your Jarvis Account page.

OKX

OKX is the only supported venue that requires a passphrase in addition to the key and secret. Make sure to copy all three values.

Official references:

  1. Sign in to okx.com and complete identity verification (Lv.1 or higher).
  2. Account → API → Create V5 API Key.
  3. Set a label and a strong Passphrase — you will need this when pasting into Jarvis.
  4. Permissions: tick Read and Trade. Do NOT tick Withdraw.
  5. (Recommended) Bind to Jarvis's outbound IP.
  6. Save. Copy API Key, Secret Key, and Passphrase. Paste all three into the OKX card on your Jarvis Account page.

Bybit

Bybit Unified Trading Account supports Spot Margin on all nine Jarvis pairs.

Official references:

  1. Sign in to bybit.com and complete KYC Lv.1.
  2. Account & Security → API → Create New Key → System-generated API Keys.
  3. Choose API transaction usage. Label it Jarvis — live.
  4. Permissions: under Unified Trading tick Trade; under Wallet tick Account Transfer (read only). Do NOT tick any Withdraw option.
  5. (Recommended) Bind the key to Jarvis's outbound IP and a 90-day expiry.
  6. Pass 2FA. Copy API Key and API Secret into the Bybit card on your Jarvis Account page.
Final check Before saving any key in Jarvis: re-open it on the exchange's API page and visually confirm that no withdrawal-related box is ticked. If you can see a Withdraw permission enabled, regenerate the key. Jarvis will work normally without it.
Open a Jarvis account Go to my account