Skip to main content

Introduction

The Prime REST API provides programmatic access to Kraken's Prime brokerage services, including API user management, credit and exposure monitoring, and settlement.

To get onboarded to Prime, please contact prime_trading@kraken.com.

Typical workflow​

A typical Prime integration follows these steps:

  1. Create an API user — Call CreatePrimeApiUser to create a user with either a Viewer (read-only) or Trader (read + trade) role.
  2. Generate an API key — Call CreatePrimeApiUserKey to generate credentials for the new user. The API secret is only returned once at creation time — store it securely.
  3. Trade — Execute trades over WebSocket or FIX using the generated credentials. Trades are booked against your Prime credit line.
  4. Create a settlement batch — At the end of a trading period, call CreatePrimeSettlementBatch to snapshot all unsettled trades into a batch. Each batch contains legs representing the net position per asset.
  5. Settle — For each leg in the batch, call SettlePrimeSettlementBatchAsset to initiate the transfer. Use GetPrimeSettlementBatch to monitor settlement progress if needed.

Base URL​

https://api.kraken.com/0

Authentication​

All Prime REST API endpoints use the same authentication mechanism as the Spot REST API.

Explore the API​

Use the navigation on the left to browse endpoints organized by category: Settlement, Exposure, API Users, and API User Keys.