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
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

fred

package module

Go to main page

Versions in this module

v0

v0.1.2

May 10, 2026

v0.1.1

May 9, 2026

v0.1.0

May 5, 2026

Changes in this version

+ type APIError = internal.APIError

+ type Category struct

+ ID int

+ Name string

+ Notes string

+ ParentID int

+ type Client struct

+ func New(opts ...ClientOption) (*Client, error)

+ func (c *Client) GetCategory(ctx context.Context, id int) (*Category, error)

+ func (c *Client) GetCategoryChildren(ctx context.Context, id int) ([]Category, error)

+ func (c *Client) GetCategoryRelated(ctx context.Context, id int) ([]Category, error)

+ func (c *Client) GetCategoryRelatedTags(ctx context.Context, id int, tagNames []string, opts ...TagOption) ([]Tag, error)

+ func (c *Client) GetCategorySeries(ctx context.Context, categoryID int, opts ...SearchOption) ([]SearchResult, error)

+ func (c *Client) GetCategoryTags(ctx context.Context, id int, opts ...TagOption) ([]Tag, error)

+ func (c *Client) GetRegionalData(ctx context.Context, opts ...RegionalDataOption) (*MapData, error)

+ func (c *Client) GetRelatedTags(ctx context.Context, tagNames []string, opts ...TagOption) ([]Tag, error)

+ func (c *Client) GetRelease(ctx context.Context, id int) (*Release, error)

+ func (c *Client) GetReleaseDates(ctx context.Context, id int, opts ...ReleaseDateOption) ([]ReleaseDate, error)

+ func (c *Client) GetReleaseRelatedTags(ctx context.Context, id int, tagNames []string, opts ...TagOption) ([]Tag, error)

+ func (c *Client) GetReleaseSeries(ctx context.Context, releaseID int, opts ...SearchOption) ([]SearchResult, error)

+ func (c *Client) GetReleaseSources(ctx context.Context, id int) ([]Source, error)

+ func (c *Client) GetReleaseTables(ctx context.Context, id int, opts ...TableOption) ([]ReleaseTableElement, error)

+ func (c *Client) GetReleaseTags(ctx context.Context, id int, opts ...TagOption) ([]Tag, error)

+ func (c *Client) GetReleases(ctx context.Context, opts ...ReleaseListOption) ([]Release, error)

+ func (c *Client) GetReleasesDates(ctx context.Context, opts ...ReleaseDateOption) ([]ReleaseDate, error)

+ func (c *Client) GetSeriesAllReleases(ctx context.Context, seriesID string, opts ...ObservationOption) ([]Observation, error)

+ func (c *Client) GetSeriesAsOf(ctx context.Context, seriesID string, asOf time.Time, ...) ([]Observation, error)

+ func (c *Client) GetSeriesCategories(ctx context.Context, seriesID string) ([]Category, error)

+ func (c *Client) GetSeriesData(ctx context.Context, seriesID string, opts ...MapDataOption) (*MapData, error)

+ func (c *Client) GetSeriesFirstRelease(ctx context.Context, seriesID string, opts ...ObservationOption) ([]Observation, error)

+ func (c *Client) GetSeriesGroup(ctx context.Context, seriesID string) (*SeriesGroup, error)

+ func (c *Client) GetSeriesInfo(ctx context.Context, seriesID string) (*Series, error)

+ func (c *Client) GetSeriesObservations(ctx context.Context, seriesID string, opts ...ObservationOption) ([]Observation, error)

+ func (c *Client) GetSeriesRelease(ctx context.Context, seriesID string) (*Release, error)

+ func (c *Client) GetSeriesTags(ctx context.Context, seriesID string, opts ...TagOption) ([]Tag, error)

+ func (c *Client) GetSeriesUpdates(ctx context.Context, opts ...UpdateOption) ([]SearchResult, error)

+ func (c *Client) GetSeriesVintageDates(ctx context.Context, seriesID string, opts ...ObservationOption) ([]time.Time, error)

+ func (c *Client) GetSource(ctx context.Context, id int) (*Source, error)

+ func (c *Client) GetSourceReleases(ctx context.Context, id int, opts ...ReleaseListOption) ([]Release, error)

+ func (c *Client) GetSources(ctx context.Context, opts ...SourceOption) ([]Source, error)

+ func (c *Client) GetTags(ctx context.Context, opts ...TagOption) ([]Tag, error)

+ func (c *Client) GetTagsSeries(ctx context.Context, tagNames []string, opts ...SearchOption) ([]SearchResult, error)

+ func (c *Client) SearchSeries(ctx context.Context, text string, opts ...SearchOption) ([]SearchResult, error)

+ func (c *Client) SearchSeriesRelatedTags(ctx context.Context, text string, tagNames []string, opts ...TagOption) ([]Tag, error)

+ func (c *Client) SearchSeriesTags(ctx context.Context, text string, opts ...TagOption) ([]Tag, error)

+ type ClientOption func(*Client) error

+ func WithAPIKey(key string) ClientOption

+ func WithBaseURL(url string) ClientOption

+ func WithHTTPClient(hc *http.Client) ClientOption

+ type MapData struct

+ Data []MapDataEntry

+ Date string

+ Frequency string

+ Region string

+ Seasonality string

+ Title string

+ Units string

+ type MapDataEntry struct

+ Code string

+ Region string

+ SeriesID string

+ Value string

+ func (m *MapDataEntry) UnmarshalJSON(data []byte) error

+ type MapDataOption func(*mapDataParams)

+ func WithMapDate(d string) MapDataOption

