Documentation
¶
Overview ¶
Package imf is the library behind the imf command line: the HTTP client, request shaping, and the typed data models for the IMF DataMapper API.
The Client here is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public site throws under load. Build your endpoint calls and JSON decoding on top of it.
Index ¶
- Constants
- type Client
- func (c *Client) FetchData(ctx context.Context, indicator, country, periods string) ([]*DataPoint, error)
- func (c *Client) Get(ctx context.Context, url string) ([]byte, error)
- func (c *Client) ListCountries(ctx context.Context) ([]*Country, error)
- func (c *Client) ListIndicators(ctx context.Context) ([]*Indicator, error)
- type Country
- type DataPoint
- type Domain
- type Indicator
Constants ¶
const BaseURL = "https://" + Host + "/external/datamapper/api/v1"
BaseURL is the root every request is built from.
const DefaultUserAgent = "imf-cli/dev (+https://github.com/tamnd/imf-cli)"
DefaultUserAgent identifies the client to the IMF API.
const Host = "www.imf.org"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
// Rate is the minimum gap between requests. Zero means no pacing.
Rate time.Duration
Retries int
// contains filtered or unexported fields
}
Client talks to the IMF DataMapper API over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 500ms minimum gap between requests (IMF is picky), and five retries on transient errors.
func (*Client) FetchData ¶
func (c *Client) FetchData(ctx context.Context, indicator, country, periods string) ([]*DataPoint, error)
FetchData fetches data points for indicator. If country is non-empty, only that country's data is fetched. periods is an optional comma-separated list of years to filter by (appended as ?periods=...).
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings. The caller owns nothing extra; the body is read fully and closed here.
func (*Client) ListCountries ¶
ListCountries fetches all country/region codes and labels.
type DataPoint ¶
type DataPoint struct {
Indicator string `kit:"id" json:"indicator"`
Country string `json:"country"`
Year string `json:"year"`
Value float64 `json:"value"`
}
DataPoint is one value: the reading for a given indicator, country and year.
type Domain ¶
type Domain struct{}
Domain is the imf driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify turns any accepted input into the canonical (type, id). Uppercase codes like "NGDP_RPCH" are indicators; 3-letter uppercase codes like "USA" are countries.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.
Source Files