prime-cli

Prime CLI

Overview

The Coinbase Prime command-line interface (CLI) to simplify programmatic interaction with Coinbase Prime's REST APIs.

License

The Prime CLI is free and open source and released under the Apache License, Version 2.0.

The application and code are only available for demonstration purposes.

Installation

Install the Prime CLI binary on your computer.

MacOS

Ensure that you have Homebrew installed.

Install the Coinbase Samples Homebrew tap:

brew tap coinbase-samples/homebrew-tap

Next, install the Prime CLI Homebrew formula:

brew install prime-cli

Other Platforms

To install the Prime CLI on other platforms, clone this repository, build, and then add the binary to the path.

git clone [email protected]:coinbase-samples/prime-cli.git
cd prime-cli
go build -o primectl

Configuration

Once you have the CLI installed, configure your environment.

Set an environment variable in your shell called PRIME_CREDENTIALS with your API and portfolio information.

Coinbase Prime API credentials can be created in the Prime web console under Settings -> APIs. Entity ID can be retrieved by calling Get Portfolio. If you are not configured yet to call this endpoint, you may proceed without including the entityId key and value for the time being, but certain endpoints such as List Invoices and List Assets require it.

PRIME_CREDENTIALS should match the following format:

export PRIME_CREDENTIALS='{
"accessKey":"ACCESSKEY_HERE",
"passphrase":"PASSPHRASE_HERE",
"signingKey":"SIGNINGKEY_HERE",
"portfolioId":"PORTFOLIOID_HERE",
"svcAccountId":"SVCACCOUNTID_HERE",
"entityId":"ENTITYID_HERE"
}'

You may also pass an environment variable called primeCliTimeout which will override the default request timeout of 7 seconds. This value should be an integer in seconds.

Usage

Build the application binary and specify an output name, e.g. primectl:

go build -o primectl

To ensure your project's dependencies are up-to-date, run:

go mod tidy

To verify that your application is installed correctly and accessible from any location, run the following command. It will include all available requests:

./primectl

Finally, to run commands for each endpoint, use the following format to test each endpoint. Please note that many endpoints require flags, which are detailed with the --help flag.

./primectl portfolios list

./primectl orders create --help

./primectl orders create-preview -b 0.001 -i ETH-USD -s BUY -t MARKET