Documentation
¶
Overview ¶
Package erapi is the library behind the erapi command line: the HTTP client, request shaping, and the typed data models for the ExchangeRate-API (open.er-api.com).
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 API throws under load.
Index ¶
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "erapi/dev (+https://github.com/tamnd/erapi-cli)"
DefaultUserAgent identifies the client to ExchangeRate-API.
const Host = "open.er-api.com"
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 open.er-api.com over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 1s minimum gap between requests, and five retries on transient errors.
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) GetConversion ¶
func (c *Client) GetConversion(ctx context.Context, base, target string, amount float64) (*Conversion, error)
GetConversion fetches the rate for base→target and computes amount * rate.
type Conversion ¶
type Conversion struct {
Base string `kit:"id" json:"base"`
Target string `json:"target"`
Amount float64 `json:"amount"`
Result float64 `json:"result"`
Rate float64 `json:"rate"`
UpdatedAt string `json:"updated_at"`
}
Conversion records an amount converted from one currency to another.
type Domain ¶
type Domain struct{}
Domain is the erapi driver. It carries no state; the per-run client is built by the factory Register hands kit.
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