alpaca

package

Go to main page

Versions in this module

v3

v3.4.0

Apr 26, 2024

v3.3.0

Mar 26, 2024

v3.2.2

Nov 3, 2023

Changes in this version

+ func RoundLimitPrice(price decimal.Decimal, side Side) *decimal.Decimal

v3.2.1

Sep 1, 2023

v3.2.0

Aug 31, 2023

v3.1.1

Aug 21, 2023

Changes in this version

+ func Version() string

v3.1.0

Jul 27, 2023

Changes in this version

type Asset

+ Attributes []string

+ MaintenanceMarginRequirement uint

type StreamTradeUpdatesRequest

+ SinceID string

+ UntilID string

type TradeUpdate

+ EventID string

v3.0.1

Feb 15, 2023

v3.0.0

Jan 24, 2023

Changes in this version

+ var DefaultClient = NewClient(ClientOpts{})

+ var ErrSymbolMissing = fmt.Errorf("symbol missing from request")

+ func APIErrorFromResponse(resp *http.Response) error

+ func CancelAllOrders() error

+ func CancelOrder(orderID string) error

+ func DeleteWatchlist(watchlistID string) error

+ func RemoveSymbolFromWatchlist(watchlistID string, req RemoveSymbolFromWatchlistRequest) error

+ func StreamTradeUpdates(ctx context.Context, handler func(TradeUpdate), req StreamTradeUpdatesRequest) error

+ func StreamTradeUpdatesInBackground(ctx context.Context, handler func(TradeUpdate))

+ type APIError struct

+ Body string

+ Code int

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ func (v *APIError) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *APIError) UnmarshalJSON(data []byte) error

+ func (v APIError) MarshalEasyJSON(w *jwriter.Writer)

+ func (v APIError) MarshalJSON() ([]byte, error)

+ type Account struct

+ AccountBlocked bool

+ AccountNumber string

+ AccruedFees decimal.Decimal

+ BodDtbp decimal.Decimal

+ BuyingPower decimal.Decimal

+ Cash decimal.Decimal

+ CreatedAt time.Time

+ CryptoStatus string

+ CryptoTier int

+ Currency string

+ DaytradeCount int64

+ DaytradingBuyingPower decimal.Decimal

+ EffectiveBuyingPower decimal.Decimal

+ Equity decimal.Decimal

+ ID string

+ InitialMargin decimal.Decimal

+ LastEquity decimal.Decimal

+ LastMaintenanceMargin decimal.Decimal

+ LongMarketValue decimal.Decimal

+ MaintenanceMargin decimal.Decimal

+ Multiplier decimal.Decimal

+ NonMarginBuyingPower decimal.Decimal

+ PatternDayTrader bool

+ PortfolioValue decimal.Decimal

+ PositionMarketValue decimal.Decimal

+ RegTBuyingPower decimal.Decimal

+ SMA decimal.Decimal

+ ShortMarketValue decimal.Decimal

+ ShortingEnabled bool

+ Status string

+ TradeSuspendedByUser bool

+ TradingBlocked bool

+ TransfersBlocked bool

+ func GetAccount() (*Account, error)

+ func (v *Account) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Account) UnmarshalJSON(data []byte) error

+ func (v Account) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Account) MarshalJSON() ([]byte, error)

+ type AccountActivity struct

+ ActivityType string

+ CumQty decimal.Decimal

+ Date civil.Date

+ Description string

+ ID string

+ LeavesQty decimal.Decimal

+ NetAmount decimal.Decimal

+ PerShareAmount decimal.Decimal

+ Price decimal.Decimal

+ Qty decimal.Decimal

+ Side string

+ Symbol string

+ TransactionTime time.Time

+ Type string

+ func GetAccountActivities(req GetAccountActivitiesRequest) ([]AccountActivity, error)

+ func (v *AccountActivity) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *AccountActivity) UnmarshalJSON(data []byte) error

+ func (v AccountActivity) MarshalEasyJSON(w *jwriter.Writer)

+ func (v AccountActivity) MarshalJSON() ([]byte, error)

+ type AccountConfigurations struct

+ DTBPCheck DTBPCheck

