alpaca

README

alpaca

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(credentials *Credentials) *Client
  • func (c *Client) Stream(streams []string, handler func(StreamEvent)) error
  • func (c *Client) URL() string
• type Credentials
  • func NewCredentials(key, secret string) *Credentials
• type Environment
• type Error
• type StreamEvent
• type StreamEventData
  • func (s StreamEventData) ContainsKey(key string) bool
  • func (s StreamEventData) Float32(key string) float32
  • func (s StreamEventData) Float64(key string) float64
  • func (s StreamEventData) Int(key string) int
  • func (s StreamEventData) Int64(key string) int64
  • func (s StreamEventData) Interface(key string) interface{}
  • func (s StreamEventData) String(key string) string

Constants

const (
	Paper Environment = "paper"
	Live              = "live"

	Data    = "https://data.alpaca.markets/"
	Version = "v2"
)

Variables

var (
	// DefaultClient is a shared client using environment variables for authentication.
	DefaultClient = NewClient(&Credentials{
		KeyID:     os.Getenv("ALPACA_KEY_ID"),
		SecretKey: os.Getenv("ALPACA_SECRET_KEY"),
	})
)

Types

type Client

type Client struct {
	Environment Environment
	Credentials *Credentials
}

Client null

func NewClient

func NewClient(credentials *Credentials) *Client

NewClient null

func (*Client) Stream

func (c *Client) Stream(streams []string, handler func(StreamEvent)) error

Stream null

func (*Client) URL

func (c *Client) URL() string

URL null

type Credentials

type Credentials struct {
	KeyID     string
	SecretKey string
}

Credentials null

func NewCredentials

func NewCredentials(key, secret string) *Credentials

NewCredentials null

type Environment

type Environment string

Environment the Alpaca API environment.

type Error

type Error struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

Error null

type StreamEvent

type StreamEvent struct {
	Stream string          `json:"stream"`
	Data   StreamEventData `json:"data"`
}

StreamEvent null

type StreamEventData

type StreamEventData map[string]interface{}

StreamEventData null

func (StreamEventData) ContainsKey

func (s StreamEventData) ContainsKey(key string) bool

ContainsKey null

func (StreamEventData) Float32

func (s StreamEventData) Float32(key string) float32

Float32 null

func (StreamEventData) Float64

func (s StreamEventData) Float64(key string) float64

Float64 null

func (StreamEventData) Int

func (s StreamEventData) Int(key string) int

Int null

func (StreamEventData) Int64

func (s StreamEventData) Int64(key string) int64

Int64 null

func (StreamEventData) Interface

func (s StreamEventData) Interface(key string) interface{}

Interface null

func (StreamEventData) String

func (s StreamEventData) String(key string) string

String null