tradingview

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 19, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

README

tradingview-scraper

Get any market data in real time from the TradingView socket :) Ready to use in your Golang projects!

Inspired by https://github.com/imxeno/tradingview-scraper, I decided to create my own implementation of the TradingView socket using Go

Installation

go get github.com/marcos-gonalons/tradingview-scraper

How to use

Call the Connect() function passing 2 callback functions; one callback for when new market data is read from the socket, and another one used if an error happens while the connection is active

import socket "github.com/marcos-gonalons/tradingview-scraper"

func main() {
    tradingviewsocket, err := socket.Connect(
        func(symbol string, data *socket.QuoteData) {
            fmt.Printf("%#v", symbol)
            fmt.Printf("%#v", data)
        },
        func(err error) {
            fmt.Printf("%#v", "error"+err.Error())
        },
    )
    if err != nil {
        panic("Error while initializing the trading view socket -> " + err.Error())
    }
}

How to add / remove symbols

The implementation allows you to listen for any market data changes, in real time, for any market available in TradingView. In order to tell the socket the symbols (markets) that we want to get the data from, we need to call socket.AddSymbol(), after the connection is stablished.

tradingviewsocket.AddSymbol("OANDA:EURUSD")
tradingviewsocket.AddSymbol("BITSTAMP:BTCUSD")
// etc etc

The syntax for the symbol needs to be broker or exchange name:market. Everytime the socket receives new data from those markets, it will call your callback function.

If you want to stop receiving updates from a particular market, just call RemoveSymbol()

   tradingviewsocket.RemoveSymbol("OANDA:EURUSD")

Callback function

The callback function has 2 parameters; the symbol (market) name, and the data. The data is a struct with these parameters: Price, Volume, Bid, Ask

callbackFn := func(symbol string, data *socket.QuoteData) {
    fmt.Printf("%#v", symbol)
    fmt.Printf("%#v", data)
    if data.Price != nil {
        fmt.Printf("%#v", "Price has changed")
    }
    if data.Volume != nil {
        fmt.Printf("%#v", "Volume has changed")
    }
    if data.Bid != nil {
        fmt.Printf("%#v", "Bid has changed")
    }
    if data.Ask != nil {
        fmt.Printf("%#v", "Ask has changed")
    }
}

Everytime new data is received from the socket, it will call your callback function. This means that not always all the parameters will be available; sometimes, only the bid changes, or only the price changes, or only the volume, or a combination of any of those. The ones that did not change will be nil, since all of them are pointers to float64.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetRandomString

func GetRandomString(length int) string

GetRandomString ...

Types

type Flags

type Flags struct {
	Flags []string `json:"flags"`
}

Flags ...

type QuoteData

type QuoteData struct {
	Price  *float64 `mapstructure:"lp"`
	Volume *float64 `mapstructure:"volume"`
	Bid    *float64 `mapstructure:"bid"`
	Ask    *float64 `mapstructure:"ask"`
}

QuoteData ...

type QuoteMessage

type QuoteMessage struct {
	Symbol string     `mapstructure:"n"`
	Status string     `mapstructure:"s"`
	Data   *QuoteData `mapstructure:"v"`
}

QuoteMessage ...

type Socket

type Socket struct {
	OnReceiveMarketDataCallback func(symbol string, data *QuoteData)
	OnErrorCallback             func(error)
	// contains filtered or unexported fields
}

Socket ...

func (*Socket) AddSymbol

func (s *Socket) AddSymbol(symbol string) (err error)

AddSymbol ...

func (*Socket) Close

func (s *Socket) Close() (err error)

Close ...

func (*Socket) Init

func (s *Socket) Init() (err error)

Init connects to the tradingview web socket

func (*Socket) RemoveSymbol

func (s *Socket) RemoveSymbol(symbol string) (err error)

RemoveSymbol ...

type SocketInterface

type SocketInterface interface {
	AddSymbol(symbol string) error
	RemoveSymbol(symbol string) error
	Init() error
	Close() error
}

SocketInterface ...

func Connect

func Connect(
	onReceiveMarketDataCallback func(symbol string, data *QuoteData),
	onErrorCallback func(error),
) (socket SocketInterface, err error)

Connect - Connects and returns the trading view socket object

type SocketMessage

type SocketMessage struct {
	Message string      `json:"m"`
	Payload interface{} `json:"p"`
}

SocketMessage ...

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL