package
0.0.0-20250311023717-5c21e974eed8
Repository: https://github.com/thrasher-corp/gocryptotrader.git
Documentation: pkg.go.dev

# README

GoCryptoTrader package Ticker

Build Status Software License GoDoc Coverage Status Go Report Card

This ticker package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on our GoCryptoTrader Kanban board.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Current Features for ticker

  • This services the exchanges package by ticker functions.

  • This package facilitates ticker generation.

  • Attaches methods to an ticker

    • Returns a string of a value
  • Gets a loaded ticker by exchange, asset type and currency pair.

  • This package is primarily used in conjunction with but not limited to the exchange interface system set by exchange wrapper orderbook functions in "exchange"_wrapper.go.

Examples below:

tick, err := yobitExchange.UpdateTicker(...)
if err != nil {
	// Handle error
}

// Converts ticker value to string
tickerValString := tick.PriceToString(...)
  • or if you have a routine setting an exchange orderbook you can access it via the package itself.
tick, err := ticker.GetTicker(...)
if err != nil {
	// Handle error
}

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc

# Functions

FindLast searches for a currency pair and returns the first available.
GetExchangeTickers returns all tickers for a given exchange.
GetTicker checks and returns a requested ticker if it exists.
ProcessTicker processes incoming tickers, creating or updating the Tickers list.
SubscribeTicker subscribes to a ticker and returns a communication channel to stream new ticker updates.
SubscribeToExchangeTickers subscribes to all tickers on an exchange.

# Variables

Public errors.
Public errors.
Public errors.

# Structs

Price struct stores the currency pair and pricing information.
Service holds ticker information for each individual exchange.
Ticker struct holds the ticker information for a currency pair and type.