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

goodread

package

Go to main page

Versions in this module

v0

v0.2.0

Jun 14, 2026

Changes in this version

type Author

+ ReviewsCount int64

type Book

+ WorkID string

+ type Domain struct

+ func (Domain) Classify(input string) (uriType, id string, err error)

+ func (Domain) Info() kit.DomainInfo

+ func (Domain) Locate(uriType, id string) (string, error)

+ func (Domain) Register(app *kit.App)

type Genre

+ RelatedGenres []string

type List

+ CreatedByUserID string

+ CreatedDate string

+ LikesCount int

type ListBook

+ AvgRating float64

+ RatingsCount int64

+ Score int

type Quote

+ WorkID string

type Series

+ AuthorID string

+ AuthorName string

type SeriesBook

+ PositionLabel string

type ShelfBook

+ BookDescription string

+ BookPublished int

+ DateCreated time.Time

type User

+ BooksCount int

+ CurrentlyReadingBookIDs []string

v0.1.0

Jun 13, 2026

Changes in this version

+ const BaseURL

+ const DefaultCacheTTL

+ const DefaultDelay

+ const DefaultRetries

+ const DefaultTimeout

+ const DefaultWorkers

+ const RobotsTxtURL

+ var ErrBlocked = errors.New("blocked: page requires sign-in")

+ var ErrNotFound = fmt.Errorf("not found")

+ var ErrRateLimited = errors.New("rate limited (HTTP 429)")

+ func AuthorURL(id string) string

+ func BookURL(id string) string

+ func Classify(s string) (entity, id string)

+ func DefaultDataDir() string

+ func DocFromBytes(body []byte) (*goquery.Document, error)

+ func ExtractID(rawurl, prefix string) string

+ func GenreURL(slug string) string

+ func InferEntityType(u string) string

+ func ListURL(id string) string

+ func LoadCookies(path string) ([]*http.Cookie, error)

+ func ParseList(doc *goquery.Document, listID, pageURL string) (*List, []ListBook, error)

+ func ParseSearchHTMLNextPage(doc *goquery.Document) string

+ func ParseSeries(doc *goquery.Document, seriesID, pageURL string) (*Series, []SeriesBook, error)

+ func ParseShelf(doc *goquery.Document, userID, shelfName, pageURL string) (*Shelf, []ShelfBook, error)

+ func ParseShelfNextPage(doc *goquery.Document) string

+ func ParseShelfRSS(body []byte, userID, shelfName, pageURL string) (*Shelf, []ShelfBook, error)

+ func QuoteURL(id string) string

+ func SearchAutocompleteURL(q string) string

+ func SearchHTMLURL(q string, page int) string

+ func SeriesURL(id string) string

+ func ShelfRSSURL(userID, shelf string) string

+ func ShelfURL(userID, shelf string, page int) string

+ func UserURL(id string) string

+ type Author struct

+ AuthorID string

+ AvgRating float64

+ Bio string

+ BooksCount int

+ BornDate string

+ DiedDate string

+ FetchedAt time.Time

+ FollowersCount int

+ Genres []string

+ Hometown string

+ Influences []string

+ Name string

+ NotableBookIDs []string

+ PhotoURL string

+ RatingsCount int64

+ URL string

+ Website string

+ func ParseAuthor(doc *goquery.Document, authorID, pageURL string) (*Author, error)

+ type Book struct

+ ASIN string

+ AuthorID string

+ AuthorName string

+ AvgRating float64

+ BookID string

+ CoverURL string

+ Description string

+ FetchedAt time.Time

+ Format string

+ Genres []string

+ ISBN string

+ ISBN13 string

+ Language string

+ Pages int

+ PublishedYear int

+ Publisher string

+ RatingsCount int64

+ ReviewsCount int64

+ SeriesID string

+ SeriesName string

+ SeriesPosition string

+ SimilarBookIDs []string

+ Title string

+ TitleWithoutSeries string

+ URL string

+ func ParseAutocompleteBooks(body []byte) []Book

+ func ParseBook(doc *goquery.Document, bookID, pageURL string) (*Book, error)

+ type Cache struct

+ func NewCache(cfg Config) *Cache

+ func (c *Cache) Clear() error

+ func (c *Cache) Get(url string) ([]byte, bool)

+ func (c *Cache) Path(url string) string

+ func (c *Cache) Put(url string, body []byte) error

+ func (c *Cache) Stats() (files int, bytes int64, err error)

+ type Client struct

+ func NewClient(cfg Config) *Client

+ func NewClientWithCookies(cfg Config, cookies []*http.Cookie) (*Client, error)

+ func (c *Client) CachingFetch(ctx context.Context, cache *Cache, cfg Config, url string) ([]byte, error)

+ func (c *Client) CachingFetchHTML(ctx context.Context, cache *Cache, cfg Config, url string) (*goquery.Document, error)

+ func (c *Client) Fetch(ctx context.Context, rawurl string) ([]byte, int, error)

+ func (c *Client) FetchHTML(ctx context.Context, rawurl string) (*goquery.Document, int, error)

+ func (c *Client) GetAuthor(ctx context.Context, id string) (*Author, error)

+ func (c *Client) GetBook(ctx context.Context, id string) (*Book, error)

+ func (c *Client) GetGenre(ctx context.Context, slug string) (*Genre, error)

+ func (c *Client) GetList(ctx context.Context, id string) (*List, []ListBook, error)

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

