api

package

Go to main page

Versions in this module

v0

v0.5.0

Jan 30, 2026

Changes in this version

+ type InstrumentsResponse = publicapi.InstrumentsResponse

+ type MultilegExpiration = publicapi.MultilegExpiration

+ type MultilegInstrument = publicapi.MultilegInstrument

+ type MultilegLeg = publicapi.MultilegLeg

+ type MultilegOrderRequest = publicapi.MultilegOrderRequest

+ type MultilegOrderResponse = publicapi.MultilegOrderResponse

+ type MultilegPreflightLeg = publicapi.MultilegPreflightLeg

+ type MultilegPreflightRequest = publicapi.MultilegPreflightRequest

+ type MultilegPreflightResponse = publicapi.MultilegPreflightResponse

+ type MultilegPriceIncrement = publicapi.MultilegPriceIncrement

+ type MultilegRegulatoryFees = publicapi.MultilegRegulatoryFees

v0.4.0

Jan 29, 2026

Changes in this version

+ type OptionsOrderRequest struct

+ Expiration OrderExpiration

+ Instrument OrderInstrument

+ LimitPrice string

+ OpenCloseIndicator string

+ OrderID string

+ OrderSide string

+ OrderType string

+ Quantity string

+ type OptionsPreflightRequest struct

+ Expiration OrderExpiration

+ Instrument OrderInstrument

+ LimitPrice string

+ OpenCloseIndicator string

+ OrderSide string

+ OrderType string

+ Quantity string

+ type OptionsPreflightResponse struct

+ BuyingPowerRequirement string

+ EstimatedCommission string

+ EstimatedCost string

+ EstimatedProceeds string

+ EstimatedQuantity string

+ Instrument OrderInstrument

+ OrderValue string

+ RegulatoryFees OptionsRegulatoryFees

+ type OptionsRegulatoryFees struct

+ CATFee string

+ ExchangeFee string

+ OCCFee string

+ ORFFee string

+ SECFee string

+ TAFFee string

v0.3.1

Jan 29, 2026

v0.3.0

Jan 29, 2026

v0.2.0

Jan 16, 2026

Changes in this version

+ func CheckResponse(resp *http.Response) error

+ func DecodeJSON(resp *http.Response, target interface{}) error

+ func GetAuthToken(store keyring.Store, baseURL string, forceRefresh bool) (string, error)

+ type APIError struct

+ Code string

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ func (e *APIError) IsForbidden() bool

+ func (e *APIError) IsNotFound() bool

+ func (e *APIError) IsUnauthorized() bool

+ type Account struct

+ AccountID string

+ AccountType string

+ BrokerageAccountType string

+ OptionsLevel string

+ TradePermissions string

+ type AccountsResponse struct

+ Accounts []Account

+ type BuyingPower struct

+ BuyingPower string

+ CashOnlyBuyingPower string

+ OptionsBuyingPower string

+ type Client struct

+ AuthToken string

+ BaseURL string

+ HTTPClient *http.Client

+ TokenRefresher TokenRefresher

+ func NewClient(baseURL, authToken string) *Client

+ func NewClientWithAuth(store keyring.Store, baseURL string) (*Client, error)

+ func (c *Client) Delete(ctx context.Context, path string) (*http.Response, error)

+ func (c *Client) Get(ctx context.Context, path string) (*http.Response, error)

+ func (c *Client) GetInstrument(ctx context.Context, symbol, instType string) (*InstrumentResponse, error)

+ func (c *Client) GetOptionChain(ctx context.Context, accountID, symbol, expiration string) (*OptionChainResponse, error)

+ func (c *Client) GetOptionExpirations(ctx context.Context, accountID, symbol string) (*OptionExpirationsResponse, error)

+ func (c *Client) GetOptionGreeks(ctx context.Context, accountID string, osiSymbols []string) (*GreeksResponse, error)

+ func (c *Client) GetPortfolio(ctx context.Context, accountID string) (*Portfolio, error)

+ func (c *Client) GetQuotes(ctx context.Context, accountID string, instruments []QuoteInstrument) ([]Quote, error)

+ func (c *Client) GetWithParams(ctx context.Context, path string, params map[string]string) (*http.Response, error)

+ func (c *Client) Post(ctx context.Context, path string, body io.Reader) (*http.Response, error)

+ func (c *Client) WithTokenRefresher(refresher TokenRefresher) *Client

+ type CostBasis struct

+ GainPercentage string

+ GainValue string

+ LastUpdate string

+ TotalCost string

+ UnitCost string

+ type Equity struct

+ PercentageOfPortfolio string

+ Type string

