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

# README

GoCryptoTrader package Trade

Build Status Software License GoDoc Coverage Status Go Report Card

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

  • The trade package contains a processor for both REST and websocket trade history processing
    • Its primary purpose is to collect trade data from multiple sources and save it to the database's trade table
    • If you do not have database enabled, then trades will not be processed

Requirements to save a trade to the database

  • Database has to be enabled
  • Under config.json, under your selected exchange, enable the field saveTradeData
    • This will enable trade processing to occur for that specific exchange
    • This can also be done via gRPC under the SetExchangeTradeProcessing command

Usage

  • To send trade data to be processed, use the following example:
err := trade.AddTradesToBuffer(b.Name, trade.Data{
    Exchange:     b.Name,
    TID:          strconv.FormatInt(tradeData[i].TID, 10),
    CurrencyPair: p,
    AssetType:    assetType,
    Side:         side,
    Price:        tradeData[i].Price,
    Amount:       tradeData[i].Amount,
    Timestamp:    tradeTS,
})

b in this context is an IBotExchange implemented struct

Rules

  • If the trade processor has not started, it will automatically start upon being sent trade data.
  • The processor will add all received trades to a buffer
  • After 15 seconds, the trade processor will parse and save all trades on the buffer to the trade table
    • This is to save on constant writing to the database. Trade data, especially when received via websocket would cause massive issues on the round trip of saving data for every trade
  • If the processor has not received any trades in that 15 second timeframe, it will shut down.
    • Sending trade data to it later will automatically start it up again

Exchange Support Table

ExchangeRecent Trades via RESTLive trade updates via WebsocketTrade history via REST
AlphapointNoNoNo
Binance.USYesYesNA
BinanceYesYesYes
BitfinexYesYesYes
BitflyerYesNoNo
BithumbYesYesNo
BitMEXYesYesYes
BitstampYesYesNo
BTCMarketsYesYesNo
BTSEYesYesNo
BybitYesYesYes
CoinbaseProYesYesNo
COINUTYesYesNo
DeribitYesYesYes
ExmoYesNANo
GateIOYesYesNo
GeminiYesYesYes
HitBTCYesYesYes
Huobi.ProYesYesNo
KrakenYesYesNo
KucoinYesNoYes
LbankYesNoYes
OkxYesYesYes
PoloniexYesYesYes
YobitYesNANo

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

AddTradesToBuffer will push trade data onto the buffer.
ConvertTradesToCandles turns trade data into kline.Items.
FilterTradesByTime removes any trades that are not between the start and end times.
GetTradesInRange calls db function to return trades in range to minimise tradesql package usage.
HasTradesInRanges Creates an executes an SQL query to verify if a trade exists within a timeframe.
SaveTradesToDatabase converts trades and saves results to database.
SQLDataToTrade converts sql data to glorious trade data.

# Constants

DefaultProcessorIntervalTime is the default timer to process queued trades and save them to the database.

# Variables

BufferProcessorIntervalTime is the interval to save trade buffer data to the database.
ErrNoTradesSupplied is returned when an attempt is made to process trades, but is an empty slice.

# Structs

Data defines trade data.
Processor used for processing trade data in batches and saving them to the database.
Trade used to hold data and methods related to trade dissemination and storage.

# Type aliases

ByDate sorts trades by date ascending.