poloniex

Documentation

Index

• Constants
• func History(ctx context.Context, req HistoryRequest, results chan<- []*order.Trade) (err error)
• type HistoryRequest
• type Stream
  • func NewStream() (stream *Stream, err error)
  • func (stream *Stream) Close() (err error)
  • func (stream *Stream) Errors() <-chan error
  • func (stream *Stream) Events() <-chan *orderbook.Event
  • func (stream *Stream) Subscribe(pair *currency.Pair) error

Examples

• History

Constants

const (
	// WebsocketAddress - Poloniex Websocket address.
	WebsocketAddress = "wss://api.poloniex.com"

	// WebsocketRealm - Poloniex Websocket realm name.
	WebsocketRealm = "realm1"
)

Functions

func History

func History(ctx context.Context, req HistoryRequest, results chan<- []*order.Trade) (err error)

History - Reads trades history from start to end. Results channel will be closed by this function.

Example

ctx, cancel := context.WithTimeout(context.Background(), time.Hour)
defer cancel()

req := HistoryRequest{
	Pair:  currency.NewPair("BTC", "XRP"),
	Start: time.Now().Add(-time.Hour * 24),
	End:   time.Now(),
}

// Create results channel
results := make(chan []*order.Trade, 10)

// Get all trades in goroutine
go func() {
	if err := History(ctx, req, results); err != nil {
		glog.Fatal(err)
	}
}()

for {
	select {
	case <-ctx.Done():
		if err := ctx.Err(); err != nil {
			glog.Fatal(err)
		}
		break
	case trades := <-results:
		pp.Println(trades[:10])
		return
	}
}

Types

type HistoryRequest

type HistoryRequest struct {
	Pair  *currency.Pair
	Start time.Time
	End   time.Time
}

HistoryRequest - Trades history request.

type Stream

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

Stream - Poloniex stream.

func NewStream

func NewStream() (stream *Stream, err error)

NewStream - Creates a new connected poloniex stream.

func (*Stream) Close

func (stream *Stream) Close() (err error)

Close - Closes a stream.

func (*Stream) Errors

func (stream *Stream) Errors() <-chan error

Errors - Channel of errors.

func (*Stream) Events

func (stream *Stream) Events() <-chan *orderbook.Event

Events - Channel of orderbook.

func (*Stream) Subscribe

func (stream *Stream) Subscribe(pair *currency.Pair) error

Subscribe - Sends subscription to the server. Stores subscription pair in local memory, in case of disconnection it will re-subscribe.