+ func (c *Client) GetReviews(ctx context.Context, bookID string) ([]Review, error)

+ func (c *Client) GetSeries(ctx context.Context, id string) (*Series, []SeriesBook, error)

+ func (c *Client) GetShelf(ctx context.Context, userID, shelfName string, maxPages int) (*Shelf, []ShelfBook, error)

+ func (c *Client) GetShelfRSS(ctx context.Context, userID, shelfName string) (*Shelf, []ShelfBook, error)

+ func (c *Client) GetUser(ctx context.Context, id string) (*User, error)

+ func (c *Client) RobotsSitemaps(ctx context.Context) ([]SitemapCategory, error)

+ func (c *Client) Search(ctx context.Context, query string, limit int) ([]SearchResult, error)

+ func (c *Client) SearchBooks(ctx context.Context, query string, limit int) ([]Book, error)

+ func (c *Client) SearchHTML(ctx context.Context, query string, limit int) ([]SearchResult, error)

+ func (c *Client) SitemapIndex(ctx context.Context, indexURL string) ([]string, error)

+ func (c *Client) SitemapURLs(ctx context.Context, sitemapURL string) ([]string, error)

+ type Config struct

+ CacheTTL time.Duration

+ CookiePath string

+ DataDir string

+ Delay time.Duration

+ NoCache bool

+ Refresh bool

+ Retries int

+ Timeout time.Duration

+ Workers int

+ func DefaultConfig() Config

+ func (c Config) CacheDir() string

+ func (c Config) StorePath() string

+ type Genre struct

+ BookIDs []string

+ BooksCount int

+ Description string

+ FetchedAt time.Time

+ Name string

+ Slug string

+ URL string

+ func ParseGenre(doc *goquery.Document, slug, pageURL string) (*Genre, error)

+ type List struct

+ BooksCount int

+ CreatedByUser string

+ Description string

+ FetchedAt time.Time

+ ListID string

+ Name string

+ Tags []string

+ URL string

+ VotersCount int

+ type ListBook struct

+ BookID string

+ ListID string

+ Rank int

+ Votes int

+ type QueueItem struct

+ EntityType string

+ HTMLPath string

+ ID int64

+ Priority int

+ URL string

+ type Quote struct

+ AuthorID string

+ AuthorName string

+ BookID string

+ BookTitle string

+ FetchedAt time.Time

+ LikesCount int

+ QuoteID string

+ Tags []string

+ Text string

+ URL string

+ func ParseQuotes(doc *goquery.Document, pageURL string) ([]Quote, error)

+ type Review struct

+ BookID string

+ DateAdded time.Time

+ FetchedAt time.Time

+ IsSpoiler bool

+ LikesCount int

+ Rating int

+ ReviewID string

+ Text string

+ URL string

+ UserID string

+ UserName string

+ func ParseReviews(doc *goquery.Document, bookID string) []Review

+ type SearchResult struct

+ EntityType string

+ Position int

+ Title string

+ URL string

+ func ParseSearchAutocomplete(body []byte) []SearchResult

+ func ParseSearchHTML(doc *goquery.Document) []SearchResult

+ type Series struct

+ BookIDs []string

+ Description string

+ FetchedAt time.Time

+ Name string

+ PrimaryWorkCount int

+ SeriesID string

+ TotalBooks int

+ URL string

+ type SeriesBook struct

+ BookID string

+ Position int

+ SeriesID string

+ type Shelf struct

+ BooksCount int

+ FetchedAt time.Time

+ Name string

+ ShelfID string

+ URL string

+ UserID string

+ type ShelfBook struct

+ AuthorName string

+ AvgRating float64

+ BookID string

+ CoverURL string

+ DateAdded time.Time

+ DateRead time.Time

+ ISBN string

+ NumPages int

+ Rating int

+ ReviewID string

+ ReviewText string

+ ShelfID string

+ Shelves []string

+ Title string

+ UserID string

+ type SitemapCategory struct

+ Category string

+ URL string

+ type Store struct

+ func OpenStore(path string) (*Store, error)

+ func (s *Store) Close() error

+ func (s *Store) Count(entityType string) (int, error)

+ func (s *Store) CountsByType() (map[string]int, error)

+ func (s *Store) Each(entityType string, fn func(id string, data []byte) error) error

+ func (s *Store) Enqueue(ctx context.Context, url, entityType string, priority int) error

+ func (s *Store) Get(entityType, id string) ([]byte, error)

+ func (s *Store) Info() (string, error)

+ func (s *Store) MarkFailed(ctx context.Context, id int64) error

+ func (s *Store) MarkFetched(ctx context.Context, id int64, htmlPath string) error

+ func (s *Store) NextPending(ctx context.Context, n int) ([]QueueItem, error)

+ func (s *Store) Put(entityType, id, url string, record any) error

+ func (s *Store) QueueStats() (map[string]int, error)

+ func (s *Store) ResetActive() error

+ func (s *Store) Vacuum() error

+ type User struct

+ AvatarURL string

+ AvgRating float64

+ Bio string

+ BooksReadCount int

+ FavoriteBookIDs []string

+ FetchedAt time.Time

+ FriendsCount int

+ JoinedDate time.Time

+ Location string

+ Name string

+ RatingsCount int

+ ReviewsCount int

+ URL string

+ UserID string

+ Username string

+ Website string

+ func ParseUser(doc *goquery.Document, userID, pageURL string) (*User, error)