Go SDK

​

What the SDK Handles

• Access tokens. The client exchanges your API key for an Access Token when it first needs one, caches it, and refreshes it before it expires.
• Connections. It opens the WebSocket, keeps it alive with pings, and reconnects with backoff that stays within the exchange’s connection limits, including a soft ban.
• Sessions. Each connection keeps its session across reconnects, so order events missed while it was down are replayed.
• Orders. Every order command over the WebSocket waits for the exchange’s answer and reports how long the acknowledgment and the answer took. Each carries a clientRequestId; the SDK generates one for a request that doesn’t set its own.
• Rate limits. The rate limits the exchange reports reach you as errors, with how long to wait. An optional pacer keeps calls under your account’s budget before they are sent.

​

Install

go get github.com/rails-xyz/exchange-go-sdk

​

Credentials and Environments

client, err := perps.NewClient(rails.Credentials{
	APIKey:    os.Getenv("RAILS_API_KEY"),
	APISecret: os.Getenv("RAILS_API_SECRET"),
})
if err != nil {
	return err
}
defer client.Close()

client, err := perps.NewClient(creds, rails.WithEnvironment(rails.Sandbox()))

​

Next Steps

• Configuration and Errors and Retries
• Source on GitHub
• Package reference on pkg.go.dev