Documentation
¶
Overview ¶
Package sharelist provides a client for the Longbridge community sharelist API. It covers listing, creating, deleting, and managing securities in sharelists.
Example:
cfg, err := config.NewFormEnv() sctx, err := sharelist.NewFromCfg(cfg) result, err := sctx.List(context.Background(), 20)
Index ¶
- type SharelistContext
- func (c *SharelistContext) AddSecurities(ctx context.Context, id int64, symbols []string) error
- func (c *SharelistContext) Create(ctx context.Context, name string, description string) error
- func (c *SharelistContext) Delete(ctx context.Context, id int64) error
- func (c *SharelistContext) Detail(ctx context.Context, id int64) (*SharelistDetail, error)
- func (c *SharelistContext) List(ctx context.Context, count uint32) (*SharelistList, error)
- func (c *SharelistContext) Popular(ctx context.Context, count uint32) (*SharelistList, error)
- func (c *SharelistContext) RemoveSecurities(ctx context.Context, id int64, symbols []string) error
- func (c *SharelistContext) SortSecurities(ctx context.Context, id int64, symbols []string) error
- type SharelistDetail
- type SharelistInfo
- type SharelistList
- type SharelistScopes
- type SharelistStock
- type SharelistType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SharelistContext ¶
type SharelistContext struct {
// contains filtered or unexported fields
}
SharelistContext is a client for the Longbridge Sharelist API.
func NewFromCfg ¶
func NewFromCfg(cfg *config.Config) (*SharelistContext, error)
NewFromCfg creates a SharelistContext from a *config.Config.
func NewFromEnv ¶
func NewFromEnv() (*SharelistContext, error)
NewFromEnv returns a SharelistContext configured from environment variables.
func (*SharelistContext) AddSecurities ¶
AddSecurities adds one or more securities to a sharelist. Symbols should be in "CODE.MARKET" format, e.g. "TSLA.US" or "700.HK".
Path: POST /v1/sharelists/{id}/items
func (*SharelistContext) Create ¶
Create creates a new sharelist with the given name and optional description. When description is empty the name is used as the description.
Path: POST /v1/sharelists
func (*SharelistContext) Delete ¶
func (c *SharelistContext) Delete(ctx context.Context, id int64) error
Delete deletes a sharelist by ID.
Path: DELETE /v1/sharelists/{id}
func (*SharelistContext) Detail ¶
func (c *SharelistContext) Detail(ctx context.Context, id int64) (*SharelistDetail, error)
Detail returns the full information for a sharelist, including constituents and quotes.
Path: GET /v1/sharelists/{id}
func (*SharelistContext) List ¶
func (c *SharelistContext) List(ctx context.Context, count uint32) (*SharelistList, error)
List returns up to count of the user's own and subscribed sharelists.
Path: GET /v1/sharelists
func (*SharelistContext) Popular ¶
func (c *SharelistContext) Popular(ctx context.Context, count uint32) (*SharelistList, error)
Popular returns up to count trending sharelists.
Path: GET /v1/sharelists/popular
func (*SharelistContext) RemoveSecurities ¶
RemoveSecurities removes one or more securities from a sharelist. Symbols should be in "CODE.MARKET" format, e.g. "TSLA.US" or "700.HK".
Path: DELETE /v1/sharelists/{id}/items
func (*SharelistContext) SortSecurities ¶
SortSecurities reorders the securities in a sharelist. The symbols slice defines the desired order; each symbol should be in "CODE.MARKET" format.
Path: POST /v1/sharelists/{id}/items/sort
type SharelistDetail ¶
type SharelistDetail struct {
Sharelist SharelistInfo
Scopes SharelistScopes
}
SharelistDetail is the result of the Detail method.
type SharelistInfo ¶
type SharelistInfo struct {
ID int64
Name string
Description string
Cover string
SubscribersCount int64
CreatedAt time.Time
EditedAt time.Time
ThisYearChg *decimal.Decimal
Stocks []SharelistStock
Subscribed bool
Chg *decimal.Decimal
SharelistType SharelistType
IndustryCode string
}
SharelistInfo holds metadata and constituent stocks for a sharelist.
type SharelistList ¶
type SharelistList struct {
// trending sharelists).
Sharelists []SharelistInfo
// This field may be empty when returned by Popular.
SubscribedSharelists []SharelistInfo
TailMark string
}
SharelistList is the result of the List and Popular methods.
type SharelistScopes ¶
SharelistScopes holds subscription and ownership status for the current user.
type SharelistStock ¶
type SharelistStock struct {
// It is converted from the wire-level counter_id field.
Symbol string
Name string
Market string
Code string
Intro string
UnreadChangeLogCategory string
Change *decimal.Decimal
LastDone *decimal.Decimal
TradeStatus *int32
Latency *bool
}
SharelistStock describes a security within a sharelist.
type SharelistType ¶
type SharelistType int32
SharelistType represents the kind of sharelist.
const ( SharelistTypeRegular SharelistType = 0 SharelistTypeOfficial SharelistType = 3 SharelistTypeIndustry SharelistType = 4 )