+ func WithMapStartDate(d string) MapDataOption

+ type Observation struct

+ Date time.Time

+ IsNA bool

+ RealtimeEnd time.Time

+ RealtimeStart time.Time

+ Value float64

+ type ObservationOption func(*obsParams)

+ func WithAggregationMethod(m string) ObservationOption

+ func WithFrequency(f string) ObservationOption

+ func WithObservationEnd(t time.Time) ObservationOption

+ func WithObservationLimit(n int) ObservationOption

+ func WithObservationOffset(n int) ObservationOption

+ func WithObservationSortOrder(o SortOrder) ObservationOption

+ func WithObservationStart(t time.Time) ObservationOption

+ func WithOutputType(t int) ObservationOption

+ func WithRealtimeEnd(t time.Time) ObservationOption

+ func WithRealtimeStart(t time.Time) ObservationOption

+ func WithUnits(u string) ObservationOption

+ func WithVintageDates(dates ...string) ObservationOption

+ type OrderBy string

+ const OrderByFrequency

+ const OrderByLastUpdated

+ const OrderByObservationEnd

+ const OrderByObservationStart

+ const OrderByPopularity

+ const OrderByRealtimeEnd

+ const OrderByRealtimeStart

+ const OrderBySearchRank

+ const OrderBySeasonalAdjustment

+ const OrderBySeriesID

+ const OrderByTitle

+ const OrderByUnits

+ type RegionalDataOption func(*regionalDataParams)

+ func WithMapUnits(u string) RegionalDataOption

+ func WithRegionType(t string) RegionalDataOption

+ func WithRegionalDate(d string) RegionalDataOption

+ func WithRegionalFrequency(f string) RegionalDataOption

+ func WithSeason(s string) RegionalDataOption

+ func WithSeriesGroup(g string) RegionalDataOption

+ func WithTransformation(t string) RegionalDataOption

+ type Release struct

+ ID int

+ Link string

+ Name string

+ Notes string

+ PressRelease bool

+ type ReleaseDate struct

+ Date string

+ ReleaseID int

+ ReleaseName string

+ type ReleaseDateOption func(*releaseDateParams)

+ func WithIncludeNoData(b bool) ReleaseDateOption

+ func WithReleaseDateLimit(n int) ReleaseDateOption

+ func WithReleaseDateSortOrder(o SortOrder) ReleaseDateOption

+ type ReleaseListOption func(*releaseListParams)

+ func WithReleaseLimit(n int) ReleaseListOption

+ func WithReleaseSortOrder(o SortOrder) ReleaseListOption

+ type ReleaseTableElement struct

+ Children []ReleaseTableElement

+ ElementID int

+ Level int

+ LevelRaw string

+ Line string

+ Name string

+ ParentID int

+ ReleaseID int

+ SeriesID string

+ Type string

+ type SearchOption func(*searchParams)

+ func WithExcludeTags(tags ...string) SearchOption

+ func WithFilter(variable, value string) SearchOption

+ func WithLimit(n int) SearchOption

+ func WithOrderBy(ob OrderBy) SearchOption

+ func WithSearchType(t string) SearchOption

+ func WithSortOrder(o SortOrder) SearchOption

+ func WithTagNames(tags ...string) SearchOption

+ type SearchResult struct

+ Frequency string

+ FrequencyShort string

+ ID string

+ LastUpdated string

+ Notes string

+ ObservationEnd string

+ ObservationStart string

+ Popularity int

+ RealtimeEnd string

+ RealtimeStart string

+ SeasonalAdjustment string

+ SeasonalAdjustmentShort string

+ Title string

+ Units string

+ UnitsShort string

+ type Series struct

+ Frequency string

+ FrequencyShort string

+ ID string

+ LastUpdated string

+ Notes string

+ ObservationEnd string

+ ObservationStart string

+ Popularity int

+ RealtimeEnd string

+ RealtimeStart string

+ SeasonalAdjustment string

+ SeasonalAdjustmentShort string

+ Tags []Tag

+ Title string

+ Units string

+ UnitsShort string

+ type SeriesGroup struct

+ Frequency string

+ MaxDate string

+ MinDate string

+ RegionType string

+ Season string

+ SeriesGroup string

+ Title string

+ Units string

+ type SortOrder string

+ const SortAsc

+ const SortDesc

+ type Source struct

+ ID int

+ Link string

+ Name string

+ Notes string

+ type SourceOption func(*sourceParams)

+ func WithSourceLimit(n int) SourceOption

+ func WithSourceSortOrder(o SortOrder) SourceOption

+ type TableOption func(*tableParams)

+ func WithIncludeObservationValues(b bool) TableOption

+ func WithObservationDate(d string) TableOption

+ func WithTableElementID(id int) TableOption

+ type Tag struct

+ Created string

+ GroupID string

+ Name string

+ Notes string

+ Popularity int

+ SeriesCount int

+ type TagOption func(*tagParams)

+ func WithTagGroupID(g string) TagOption

+ func WithTagLimit(n int) TagOption

+ func WithTagOrderBy(ob OrderBy) TagOption

+ func WithTagSearchText(text string) TagOption

+ func WithTagSetExclude(tags ...string) TagOption

+ func WithTagSetNames(tags ...string) TagOption

+ func WithTagSortOrder(o SortOrder) TagOption

+ type UpdateOption func(*updateParams)

+ func WithEndTime(s string) UpdateOption

+ func WithFilterValue(v string) UpdateOption

+ func WithStartTime(s string) UpdateOption

+ func WithUpdateLimit(n int) UpdateOption