client

Documentation

Overview

Package client implements API access to EDGAR data. It's rate limited, as required by 1, and uses User-Agent. Don't forget set correct User-Agent using WithUserAgent().

Also see 2 for details.

Index

• Variables
• type ArchiveIndex
  • func (self *ArchiveIndex) Items() []ArchiveItem
  • func (self *ArchiveIndex) Name() string
  • func (self *ArchiveIndex) Parent() string
• type ArchiveItem
• type CIK
  • func (self *CIK) UnmarshalJSON(b []byte) error
• type Client
  • func New(opts ...ClientOption) *Client
  • func (self *Client) ArchivesBaseURL() string
  • func (self *Client) CompanyFacts(ctx context.Context, cik uint32) (facts CompanyFacts, err error)
  • func (self *Client) CompanyTickers(ctx context.Context) ([]CompanyTicker, error)
  • func (self *Client) Get(ctx context.Context, url string) (*http.Response, error)
  • func (self *Client) GetArchiveFile(ctx context.Context, path string) (*http.Response, error)
  • func (self *Client) GetJSON(ctx context.Context, url string, value any) error
  • func (self *Client) IndexArchive(ctx context.Context, path string) (index ArchiveIndex, err error)
  • func (self *Client) WithApiBaseURL(u string) *Client
  • func (self *Client) WithArchivesBaseURL(url string) *Client
  • func (self *Client) WithUserAgent(ua string) *Client
• type ClientOption
  • func WithHttpClient(client HttpRequestDoer) ClientOption
  • func WithRateLimiter(l Limiter) ClientOption
• type CompanyFact
• type CompanyFacts
  • func (self *CompanyFacts) Id() uint32
• type CompanyTicker
  • func (self *CompanyTicker) URI() string
• type FactUnit
  • func (self *FactUnit) EndTime() (time.Time, error)
  • func (self *FactUnit) FiledTime() (time.Time, error)
  • func (self *FactUnit) ParseTimes(fn func(startTime, endTime, filedTime time.Time)) error
  • func (self *FactUnit) StartTime() (time.Time, error)
• type HttpRequestDoer
• type Limiter
• type Qtr
  • func NewQtr(date time.Time) Qtr
  • func (self *Qtr) Next() string
  • func (self *Qtr) Path() string
  • func (self *Qtr) QTR() string
• type UnexpectedStatusError
  • func (self *UnexpectedStatusError) Error() string
  • func (self *UnexpectedStatusError) Is(target error) bool
  • func (self *UnexpectedStatusError) Status() string
  • func (self *UnexpectedStatusError) StatusCode() int

Variables

var ErrUnexpectedStatus = &UnexpectedStatusError{}

Types

type ArchiveIndex

type ArchiveIndex struct {
	Directory struct {
		Item      []ArchiveItem `json:"item"`
		Name      string        `json:"name"`
		ParentDir string        `json:"parent-dir"`
	} `json:"directory"`
}

func (*ArchiveIndex) Items

func (self *ArchiveIndex) Items() []ArchiveItem

func (*ArchiveIndex) Name

func (self *ArchiveIndex) Name() string

func (*ArchiveIndex) Parent

func (self *ArchiveIndex) Parent() string

type ArchiveItem

type ArchiveItem struct {
	LastModified string `json:"last-modified"`
	Name         string `json:"name"`
	Type         string `json:"type"`
	Href         string `json:"href"`
	Size         string `json:"size"`
}

type CIK

type CIK uint32

func (*CIK) UnmarshalJSON

func (self *CIK) UnmarshalJSON(b []byte) error

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...ClientOption) *Client

func (*Client) ArchivesBaseURL

func (self *Client) ArchivesBaseURL() string

func (*Client) CompanyFacts

func (self *Client) CompanyFacts(ctx context.Context, cik uint32,
) (facts CompanyFacts, err error)

func (*Client) CompanyTickers

func (self *Client) CompanyTickers(ctx context.Context) ([]CompanyTicker, error)

func (*Client) Get

func (self *Client) Get(ctx context.Context, url string) (*http.Response, error)

func (*Client) GetArchiveFile

func (self *Client) GetArchiveFile(ctx context.Context, path string,
) (*http.Response, error)

func (*Client) GetJSON

func (self *Client) GetJSON(ctx context.Context, url string, value any) error

func (*Client) IndexArchive

func (self *Client) IndexArchive(ctx context.Context, path string,
) (index ArchiveIndex, err error)

func (*Client) WithApiBaseURL

func (self *Client) WithApiBaseURL(u string) *Client

func (*Client) WithArchivesBaseURL

func (self *Client) WithArchivesBaseURL(url string) *Client

func (*Client) WithUserAgent

func (self *Client) WithUserAgent(ua string) *Client

type ClientOption

type ClientOption func(c *Client)

func WithHttpClient

func WithHttpClient(client HttpRequestDoer) ClientOption

func WithRateLimiter

func WithRateLimiter(l Limiter) ClientOption

type CompanyFact

type CompanyFact struct {
	Label       string                `json:"label"`
	Description string                `json:"description"`
	Units       map[string][]FactUnit `json:"units"`
}

type CompanyFacts

type CompanyFacts struct {
	CIK        CIK                               `json:"cik"`
	EntityName string                            `json:"entityName"`
	Facts      map[string]map[string]CompanyFact `json:"facts"`
}

func (*CompanyFacts) Id

func (self *CompanyFacts) Id() uint32

type CompanyTicker

type CompanyTicker struct {
	CIK    uint32 `json:"cik_str"`
	Ticker string `json:"ticker"`
	Title  string `json:"title"`
}

func (*CompanyTicker) URI

func (self *CompanyTicker) URI() string

type FactUnit

type FactUnit struct {
	Start string  `json:"start"`
	End   string  `json:"end"`
	Val   float64 `json:"val"`
	Accn  string  `json:"accn"`
	FY    uint    `json:"fy"`
	FP    string  `json:"fp"`
	Form  string  `json:"form"`
	Filed string  `json:"filed"`
	Frame string  `json:"frame"`
}

func (*FactUnit) EndTime

func (self *FactUnit) EndTime() (time.Time, error)

func (*FactUnit) FiledTime

func (self *FactUnit) FiledTime() (time.Time, error)

func (*FactUnit) ParseTimes

func (self *FactUnit) ParseTimes(fn func(startTime, endTime, filedTime time.Time),
) error

func (*FactUnit) StartTime

func (self *FactUnit) StartTime() (time.Time, error)

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Limiter

type Limiter interface{ Wait(context.Context) error }

type Qtr

type Qtr struct {
	// contains filtered or unexported fields
}

func NewQtr

func NewQtr(date time.Time) Qtr

func (*Qtr) Next

func (self *Qtr) Next() string

func (*Qtr) Path

func (self *Qtr) Path() string

func (*Qtr) QTR

func (self *Qtr) QTR() string

type UnexpectedStatusError

type UnexpectedStatusError struct {
	// contains filtered or unexported fields
}

func (*UnexpectedStatusError) Error

func (self *UnexpectedStatusError) Error() string

func (*UnexpectedStatusError) Is

func (self *UnexpectedStatusError) Is(target error) bool

func (*UnexpectedStatusError) Status

func (self *UnexpectedStatusError) Status() string

func (*UnexpectedStatusError) StatusCode

func (self *UnexpectedStatusError) StatusCode() int