Coinbase Prime Java SDK

Overview

The Coinbase Prime Java SDK is a sample library that demonstrates the structure of a Coinbase Prime driver for the REST APIs.

License

The Coinbase Prime Java SDK sample library is free and open source and released under the Apache License, Version 2.0.

The application and code are only available for demonstration purposes.

Usage

To use the Coinbase Prime Java SDK, initialize the Credentials class and create a new client. The Credentials struct is JSON enabled. Ensure that Prime API credentials are stored in a secure manner. This client can then be used to instantiate Coinbase Prime Services. An example using the PortfoliosService is shown below:

public class Main {
    public static void main(String[] args) {
        String credsStringBlob = System.getenv("COINBASE_PRIME_CREDENTIALS");
        ObjectMapper mapper = new ObjectMapper();

        try {
            CoinbasePrimeCredentials credentials = new CoinbasePrimeCredentials(credsStringBlob);
            CoinbasePrimeClient client = new CoinbasePrimeClient(credentials);

            String portfolioId = System.getenv("COINBASE_PRIME_PORTFOLIO_ID");

            PortfoliosService portfoliosService = PrimeServiceFactory.createPortfoliosService(client);
            GetPortfolioByIdResponse portfolioResponse = portfoliosService.getPortfolioById(
                    new GetPortfolioByIdRequest.Builder()
                            .portfolioId(portfolioId)
                            .build());

            System.out.println(mapper.writeValueAsString(portfolioResponse));
        } catch (Exception e) {
            e.printStackTrace(e);
        }
    }
}

The JSON format expected for COINBASE_PRIME_CREDENTIALS is:

{
  "accessKey": "",
  "passphrase": "",
  "signingKey": ""
}

For a full example on using the SDK, see the Main class under the com.coinbase.examples package.

Warning: this does place a market order for a very small amount of ADA. Please ensure that you have the necessary funds in your account before running this code.

Binaries

Binaries and dependency information for Maven, Gradle, Ivy and others can be found at the Maven Central Repository

Maven example:

<dependency>
    <groupId>com.coinbase.prime</groupId>
    <artifactId>coinbase-prime-sdk-java</artifactId>
    <version>x.y.z</version>
</dependency>

Build

To build the sample library, ensure that Java Development Kit (JDK) 11+ is installed and then run:

mvn clean install

Running Examples

The SDK includes several example classes demonstrating how to use various endpoints.

Setup Environment Variables

First, set up your credentials as environment variables:

export COINBASE_PRIME_CREDENTIALS='{"accessKey":"your-access-key","passphrase":"your-passphrase","signingKey":"your-signing-key"}'
export COINBASE_PRIME_PORTFOLIO_ID="your-portfolio-id"

Option 1: Using Maven directly

mvn exec:java -Dexec.mainClass="com.coinbase.examples.transactions.ListPortfolioTransactions"

Note: Make sure the environment variables are exported in your current shell session before running the examples.

Available Examples

Transactions:

• com.coinbase.examples.transactions.ListPortfolioTransactions - List portfolio transactions

Wallets:

• com.coinbase.examples.wallets.ListPortfolioWallets - List all wallets in a portfolio
• com.coinbase.examples.wallets.GetWallet <wallet-id> - Get wallet details
• com.coinbase.examples.wallets.ListWalletAddresses <wallet-id> <network-id> - List addresses for a wallet
• com.coinbase.examples.wallets.GetWalletDepositInstructions <wallet-id> [deposit-type] - Get deposit instructions (deposit-type: CRYPTO, WIRE, SEN, SWIFT, SEPA)

Other:

• com.coinbase.examples.Main - Comprehensive example with multiple API calls

Example Usage:

# List all wallets
mvn exec:java -Dexec.mainClass="com.coinbase.examples.wallets.ListPortfolioWallets"

# Get specific wallet details
mvn exec:java -Dexec.mainClass="com.coinbase.examples.wallets.GetWallet" -Dexec.args="wallet-id-here"

# List wallet addresses
mvn exec:java -Dexec.mainClass="com.coinbase.examples.wallets.ListWalletAddresses" -Dexec.args="wallet-id network-id"

# Get deposit instructions (defaults to CRYPTO)
mvn exec:java -Dexec.mainClass="com.coinbase.examples.wallets.GetWalletDepositInstructions" -Dexec.args="wallet-id"

# Get deposit instructions for WIRE
mvn exec:java -Dexec.mainClass="com.coinbase.examples.wallets.GetWalletDepositInstructions" -Dexec.args="wallet-id WIRE"

Model Generation

The SDK includes an automated model generator that creates Java domain models and enums from the OpenAPI specification. This ensures the SDK stays in sync with the Prime API specification.

The OpenAPI spec is fetched automatically from the live API (https://api.prime.coinbase.com/v1/openapi.yaml) during model generation and is not committed to source control.

Generate Models from Root Directory

To generate new models from the OpenAPI spec:

mvn -Pgenerate-models

This command:

• Runs in incremental mode (safe - only creates new models that don't exist)
• Generates domain models in src/main/java/com/coinbase/prime/model/
• Generates enums in src/main/java/com/coinbase/prime/model/enums/
• Automatically applies SDK conventions (Builder patterns, license headers, etc.)

Advanced Model Generation

For more control over model generation, see the detailed documentation in tools/model-generator/README.md, which covers:

• Force regenerating all models (dangerous - use with caution)
• Regenerating specific models
• Understanding the generation pipeline
• Troubleshooting generation issues