coinbase-samples / intx-sdk-go

Sample Go SDK for the Coinbase INTX REST APIs

Home Page:https://docs.cloud.coinbase.com/intx/reference

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

INTX Go SDK README

GoDoc Go Report Card

Overview

The INTX Go SDK is a sample library that demonstrates the structure of a Coinbase International Exchange (INTX) driver for the REST APIs.

License

The INTX Go 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 INTX Go SDK, initialize the Credentials struct and create a new client. The Credentials struct is JSON enabled. Ensure that INTX API credentials are stored in a secure manner.

credentials := &intx.Credentials{}
if err := json.Unmarshal([]byte(os.Getenv("INTX_CREDENTIALS")), credentials); err != nil {
    return nil, fmt.Errorf("unable to deserialize intx credentials JSON: %w", err)
}

client := intx.NewClient(credentials, http.Client{})

There are convenience functions to read the credentials as an environment variable (intx.ReadEnvCredentials) and to deserialize the JSON structure (intx.UnmarshalCredentials) if pulled from a different source. The JSON format expected by both is:

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

Coinbase INTX API credentials can be created in the INTX web console under API on the left-hand panel.

Once the client is initialized, make the desired call. For example, to list portfolios, pass in the request object, check for an error, and if nil, process the response.

response, err := client.ListPortfolios(ctx, &intx.ListPortfoliosRequest{})

Build

To build the sample library, ensure that Go 1.19+ is installed and then run:

go build *.go

About

Sample Go SDK for the Coinbase INTX REST APIs

https://docs.cloud.coinbase.com/intx/reference

License:Apache License 2.0


Languages

Language:Go 100.0%