+ Value string

+ type Gain struct

+ GainPercentage string

+ GainValue string

+ Timestamp string

+ type GreeksData struct

+ Delta string

+ Gamma string

+ ImpliedVolatility string

+ Rho string

+ Theta string

+ Vega string

+ type GreeksResponse struct

+ Greeks []OptionGreeks

+ type HistoryResponse struct

+ End string

+ NextToken string

+ PageSize int

+ Start string

+ Transactions []Transaction

+ type Instrument struct

+ Name string

+ Symbol string

+ Type string

+ type InstrumentIdentifier struct

+ Symbol string

+ Type string

+ type InstrumentResponse struct

+ FractionalTrading string

+ Instrument InstrumentIdentifier

+ InstrumentDetails any

+ OptionSpreadTrading string

+ OptionTrading string

+ Trading string

+ type OptionChainRequest struct

+ ExpirationDate string

+ Instrument OptionInstrument

+ type OptionChainResponse struct

+ BaseSymbol string

+ Calls []OptionQuote

+ Puts []OptionQuote

+ type OptionExpirationsRequest struct

+ Instrument OptionInstrument

+ type OptionExpirationsResponse struct

+ BaseSymbol string

+ Expirations []string

+ type OptionGreeks struct

+ Greeks GreeksData

+ Symbol string

+ type OptionInstrument struct

+ Symbol string

+ Type string

+ type OptionQuote struct

+ Ask string

+ AskSize int

+ Bid string

+ BidSize int

+ Instrument OptionInstrument

+ Last string

+ OpenInterest int

+ Outcome string

+ Volume int

+ type Order struct

+ CreatedAt string

+ FilledQuantity string

+ Instrument Instrument

+ LimitPrice string

+ OrderID string

+ Quantity string

+ Side string

+ Status string

+ StopPrice string

+ Type string

+ type OrderExpiration struct

+ TimeInForce string

+ type OrderInstrument struct

+ Symbol string

+ Type string

+ type OrderListResponse struct

+ AccountID string

+ Orders []Order

+ type OrderRequest struct

+ Amount string

+ Expiration OrderExpiration

+ Instrument OrderInstrument

+ LimitPrice string

+ OrderID string

+ OrderSide string

+ OrderType string

+ Quantity string

+ StopPrice string

+ type OrderResponse struct

+ OrderID string

+ type OrderStatusResponse struct

+ AveragePrice string

+ ClosedAt string

+ CreatedAt string

+ FilledQuantity string

+ Instrument OrderInstrument

+ LimitPrice string

+ OrderID string

+ Quantity string

+ Side string

+ Status string

+ StopPrice string

+ Type string

+ type OrdersResponse struct

+ Orders []Order

+ type Portfolio struct

+ AccountID string

+ AccountType string

+ BuyingPower BuyingPower

+ Equity []Equity

+ Positions []Position

+ type Position struct

+ CostBasis CostBasis

+ CurrentValue string

+ Instrument Instrument

+ InstrumentGain Gain

+ LastPrice Price

+ PercentOfPortfolio string

+ PositionDailyGain Gain

+ Quantity string

+ type PreflightRequest struct

+ Expiration OrderExpiration

+ Instrument OrderInstrument

+ LimitPrice string

+ OrderSide string

+ OrderType string

+ Quantity string

+ StopPrice string

+ type PreflightResponse struct

+ BuyingPowerRequirement string

+ EstimatedCommission string

+ EstimatedCost string

+ EstimatedQuantity string

+ Instrument OrderInstrument

+ OrderValue string

+ RegulatoryFees RegulatoryFees

+ type Price struct

+ LastPrice string

+ Timestamp string

+ type Quote struct

+ Ask string

+ AskSize int

+ AskTimestamp string

+ Bid string

+ BidSize int

+ BidTimestamp string

+ Instrument QuoteInstrument

+ Last string

+ LastTimestamp string

+ OpenInterest *int64

+ Outcome string

+ Volume int64

+ type QuoteInstrument struct

+ Symbol string

+ Type string

+ type QuoteRequest struct

+ Instruments []QuoteInstrument

+ type QuotesResponse struct

+ Quotes []Quote

+ type RegulatoryFees struct

+ ORFFee string

+ SECFee string

+ TAFFee string

+ type TokenRefresher func() (string, error)

+ type Transaction struct

+ AccountNumber string

+ Description string

+ Direction string

+ Fees string

+ ID string

+ NetAmount string

+ PrincipalAmount string

+ Quantity string

+ SecurityType string

+ Side string

+ SubType string

+ Symbol string

+ Timestamp string

+ Type string

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