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

# README

GoCryptoTrader package Stats

Build Status Software License GoDoc Coverage Status Go Report Card

This stats 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 stats

  • This stats package services the exchanges package by providing stats on enabled exchanges i.e.
    • Sort by largest volume
    • Sort by best price for currency
    • Others will be added soon

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

Add adds or updates the Item stats.
AlreadyExists checks to see if Item info already exists for a specific currency pair and asset type.
Append adds the Item stats for a specific currency pair and asset type if it doesn't exist.
SortExchangesByPrice sorts Item info by volume for a specific currency pair and asset type.
SortExchangesByVolume sorts Item info by volume for a specific currency pair and asset type.

# Structs

Item holds various fields for storing currency pair stats.