# README

Contributors Forks Stargazers Issues MIT License

QuantstopExchange

Go library for crypto currency and stock market exchanges.


About The Project

Building financial applications is hard.
QuantstopExchange, abbreviated as qsx, provides a simple way to interact with many exchanges, and ensure a common data structure.

Getting Started

Import the quantstopexchange factory, the core library, and any vendor exchanges you wish to use:

import (
    "github.com/quantstop/quantstopexchange"
    "github.com/quantstop/quantstopterminal/pkg/quantstopexchange/qsx"
    "github.com/quantstop/quantstopterminal/pkg/quantstopexchange/vendors/coinbasepro"
)

Create an exchange object:
Authentication is only needed for operations that require it.
You may leave the fields empty as blank input strings.

config := &qsx.Config{
    Auth:    qsx.NewAuth("key", "pass", "secret"),
    Sandbox: true,
}
coinbasepro, err := quantstopexchange.NewExchange(qsx.CoinbasePro, config)
if err != nil {
    // handle error
}

Use the exchange object to perform an action:

candles, err := coinbasepro.GetHistoricalCandles(context.TODO(), "BTC-USD", "1m")
if err != nil {
    // handle error
}
for _, candle := range candles {
    fmt.Println(fmt.Sprintf("Close: %v", candle.Close))
}

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See the full LICENSE for more information.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

GetSupportedExchanges returns a list of all the supported exchanges.
NewExchange creates an exchange connection and returns a struct that implements the IExchange interface.