ticker

README

go-exchange-api

A GoLang API for popular crypto-currency exchanges and a set of command line utilities.

[work in progress]

Documentation

Overview

Package ticker defines common interfaces, constants and utility functions for all exchange clients

Package ticker defines common interfaces, constants and utility functions for all exchange clients

Index

• type Command
• type Connector
• type Exchanger
• type State
  • func (s State) String() string
• type Status
• type Ticker
• type Trade
• type TradeType
  • func ParseTradeType(typ string) (TradeType, error)
  • func (typ TradeType) String() string
• type Trader

Types

type Command

type Command byte

type Connector

type Connector interface {
	GetURL() string
	GetName() string
	GetStatus() Status
	Connect(key string) (<-chan Status, error)
	Disconnect() error
}

type Exchanger

type Exchanger interface {
	Connector
	Ticker
	Trader
}

type State

type State byte

const (
	// states
	DISCONNECTED State = iota
	CONNECTING
	CONNECTED
	WAITING
)

func (State) String

func (s State) String() string

type Status

type Status struct {
	State State
	Error error
}

type Ticker

type Ticker interface {
	Subscribe([]string) (<-chan *Trade, error)
	Unsubscribe([]string) error
}

type Trade

type Trade struct {
	Time   time.Time
	Pair   string
	Type   TradeType
	Amount float64
	Price  float64
}

type TradeType

type TradeType byte

const (
	UNK_TRADE TradeType = 0
	BID       TradeType = 1
	SELL      TradeType = 1
	ASK       TradeType = 2
	BUY       TradeType = 2
)

func ParseTradeType

func ParseTradeType(typ string) (TradeType, error)

func (TradeType) String

func (typ TradeType) String() string

type Trader

type Trader interface {
}