+ NoShorting bool

+ TradeConfirmEmail TradeConfirmEmail

+ TradeSuspendedByUser bool

+ func GetAccountConfigurations() (*AccountConfigurations, error)

+ func UpdateAccountConfigurations(req UpdateAccountConfigurationsRequest) (*AccountConfigurations, error)

+ func (v *AccountConfigurations) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *AccountConfigurations) UnmarshalJSON(data []byte) error

+ func (v AccountConfigurations) MarshalEasyJSON(w *jwriter.Writer)

+ func (v AccountConfigurations) MarshalJSON() ([]byte, error)

+ type AddSymbolToWatchlistRequest struct

+ Symbol string

+ func (v *AddSymbolToWatchlistRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *AddSymbolToWatchlistRequest) UnmarshalJSON(data []byte) error

+ func (v AddSymbolToWatchlistRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v AddSymbolToWatchlistRequest) MarshalJSON() ([]byte, error)

+ type Announcement struct

+ CASubType string

+ CAType string

+ Cash string

+ CorporateActionsID string

+ DeclarationDate string

+ ExpirationDate string

+ ID string

+ InitiatingOriginalCusip string

+ InitiatingSymbol string

+ NewRate string

+ OldRate string

+ PayableDate string

+ RecordDate string

+ TargetOriginalCusip string

+ TargetSymbol string

+ func GetAnnouncement(announcementID string) (*Announcement, error)

+ func GetAnnouncements(req GetAnnouncementsRequest) ([]Announcement, error)

+ func (v *Announcement) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Announcement) UnmarshalJSON(data []byte) error

+ func (v Announcement) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Announcement) MarshalJSON() ([]byte, error)

+ type Asset struct

+ Class AssetClass

+ EasyToBorrow bool

+ Exchange string

+ Fractionable bool

+ ID string

+ Marginable bool

+ Name string

+ Shortable bool

+ Status AssetStatus

+ Symbol string

+ Tradable bool

+ func GetAsset(symbol string) (*Asset, error)

+ func GetAssets(req GetAssetsRequest) ([]Asset, error)

+ func (v *Asset) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Asset) UnmarshalJSON(data []byte) error

+ func (v Asset) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Asset) MarshalJSON() ([]byte, error)

+ type AssetClass string

+ const Crypto

+ const USEquity

+ type AssetStatus string

+ const AssetActive

+ const AssetInactive

+ type CalendarDay struct

+ Close string

+ Date string

+ Open string

+ func GetCalendar(req GetCalendarRequest) ([]CalendarDay, error)

+ func (v *CalendarDay) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *CalendarDay) UnmarshalJSON(data []byte) error

+ func (v CalendarDay) MarshalEasyJSON(w *jwriter.Writer)

+ func (v CalendarDay) MarshalJSON() ([]byte, error)

+ type Client struct

+ func NewClient(opts ClientOpts) *Client

+ func (c *Client) AddSymbolToWatchlist(watchlistID string, req AddSymbolToWatchlistRequest) (*Watchlist, error)

+ func (c *Client) CancelAllOrders() error

+ func (c *Client) CancelOrder(orderID string) error

+ func (c *Client) CloseAllPositions(req CloseAllPositionsRequest) ([]Order, error)

+ func (c *Client) ClosePosition(symbol string, req ClosePositionRequest) (*Order, error)

+ func (c *Client) CreateWatchlist(req CreateWatchlistRequest) (*Watchlist, error)

+ func (c *Client) DeleteWatchlist(watchlistID string) error

+ func (c *Client) GetAccount() (*Account, error)

+ func (c *Client) GetAccountActivities(req GetAccountActivitiesRequest) ([]AccountActivity, error)

+ func (c *Client) GetAccountConfigurations() (*AccountConfigurations, error)

+ func (c *Client) GetAnnouncement(announcementID string) (*Announcement, error)

+ func (c *Client) GetAnnouncements(req GetAnnouncementsRequest) ([]Announcement, error)

+ func (c *Client) GetAsset(symbol string) (*Asset, error)

+ func (c *Client) GetAssets(req GetAssetsRequest) ([]Asset, error)

