ticker

Documentation

Index

• Constants
• type Request
  • func (req *Request) Method() string
  • func (req *Request) Payload() []byte
  • func (req *Request) Query() string
• type Response

Constants

const (
	APIPath string = "/v1/getticker"
)

Types

type Request

type Request struct {
	ProductCode markets.ProductCode `json:"product_code" url:"product_code"`
}

func (*Request) Method

func (req *Request) Method() string

func (*Request) Payload

func (req *Request) Payload() []byte

func (*Request) Query

func (req *Request) Query() string

type Response

type Response struct {
	ProductCode markets.ProductCode `json:"product_code"`

	Timestamp       string  `json:"timestamp"` // TODO: Treat timestamp as time.Time
	TickID          int     `json:"tick_id"`
	BestBid         float64 `json:"best_bid"`
	BestAsk         float64 `json:"best_ask"`
	BestBidSize     float64 `json:"best_bid_size"`
	BestAskSize     float64 `json:"best_ask_size"`
	TotalBidDepth   float64 `json:"total_bid_depth"`
	TotalAskDepth   float64 `json:"total_ask_depth"`
	LTP             float64 `json:"ltp"`
	Volume          float64 `json:"volume"`
	VolumeByProduct float64 `json:"volume_by_product"`
}