alpaca-trade-api-go

alpaca-trade-api-go is a Go library for the Alpaca trade and marketdata API. It allows rapid trading algo development easily, with support for the both REST and streaming interfaces. For details of each API behavior, please see the online API document.

Installation

go get -u github.com/alpacahq/alpaca-trade-api-go/v3/alpaca

Examples

In order to call Alpaca's trade API, you need to obtain an API key pair from the web console.

Trading REST example

package main

import (
	"fmt"

	"github.com/alpacahq/alpaca-trade-api-go/v3/alpaca"
)

func main() {
	client := alpaca.NewClient(alpaca.ClientOpts{
		// Alternatively you can set your key and secret using the
		// APCA_API_KEY_ID and APCA_API_SECRET_KEY environment variables
		APIKey:    "YOUR_API_KEY",
		APISecret: "YOUR_API_SECRET",
		BaseURL:   "https://paper-api.alpaca.markets",
	})
	acct, err := client.GetAccount()
	if err != nil {
		panic(err)
	}
	fmt.Printf("%+v\n", *acct)
}

Trade updates stream example

The following example shows how you can stream your own trade updates. First we register a handler function that simply prints the received trade updates, then we submit a single AAPL buy order. You should see two updates, a "new" event as soon as you submit the order, and a "fill" event soon after that, provided that the market is open.

// Listen to trade updates in the background (with unlimited reconnect)
alpaca.StreamTradeUpdatesInBackground(context.TODO(), func(tu alpaca.TradeUpdate) {
	log.Printf("TRADE UPDATE: %+v\n", tu)
})

// Send a single AAPL order
qty := decimal.NewFromInt(1)
if _, err := alpaca.PlaceOrder(alpaca.PlaceOrderRequest{
	Symbol:      "AAPL",
	Qty:         &qty,
	Side:        "buy",
	Type:        "market",
	TimeInForce: "day",
}); err != nil {
	log.Fatalf("failed place order: %v", err)
}
log.Println("order sent")

select {}

Handling API errors

Failed API calls return an *alpaca.APIError. Include RequestID (from Alpaca's X-Request-ID header) when opening a support ticket:

acct, err := client.GetAccount()
if err != nil {
	var apiErr *alpaca.APIError
	if errors.As(err, &apiErr) {
		log.Printf("request %s failed: %v", apiErr.RequestID, apiErr)
		return
	}
	log.Fatal(err)
}

Further examples

See the examples directory for further examples:

• algo-trading examples
  • long-short
  • martingale
  • mean-reversion
• marketdata examples
  • crypto-stream
  • data-stream
  • marketdata

API Document

The HTTP API document is located here.

Authentication

The Alpaca API requires API key ID and secret key, which you can obtain from the web console after you sign in. This key pair can then be applied to the SDK either by setting environment variables (APCA_API_KEY_ID=<key_id> and APCA_API_SECRET_KEY=<secret_key>), or hardcoding them into the Go code directly as shown in the examples above.

export APCA_API_KEY_ID=xxxxx
export APCA_API_SECRET_KEY=yyyyy

Broker auth

You use your Broker API key and secret for authentication. However, for this to work make sure you're using the appropriate base URL (for more details check the next section)!

client := marketdata.NewClient(marketdata.ClientOpts{
	BrokerKey:    "CK...",                               // Sandbox broker key
	BrokerSecret: "<your secret>",                       // Sandbox broker secret
	BaseURL:      "https://data.sandbox.alpaca.markets", // Sandbox url
})

Endpoint

For paper trading, set the environment variable APCA_API_BASE_URL or set the BaseURL option when constructing the client.

export APCA_API_BASE_URL=https://paper-api.alpaca.markets

Broker API

For broker partners, set the base URL to

• broker-api.alpaca.markets for production
• broker-api.sandbox.alpaca.markets for sandbox
• data.alpaca.markets for production marketdata
• data.sandbox.alpaca.markets for sandbox marketdata

Documentation

For a more in-depth look at the SDK, see the package documentation.

Support

For failed API calls, include RequestID from *alpaca.APIError when reporting an API bug or contacting Alpaca support. It holds the X-Request-ID response header (see Handling API errors).

• Library / SDK issues: Bugs, feature requests, or questions specific to this Go library → GitHub Issues.
• Alpaca API bugs: Bugs in the Alpaca API itself, its OpenAPI specs, or its documentation → alpacahq/alpaca-api.
• Community: API feature requests, general questions, and dashboard bugs → Alpaca Community Forum or Slack.
• Account help: Questions about your account, funding, or orders → Support request.
• Outages: Service status and incident updates → Status page.