+ func (c *Client) GetCalendar(req GetCalendarRequest) ([]CalendarDay, error)

+ func (c *Client) GetClock() (*Clock, error)

+ func (c *Client) GetOrder(orderID string) (*Order, error)

+ func (c *Client) GetOrderByClientOrderID(clientOrderID string) (*Order, error)

+ func (c *Client) GetOrders(req GetOrdersRequest) ([]Order, error)

+ func (c *Client) GetPortfolioHistory(req GetPortfolioHistoryRequest) (*PortfolioHistory, error)

+ func (c *Client) GetPosition(symbol string) (*Position, error)

+ func (c *Client) GetPositions() ([]Position, error)

+ func (c *Client) GetWatchlist(watchlistID string) (*Watchlist, error)

+ func (c *Client) GetWatchlists() ([]Watchlist, error)

+ func (c *Client) PlaceOrder(req PlaceOrderRequest) (*Order, error)

+ func (c *Client) RemoveSymbolFromWatchlist(watchlistID string, req RemoveSymbolFromWatchlistRequest) error

+ func (c *Client) ReplaceOrder(orderID string, req ReplaceOrderRequest) (*Order, error)

+ func (c *Client) StreamTradeUpdates(ctx context.Context, handler func(TradeUpdate), req StreamTradeUpdatesRequest) error

+ func (c *Client) StreamTradeUpdatesInBackground(ctx context.Context, handler func(TradeUpdate))

+ func (c *Client) UpdateAccountConfigurations(req UpdateAccountConfigurationsRequest) (*AccountConfigurations, error)

+ func (c *Client) UpdateWatchlist(watchlistID string, req UpdateWatchlistRequest) (*Watchlist, error)

+ type ClientOpts struct

+ APIKey string

+ APISecret string

+ BaseURL string

+ HTTPClient *http.Client

+ OAuth string

+ RetryDelay time.Duration

+ RetryLimit int

+ type Clock struct

+ IsOpen bool

+ NextClose time.Time

+ NextOpen time.Time

+ Timestamp time.Time

+ func GetClock() (*Clock, error)

+ func (v *Clock) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Clock) UnmarshalJSON(data []byte) error

+ func (v Clock) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Clock) MarshalJSON() ([]byte, error)

+ type CloseAllPositionsRequest struct

+ CancelOrders bool

+ type ClosePositionRequest struct

+ Percentage decimal.Decimal

+ Qty decimal.Decimal

+ type CreateWatchlistRequest struct

+ Name string

+ Symbols []string

+ func (v *CreateWatchlistRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *CreateWatchlistRequest) UnmarshalJSON(data []byte) error

+ func (v CreateWatchlistRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v CreateWatchlistRequest) MarshalJSON() ([]byte, error)

+ type DTBPCheck string

+ const Both

+ const Entry

+ const Exit

+ type DateType string

+ const DeclarationDate

+ const ExDate

+ const PayableDate

+ const RecordDate

+ type Fundamental struct

+ AssetID string

+ AvgVol int64

+ Beta float32

+ DivRate float32

+ EPS float32

+ FiftyTwoWeekHigh decimal.Decimal

+ FiftyTwoWeekLow decimal.Decimal

+ FullName string

+ GrossMargin float32

+ IndustryGroup string

+ IndustryName string

+ LongDescription string

+ MarketCap int64

+ PC float32

+ PEGRatio float32

+ PERatio float32

+ PS float32

+ ROA float32

+ ROE float32

+ Sector string

+ SharesOutstanding int64

+ ShortDescription string

+ Symbol string

+ func (v *Fundamental) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Fundamental) UnmarshalJSON(data []byte) error

+ func (v Fundamental) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Fundamental) MarshalJSON() ([]byte, error)

+ type GetAccountActivitiesRequest struct

+ ActivityTypes []string

+ After time.Time

+ Date time.Time

+ Direction string

+ PageSize int

+ Until time.Time

+ type GetAnnouncementsRequest struct

+ CATypes []string

+ Cusip string

+ DateType DateType

+ Since time.Time

+ Symbol string

+ Until time.Time

+ type GetAssetsRequest struct

+ AssetClass string

