Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.1.1

Oct 16, 2026

v0.1.0

Oct 15, 2026

Changes in this version

+ func NewClient(server string, opts ...ClientOption) (*genClient, error)

+ func NewGetCalendarRequest(server string, params *GetCalendarParams) (*http.Request, error)

+ func NewGetIncomeRequest(server string, params *GetIncomeParams) (*http.Request, error)

+ func NewGetMeRequest(server string) (*http.Request, error)

+ func NewGetStockRequest(server string, symbol string) (*http.Request, error)

+ func NewListDividendsRequest(server string, params *ListDividendsParams) (*http.Request, error)

+ func NewListHoldingsRequest(server string, params *ListHoldingsParams) (*http.Request, error)

+ func NewListPortfoliosRequest(server string) (*http.Request, error)

+ func NewListUpcomingRequest(server string, params *ListUpcomingParams) (*http.Request, error)

+ func NewSearchStocksRequest(server string, params *SearchStocksParams) (*http.Request, error)

+ type Calendar struct

+ Days int

+ From openapi_types.Date

+ Stocks []struct{ ... }

+ type Client struct

+ func New(cfg Config) (*Client, error)

+ func (c *Client) Calendar(ctx context.Context, days int) (*Calendar, error)

+ func (c *Client) Dividends(ctx context.Context, params ListDividendsParams) (*DividendList, error)

+ func (c *Client) Holdings(ctx context.Context, params ListHoldingsParams) (*HoldingList, error)

+ func (c *Client) Income(ctx context.Context, params GetIncomeParams) (*Income, error)

+ func (c *Client) Me(ctx context.Context) (*Me, error)

+ func (c *Client) Portfolios(ctx context.Context) (*PortfolioList, error)

+ func (c *Client) SearchStocks(ctx context.Context, query string) (*StockSearch, error)

+ func (c *Client) Stock(ctx context.Context, symbol string) (*Stock, error)

+ func (c *Client) Upcoming(ctx context.Context, params ListUpcomingParams) (*Upcoming, error)

+ type ClientInterface interface

