nbpapi

Documentation

Index

• Variables
• type Client
  • func Init(client httpClient) *Client
  • func (c *Client) Get(curr string, day time.Time) (*Rates, error)
• type DailyRate
• type ErrApiCallUnsuccessful
  • func (e ErrApiCallUnsuccessful) Error() string
• type Rates

Variables

var ErrNoExchangeRateForGivenDay = errors.New("no exchange rate for given date")

ErrNoExchangeRateForGivenDay represents a failure where there are no published rates for a given day

var ErrNoRatesForCurrency = errors.New("currency without published rates")

ErrNoRatesForCurrency represents a failure where NBP doesn't publish exchange rates for the given currency

Types

type Client

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

Client is a low-level client over the NBP rates API

func Init

func Init(client httpClient) *Client

Init returns *Rates instance with net/http.DefaultClient

func (*Client) Get

func (c *Client) Get(curr string, day time.Time) (*Rates, error)

Get returns the currency exchange rate for a given date from NBP table A

type DailyRate

type DailyRate struct {
	No            string          `json:"no"`
	EffectiveDate string          `json:"effectiveDate"`
	Mid           decimal.Decimal `json:"mid"`
}

DailyRate represent a rate for a single day

type ErrApiCallUnsuccessful

type ErrApiCallUnsuccessful struct {
	Code int
	Body string
}

ErrApiCallUnsuccessful represents a generic unsuccessful API call

func (ErrApiCallUnsuccessful) Error

func (e ErrApiCallUnsuccessful) Error() string

type Rates

type Rates struct {
	Table    string      `json:"table"`
	Currency string      `json:"currency"`
	Code     string      `json:"code"`
	Rates    []DailyRate `json:"rates"`
}

Rates represents the return value of the NBP rates API