+ Exchange string

+ Status string

+ type GetCalendarRequest struct

+ End time.Time

+ Start time.Time

+ type GetOrdersRequest struct

+ After time.Time

+ Direction string

+ Limit int

+ Nested bool

+ Side string

+ Status string

+ Symbols []string

+ Until time.Time

+ type GetPortfolioHistoryRequest struct

+ DateEnd time.Time

+ ExtendedHours bool

+ Period string

+ TimeFrame TimeFrame

+ type Order struct

+ AssetClass AssetClass

+ AssetID string

+ CanceledAt *time.Time

+ ClientOrderID string

+ CreatedAt time.Time

+ ExpiredAt *time.Time

+ ExtendedHours bool

+ FailedAt *time.Time

+ FilledAt *time.Time

+ FilledAvgPrice *decimal.Decimal

+ FilledQty decimal.Decimal

+ HWM *decimal.Decimal

+ ID string

+ Legs []Order

+ LimitPrice *decimal.Decimal

+ Notional *decimal.Decimal

+ OrderClass OrderClass

+ Qty *decimal.Decimal

+ ReplacedAt *time.Time

+ ReplacedBy *string

+ Replaces *string

+ Side Side

+ Status string

+ StopPrice *decimal.Decimal

+ SubmittedAt time.Time

+ Symbol string

+ TimeInForce TimeInForce

+ TrailPercent *decimal.Decimal

+ TrailPrice *decimal.Decimal

+ Type OrderType

+ UpdatedAt time.Time

+ func CloseAllPositions(req CloseAllPositionsRequest) ([]Order, error)

+ func ClosePosition(symbol string, req ClosePositionRequest) (*Order, error)

+ func GetOrder(orderID string) (*Order, error)

+ func GetOrderByClientOrderID(clientOrderID string) (*Order, error)

+ func GetOrders(req GetOrdersRequest) ([]Order, error)

+ func PlaceOrder(req PlaceOrderRequest) (*Order, error)

+ func ReplaceOrder(orderID string, req ReplaceOrderRequest) (*Order, error)

+ func (v *Order) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Order) UnmarshalJSON(data []byte) error

+ func (v Order) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Order) MarshalJSON() ([]byte, error)

+ type OrderClass string

+ const Bracket

+ const OCO

+ const OTO

+ const Simple

+ type OrderType string

+ const Limit

+ const Market

+ const Stop

+ const StopLimit

+ const TrailingStop

+ type PlaceOrderRequest struct

+ ClientOrderID string

+ ExtendedHours bool

+ LimitPrice *decimal.Decimal

+ Notional *decimal.Decimal

+ OrderClass OrderClass

+ Qty *decimal.Decimal

+ Side Side

+ StopLoss *StopLoss

+ StopPrice *decimal.Decimal

+ Symbol string

+ TakeProfit *TakeProfit

+ TimeInForce TimeInForce

+ TrailPercent *decimal.Decimal

+ TrailPrice *decimal.Decimal

+ Type OrderType

+ type PortfolioHistory struct

+ BaseValue decimal.Decimal

+ Equity []decimal.Decimal

+ ProfitLoss []decimal.Decimal

+ ProfitLossPct []decimal.Decimal

+ Timeframe TimeFrame

+ Timestamp []int64

+ func GetPortfolioHistory(req GetPortfolioHistoryRequest) (*PortfolioHistory, error)

+ func (v *PortfolioHistory) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *PortfolioHistory) UnmarshalJSON(data []byte) error

+ func (v PortfolioHistory) MarshalEasyJSON(w *jwriter.Writer)

+ func (v PortfolioHistory) MarshalJSON() ([]byte, error)

+ type Position struct

+ AssetClass AssetClass

+ AssetID string

+ AssetMarginable bool

+ AvgEntryPrice decimal.Decimal

+ ChangeToday *decimal.Decimal

+ CostBasis decimal.Decimal

+ CurrentPrice *decimal.Decimal

+ Exchange string

+ LastdayPrice *decimal.Decimal

+ MarketValue *decimal.Decimal

+ Qty decimal.Decimal

+ QtyAvailable decimal.Decimal