+ GetCalendar func(ctx context.Context, params *GetCalendarParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetIncome func(ctx context.Context, params *GetIncomeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetMe func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetStock func(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*http.Response, error)

+ ListDividends func(ctx context.Context, params *ListDividendsParams, ...) (*http.Response, error)

+ ListHoldings func(ctx context.Context, params *ListHoldingsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ ListPortfolios func(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

+ ListUpcoming func(ctx context.Context, params *ListUpcomingParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ SearchStocks func(ctx context.Context, params *SearchStocksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ type ClientOption func(*genClient) error

+ func WithBaseURL(baseURL string) ClientOption

+ func WithHTTPClient(doer HttpRequestDoer) ClientOption

+ func WithRequestEditorFn(fn RequestEditorFn) ClientOption

+ type ClientWithResponses struct

+ func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

+ func (c *ClientWithResponses) GetCalendarWithResponse(ctx context.Context, params *GetCalendarParams, reqEditors ...RequestEditorFn) (*GetCalendarResponse, error)

+ func (c *ClientWithResponses) GetIncomeWithResponse(ctx context.Context, params *GetIncomeParams, reqEditors ...RequestEditorFn) (*GetIncomeResponse, error)

+ func (c *ClientWithResponses) GetMeWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMeResponse, error)

+ func (c *ClientWithResponses) GetStockWithResponse(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*GetStockResponse, error)

+ func (c *ClientWithResponses) ListDividendsWithResponse(ctx context.Context, params *ListDividendsParams, ...) (*ListDividendsResponse, error)

+ func (c *ClientWithResponses) ListHoldingsWithResponse(ctx context.Context, params *ListHoldingsParams, reqEditors ...RequestEditorFn) (*ListHoldingsResponse, error)

+ func (c *ClientWithResponses) ListPortfoliosWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListPortfoliosResponse, error)

+ func (c *ClientWithResponses) ListUpcomingWithResponse(ctx context.Context, params *ListUpcomingParams, reqEditors ...RequestEditorFn) (*ListUpcomingResponse, error)

+ func (c *ClientWithResponses) SearchStocksWithResponse(ctx context.Context, params *SearchStocksParams, reqEditors ...RequestEditorFn) (*SearchStocksResponse, error)

+ type ClientWithResponsesInterface interface

+ GetCalendarWithResponse func(ctx context.Context, params *GetCalendarParams, reqEditors ...RequestEditorFn) (*GetCalendarResponse, error)

+ GetIncomeWithResponse func(ctx context.Context, params *GetIncomeParams, reqEditors ...RequestEditorFn) (*GetIncomeResponse, error)

+ GetMeWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMeResponse, error)

+ GetStockWithResponse func(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*GetStockResponse, error)

+ ListDividendsWithResponse func(ctx context.Context, params *ListDividendsParams, ...) (*ListDividendsResponse, error)

+ ListHoldingsWithResponse func(ctx context.Context, params *ListHoldingsParams, reqEditors ...RequestEditorFn) (*ListHoldingsResponse, error)

+ ListPortfoliosWithResponse func(ctx context.Context, reqEditors ...RequestEditorFn) (*ListPortfoliosResponse, error)

+ ListUpcomingWithResponse func(ctx context.Context, params *ListUpcomingParams, reqEditors ...RequestEditorFn) (*ListUpcomingResponse, error)

+ SearchStocksWithResponse func(ctx context.Context, params *SearchStocksParams, reqEditors ...RequestEditorFn) (*SearchStocksResponse, error)

+ type Config struct

+ BaseURL string

+ Token auth.Secret

+ Transport http.RoundTripper

+ UserAgent string

+ type Dividend struct

+ Amount Money

+ Date openapi_types.Date

+ Isin *string

+ Name *string

+ Net Money

+ PerShareAmount *Money

+ Portfolio *string

+ Quantity *int

+ Source *string

+ Symbol string

+ WithholdingTax *Money

+ type DividendList struct

+ Dividends []Dividend

+ type Error struct

+ Error struct{ ... }

+ type ErrorErrorCode string

+ const BadRequest

+ const Forbidden

+ const InvalidParams

+ const NotFound

+ const RateLimited

+ const Unauthorized

+ func (e ErrorErrorCode) Valid() bool

+ type GetCalendarParams struct

+ Days *int

+ type GetCalendarResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *Calendar

+ JSON422 *Error

+ JSON429 *Error

+ func ParseGetCalendarResponse(rsp *http.Response) (*GetCalendarResponse, error)

+ func (r GetCalendarResponse) ContentType() string

+ func (r GetCalendarResponse) GetBody() []byte

+ func (r GetCalendarResponse) GetJSON200() *Calendar

+ func (r GetCalendarResponse) GetJSON422() *Error

+ func (r GetCalendarResponse) GetJSON429() *Error

+ func (r GetCalendarResponse) Status() string

+ func (r GetCalendarResponse) StatusCode() int

+ type GetIncomeParams struct

+ Drip *bool

+ Portfolio *string

+ Years *int

+ type GetIncomeResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *Income

+ JSON401 *Error

+ JSON422 *Error

+ func ParseGetIncomeResponse(rsp *http.Response) (*GetIncomeResponse, error)

+ func (r GetIncomeResponse) ContentType() string

+ func (r GetIncomeResponse) GetBody() []byte

+ func (r GetIncomeResponse) GetJSON200() *Income

+ func (r GetIncomeResponse) GetJSON401() *Error

+ func (r GetIncomeResponse) GetJSON422() *Error

+ func (r GetIncomeResponse) Status() string

+ func (r GetIncomeResponse) StatusCode() int

+ type GetMeResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *Me

+ JSON401 *Error

+ func ParseGetMeResponse(rsp *http.Response) (*GetMeResponse, error)

+ func (r GetMeResponse) ContentType() string

+ func (r GetMeResponse) GetBody() []byte

+ func (r GetMeResponse) GetJSON200() *Me

+ func (r GetMeResponse) GetJSON401() *Error

+ func (r GetMeResponse) Status() string

+ func (r GetMeResponse) StatusCode() int

+ type GetStockResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *Stock

+ JSON404 *Error

+ JSON429 *Error

+ func ParseGetStockResponse(rsp *http.Response) (*GetStockResponse, error)

+ func (r GetStockResponse) ContentType() string

+ func (r GetStockResponse) GetBody() []byte

+ func (r GetStockResponse) GetJSON200() *Stock

+ func (r GetStockResponse) GetJSON404() *Error

+ func (r GetStockResponse) GetJSON429() *Error

+ func (r GetStockResponse) Status() string

+ func (r GetStockResponse) StatusCode() int

+ type Holding struct

+ AverageCost Money

+ InstrumentType *string

+ Isin *string

+ Name *string

+ Portfolio *string

+ Sector *string

+ Shares string

+ Symbol string

+ type HoldingList struct

+ Holdings []Holding

+ type HttpRequestDoer interface

+ Do func(req *http.Request) (*http.Response, error)

+ type Income struct

+ AnnualIncome Money

+ CurrentYieldPct *float64

+ Drip bool

+ GrowthRate *float64

+ Holdings []struct{ ... }

+ IncomeYear ...

+ NetAnnualIncome Money

+ Projection []struct{ ... }

+ Years int

+ type ListDividendsParams struct

+ From *openapi_types.Date

+ Portfolio *string

+ Symbol *string

+ To *openapi_types.Date

+ type ListDividendsResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *DividendList

+ JSON401 *Error

+ JSON422 *Error

+ func ParseListDividendsResponse(rsp *http.Response) (*ListDividendsResponse, error)

+ func (r ListDividendsResponse) ContentType() string

+ func (r ListDividendsResponse) GetBody() []byte

+ func (r ListDividendsResponse) GetJSON200() *DividendList

+ func (r ListDividendsResponse) GetJSON401() *Error

+ func (r ListDividendsResponse) GetJSON422() *Error

+ func (r ListDividendsResponse) Status() string

+ func (r ListDividendsResponse) StatusCode() int

+ type ListHoldingsParams struct

+ Portfolio *string

+ type ListHoldingsResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *HoldingList

+ JSON401 *Error

+ JSON422 *Error

+ func ParseListHoldingsResponse(rsp *http.Response) (*ListHoldingsResponse, error)

+ func (r ListHoldingsResponse) ContentType() string

+ func (r ListHoldingsResponse) GetBody() []byte

+ func (r ListHoldingsResponse) GetJSON200() *HoldingList

+ func (r ListHoldingsResponse) GetJSON401() *Error

+ func (r ListHoldingsResponse) GetJSON422() *Error

+ func (r ListHoldingsResponse) Status() string

+ func (r ListHoldingsResponse) StatusCode() int

+ type ListPortfoliosResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *PortfolioList

+ JSON401 *Error

+ func ParseListPortfoliosResponse(rsp *http.Response) (*ListPortfoliosResponse, error)

+ func (r ListPortfoliosResponse) ContentType() string

+ func (r ListPortfoliosResponse) GetBody() []byte

+ func (r ListPortfoliosResponse) GetJSON200() *PortfolioList

+ func (r ListPortfoliosResponse) GetJSON401() *Error

+ func (r ListPortfoliosResponse) Status() string

+ func (r ListPortfoliosResponse) StatusCode() int

+ type ListUpcomingParams struct

+ Days *int

+ Portfolio *string

+ type ListUpcomingResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *Upcoming

+ JSON401 *Error

+ JSON422 *Error

+ func ParseListUpcomingResponse(rsp *http.Response) (*ListUpcomingResponse, error)

+ func (r ListUpcomingResponse) ContentType() string

+ func (r ListUpcomingResponse) GetBody() []byte

+ func (r ListUpcomingResponse) GetJSON200() *Upcoming

+ func (r ListUpcomingResponse) GetJSON401() *Error

+ func (r ListUpcomingResponse) GetJSON422() *Error

+ func (r ListUpcomingResponse) Status() string

+ func (r ListUpcomingResponse) StatusCode() int

+ type Me struct

+ Email string

+ Id openapi_types.UUID

+ Name *string

+ PreferredCurrency string

+ type Money struct

+ Amount string

+ Currency string

+ type Portfolio struct

+ Default bool

+ Name string

+ Slug *string

+ type PortfolioList struct

+ Portfolios []Portfolio

+ type RequestEditorFn func(ctx context.Context, req *http.Request) error

+ type SearchStocksParams struct

+ Q string

+ type SearchStocksResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *StockSearch

+ JSON422 *Error

+ JSON429 *Error

+ func ParseSearchStocksResponse(rsp *http.Response) (*SearchStocksResponse, error)

+ func (r SearchStocksResponse) ContentType() string

+ func (r SearchStocksResponse) GetBody() []byte

+ func (r SearchStocksResponse) GetJSON200() *StockSearch

+ func (r SearchStocksResponse) GetJSON422() *Error

+ func (r SearchStocksResponse) GetJSON429() *Error

+ func (r SearchStocksResponse) Status() string

+ func (r SearchStocksResponse) StatusCode() int

+ type StatusError struct

+ Code string

+ Message string

+ Status int

+ func (e *StatusError) Error() string

+ type Stock struct

+ Currency string

+ Dividend struct{ ... }

+ Industry *string

+ InstrumentType *string

+ Name *string

+ Price ...

+ Scores struct{ ... }

+ Sector *string

+ Symbol string

+ type StockDividendSafety string

+ const AtRisk

+ const Safe

+ const Unknown

+ const Watch

+ func (e StockDividendSafety) Valid() bool

+ type StockSearch struct

+ Results []struct{ ... }

+ type UnreachableError struct

+ Err error

+ Host string

+ func (e *UnreachableError) Error() string

+ func (e *UnreachableError) Unwrap() error

+ type Upcoming struct

+ Days int

+ From openapi_types.Date

+ Items []struct{ ... }