mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 15:09:42 +00:00
ba92ba3254
* docs: Create new CODING_GUIDELINES doc Rids excess contribution instructions from other packages Adds AGENTS.md file for the AI overlords Rids unused templates Updates ADD_NEW_EXCHANGE.md with minor fixes * docs: Fix linter issues and minor adjustments based on Copilot feedback * docs: Update coding guidelines for API parameters and testing practices * docs: Remove redundant GoDoc references Adds copilot-instructions.md * docs: Update CODING_GUIDELINES with export recommendations and test commentary * docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links * docs: Update struct naming conventions for request and response types * docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md * refactor: Simplify error handling in QueryOrder method
112 lines
3.6 KiB
Markdown
112 lines
3.6 KiB
Markdown
# GoCryptoTrader dbseed tool
|
|
|
|
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
|
|
|
|
|
|
[](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml)
|
|
[](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
|
|
[](https://godoc.org/github.com/thrasher-corp/gocryptotrader/portfolio)
|
|
[](https://codecov.io/gh/thrasher-corp/gocryptotrader)
|
|
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
|
|
|
|
|
This dbseed tool 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](https://github.com/orgs/thrasher-corp/projects/3).
|
|
|
|
Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/zt-38z8abs3l-gH8AAOk8XND6DP5NfCiG_g)
|
|
|
|
## How to use
|
|
|
|
#### Prerequisites
|
|
##### Configuration
|
|
|
|
dbseed requires a valid database configuration in your gocryptotrader config
|
|
|
|
```sh
|
|
"database": {
|
|
"enabled": true,
|
|
"verbose": true,
|
|
"driver": "postgres",
|
|
"connectionDetails": {
|
|
"host": "localhost",
|
|
"port": 5432,
|
|
"username": "gct-dev",
|
|
"password": "gct-dev",
|
|
"database": "gct-dev",
|
|
"sslmode": "disable"
|
|
}
|
|
},
|
|
```
|
|
|
|
By default this will load from the default GoCryptoTrader path
|
|
|
|
For Windows users this is:
|
|
```%APPDATA%\GoCryptoTrader```
|
|
|
|
For Linux/macOS users this is:
|
|
```$HOME\.gocryptotrader```
|
|
|
|
and can be overridden with the ```-config``` flag
|
|
|
|
``` --config value config file to load (default: "~/.gocryptotrader/config.json")```
|
|
|
|
#### Usage
|
|
|
|
#### Sub Commands
|
|
##### candle
|
|
```
|
|
file seed candle data from a file
|
|
help, h Shows a list of commands or help for one command
|
|
```
|
|
##### command examples
|
|
```
|
|
dbseed candle file --exchange=binance --base=BTC --quote=USDT --interval=86400 --asset=spot --filename=../../testdata/binance_BTCUSDT_24h_2019_01_01_2020_01_01.csv
|
|
```
|
|
File structure for import contains the following rows with no headers:
|
|
|
|
```
|
|
timestamp, volume, open, high, low, close
|
|
```
|
|
An example of this is:
|
|
```
|
|
1546300800,23741.687033,3701.23,3797.14,3642,3797.14
|
|
1546387200,35156.463369,3796.45,3858.56,3750.45,3858.56
|
|
1546473600,29406.948359,3857.57,3766.78,3730,3766.78
|
|
1546560000,29519.554671,3767.2,3792.01,3703.57,3792.01
|
|
1546646400,30490.667751,3790.09,3770.96,3751,3770.96
|
|
```
|
|
##### exchange
|
|
```
|
|
file seed exchange data from a file
|
|
add add a single exchange
|
|
default seed exchange from default list
|
|
```
|
|
##### command examples
|
|
```
|
|
dbseed exchange add --name=newexchange
|
|
dbseed exchange file --filename=../../testdata/exchangelist.csv
|
|
dbseed exchange default
|
|
```
|
|
|
|
File structure for importing contains the following rows with no headers:
|
|
```
|
|
exchange
|
|
```
|
|
An example of this is:
|
|
```
|
|
binance,
|
|
btc markets,
|
|
```
|
|
|
|
## Donations
|
|
|
|
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/donate.png?raw=true" hspace="70">
|
|
|
|
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
|
|
|
|
***bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc***
|
|
|