+ Side string

+ Symbol string

+ UnrealizedIntradayPL *decimal.Decimal

+ UnrealizedIntradayPLPC *decimal.Decimal

+ UnrealizedPL *decimal.Decimal

+ UnrealizedPLPC *decimal.Decimal

+ func GetPosition(symbol string) (*Position, error)

+ func GetPositions() ([]Position, error)

+ func (v *Position) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Position) UnmarshalJSON(data []byte) error

+ func (v Position) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Position) MarshalJSON() ([]byte, error)

+ type RemoveSymbolFromWatchlistRequest struct

+ Symbol string

+ func (v *RemoveSymbolFromWatchlistRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *RemoveSymbolFromWatchlistRequest) UnmarshalJSON(data []byte) error

+ func (v RemoveSymbolFromWatchlistRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v RemoveSymbolFromWatchlistRequest) MarshalJSON() ([]byte, error)

+ type ReplaceOrderRequest struct

+ ClientOrderID string

+ LimitPrice *decimal.Decimal

+ Qty *decimal.Decimal

+ StopPrice *decimal.Decimal

+ TimeInForce TimeInForce

+ Trail *decimal.Decimal

+ type Side string

+ const Buy

+ const Sell

+ type StopLoss struct

+ LimitPrice *decimal.Decimal

+ StopPrice *decimal.Decimal

+ type StreamTradeUpdatesRequest struct

+ Since time.Time

+ Until time.Time

+ type TakeProfit struct

+ LimitPrice *decimal.Decimal

+ type TimeFrame string

+ const Day1

+ const Hour1

+ const Min1

+ const Min15

+ const Min5

+ type TimeInForce string

+ const CLS

+ const Day

+ const FOK

+ const GTC

+ const GTD

+ const GTX

+ const IOC

+ const OPG

+ type TradeConfirmEmail string

+ const All

+ const None

+ type TradeUpdate struct

+ At time.Time

+ Event string

+ ExecutionID string

+ Order Order

+ PositionQty *decimal.Decimal

+ Price *decimal.Decimal

+ Qty *decimal.Decimal

+ Timestamp *time.Time

+ func (v *TradeUpdate) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *TradeUpdate) UnmarshalJSON(data []byte) error

+ func (v TradeUpdate) MarshalEasyJSON(w *jwriter.Writer)

+ func (v TradeUpdate) MarshalJSON() ([]byte, error)

+ type UpdateAccountConfigurationsRequest struct

+ DtbpCheck string

+ FractionalTrading bool

+ NoShorting bool

+ SuspendTrade bool

+ TradeConfirmEmail string

+ type UpdateWatchlistRequest struct

+ Name string

+ Symbols []string

+ func (v *UpdateWatchlistRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *UpdateWatchlistRequest) UnmarshalJSON(data []byte) error

+ func (v UpdateWatchlistRequest) MarshalEasyJSON(w *jwriter.Writer)

+ func (v UpdateWatchlistRequest) MarshalJSON() ([]byte, error)

+ type Watchlist struct

+ AccountID string

+ Assets []Asset

+ CreatedAt string

+ ID string

+ Name string

+ UpdatedAt string

+ func AddSymbolToWatchlist(watchlistID string, req AddSymbolToWatchlistRequest) (*Watchlist, error)

+ func CreateWatchlist(req CreateWatchlistRequest) (*Watchlist, error)

+ func GetWatchlist(watchlistID string) (*Watchlist, error)

+ func GetWatchlists() ([]Watchlist, error)

+ func UpdateWatchlist(watchlistID string, req UpdateWatchlistRequest) (*Watchlist, error)

+ func (v *Watchlist) UnmarshalEasyJSON(l *jlexer.Lexer)

+ func (v *Watchlist) UnmarshalJSON(data []byte) error

+ func (v Watchlist) MarshalEasyJSON(w *jwriter.Writer)

+ func (v Watchlist) MarshalJSON() ([]byte, error)

v3.0.0-rc1

Jan 24, 2023

Other modules containing this package

github.com/alpacahq/alpaca-trade-api-go

github.com/alpacahq/alpaca-trade-api-go/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL