Skip to content

cmd/exchange_template: Update wrapper template, improve documentation #2009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

cmd/exchange_template: Update wrapper template, improve documentation #2009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9716e17
Updating wrapper template, updating documentation, regenerating docum…
cranktakular Aug 19, 2025
b24be60
Renaming "streaming api" to "websocket"
cranktakular Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions CONTRIBUTORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ ermalguni | https://github.com/ermalguni
MadCozBadd | https://github.com/MadCozBadd
vadimzhukck | https://github.com/vadimzhukck
junnplus | https://github.com/junnplus
geseq | https://github.com/geseq
marcofranssen | https://github.com/marcofranssen
140am | https://github.com/140am
marcofranssen | https://github.com/marcofranssen
geseq | https://github.com/geseq
TaltaM | https://github.com/TaltaM
cranktakular | https://github.com/cranktakular
dackroyd | https://github.com/dackroyd
khcchiu | https://github.com/khcchiu
yangrq1018 | https://github.com/yangrq1018
crackcomm | https://github.com/crackcomm
romanornr | https://github.com/romanornr
woshidama323 | https://github.com/woshidama323
Copilot | https://github.com/apps/copilot-swe-agent
woshidama323 | https://github.com/woshidama323
romanornr | https://github.com/romanornr
crackcomm | https://github.com/crackcomm
mshogin | https://github.com/mshogin
herenow | https://github.com/herenow
tk42 | https://github.com/tk42
Expand All @@ -40,11 +40,12 @@ azhang | https://github.com/azhang
andreygrehov | https://github.com/andreygrehov
bretep | https://github.com/bretep
Christian-Achilli | https://github.com/Christian-Achilli
MarkDzulko | https://github.com/MarkDzulko
dsinuela-taurus | https://github.com/dsinuela-taurus
cornelk | https://github.com/cornelk
gam-phon | https://github.com/gam-phon
MarkDzulko | https://github.com/MarkDzulko
mortensorensen | https://github.com/mortensorensen
cornelk | https://github.com/cornelk
aidan-bailey | https://github.com/aidan-bailey
Polizo96 | https://github.com/Polizo96
cavapoo2 | https://github.com/cavapoo2
tongxiaofeng | https://github.com/tongxiaofeng
tonywangcn | https://github.com/tonywangcn
Expand All @@ -57,15 +58,15 @@ shoman4eg | https://github.com/shoman4eg
cangqiaoyuzhuo | https://github.com/cangqiaoyuzhuo
gcmutator | https://github.com/gcmutator
gopherorg | https://github.com/gopherorg
yuhangcangqian | https://github.com/yuhangcangqian
whilei | https://github.com/whilei
xiiiew | https://github.com/xiiiew
phieudu241 | https://github.com/phieudu241
snipesjr | https://github.com/snipesjr
snussik | https://github.com/snussik
taewdy | https://github.com/taewdy
threehonor | https://github.com/threehonor
aidan-bailey | https://github.com/aidan-bailey
xiiiew | https://github.com/xiiiew
youzichuan | https://github.com/youzichuan
yuhangcangqian | https://github.com/yuhangcangqian
antonzhukov | https://github.com/antonzhukov
blombard | https://github.com/blombard
CodeLingoBot | https://github.com/CodeLingoBot
Expand All @@ -89,5 +90,6 @@ mattkanwisher | https://github.com/mattkanwisher
mgravitt | https://github.com/mgravitt
mKurrels | https://github.com/mKurrels
m1kola | https://github.com/m1kola
mortensorensen | https://github.com/mortensorensen
idoall | https://github.com/idoall
starit | https://github.com/starit
34 changes: 18 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader

## Exchange Support Table

| Exchange | REST API | Streaming API | FIX API |
| Exchange | REST API | Websocket | FIX API |
|----------|------|-----------|-----|
| Binance.US| Yes | Yes | NA |
| Binance| Yes | Yes | NA |
Expand Down Expand Up @@ -150,11 +150,11 @@ Binaries will be published once the codebase reaches a stable condition.

|User|Contribution Amount|
|--|--|
| [thrasher-](https://github.com/thrasher-) | 731 |
| [dependabot[bot]](https://github.com/apps/dependabot) | 386 |
| [shazbert](https://github.com/shazbert) | 374 |
| [thrasher-](https://github.com/thrasher-) | 733 |
| [dependabot[bot]](https://github.com/apps/dependabot) | 391 |
| [shazbert](https://github.com/shazbert) | 377 |
| [gloriousCode](https://github.com/gloriousCode) | 237 |
| [gbjk](https://github.com/gbjk) | 133 |
| [gbjk](https://github.com/gbjk) | 134 |
| [dependabot-preview[bot]](https://github.com/apps/dependabot-preview) | 88 |
| [xtda](https://github.com/xtda) | 47 |
| [lrascao](https://github.com/lrascao) | 27 |
Expand All @@ -167,18 +167,18 @@ Binaries will be published once the codebase reaches a stable condition.
| [MadCozBadd](https://github.com/MadCozBadd) | 13 |
| [vadimzhukck](https://github.com/vadimzhukck) | 10 |
| [junnplus](https://github.com/junnplus) | 9 |
| [geseq](https://github.com/geseq) | 8 |
| [marcofranssen](https://github.com/marcofranssen) | 8 |
| [140am](https://github.com/140am) | 8 |
| [marcofranssen](https://github.com/marcofranssen) | 8 |
| [geseq](https://github.com/geseq) | 8 |
| [TaltaM](https://github.com/TaltaM) | 6 |
| [cranktakular](https://github.com/cranktakular) | 6 |
| [dackroyd](https://github.com/dackroyd) | 5 |
| [khcchiu](https://github.com/khcchiu) | 5 |
| [yangrq1018](https://github.com/yangrq1018) | 4 |
| [crackcomm](https://github.com/crackcomm) | 3 |
| [romanornr](https://github.com/romanornr) | 3 |
| [Copilot](https://github.com/apps/copilot-swe-agent) | 4 |
| [woshidama323](https://github.com/woshidama323) | 3 |
| [Copilot](https://github.com/apps/copilot-swe-agent) | 3 |
| [romanornr](https://github.com/romanornr) | 3 |
| [crackcomm](https://github.com/crackcomm) | 3 |
| [mshogin](https://github.com/mshogin) | 2 |
| [herenow](https://github.com/herenow) | 2 |
| [tk42](https://github.com/tk42) | 2 |
Expand All @@ -190,11 +190,12 @@ Binaries will be published once the codebase reaches a stable condition.
| [andreygrehov](https://github.com/andreygrehov) | 2 |
| [bretep](https://github.com/bretep) | 2 |
| [Christian-Achilli](https://github.com/Christian-Achilli) | 2 |
| [MarkDzulko](https://github.com/MarkDzulko) | 2 |
| [dsinuela-taurus](https://github.com/dsinuela-taurus) | 2 |
| [cornelk](https://github.com/cornelk) | 2 |
| [gam-phon](https://github.com/gam-phon) | 2 |
| [MarkDzulko](https://github.com/MarkDzulko) | 2 |
| [mortensorensen](https://github.com/mortensorensen) | 1 |
| [cornelk](https://github.com/cornelk) | 2 |
| [aidan-bailey](https://github.com/aidan-bailey) | 1 |
| [Polizo96](https://github.com/Polizo96) | 1 |
| [cavapoo2](https://github.com/cavapoo2) | 1 |
| [tongxiaofeng](https://github.com/tongxiaofeng) | 1 |
| [tonywangcn](https://github.com/tonywangcn) | 1 |
Expand All @@ -207,15 +208,15 @@ Binaries will be published once the codebase reaches a stable condition.
| [cangqiaoyuzhuo](https://github.com/cangqiaoyuzhuo) | 1 |
| [gcmutator](https://github.com/gcmutator) | 1 |
| [gopherorg](https://github.com/gopherorg) | 1 |
| [yuhangcangqian](https://github.com/yuhangcangqian) | 1 |
| [whilei](https://github.com/whilei) | 1 |
| [xiiiew](https://github.com/xiiiew) | 1 |
| [phieudu241](https://github.com/phieudu241) | 1 |
| [snipesjr](https://github.com/snipesjr) | 1 |
| [snussik](https://github.com/snussik) | 1 |
| [taewdy](https://github.com/taewdy) | 1 |
| [threehonor](https://github.com/threehonor) | 1 |
| [aidan-bailey](https://github.com/aidan-bailey) | 1 |
| [xiiiew](https://github.com/xiiiew) | 1 |
| [youzichuan](https://github.com/youzichuan) | 1 |
| [yuhangcangqian](https://github.com/yuhangcangqian) | 1 |
| [antonzhukov](https://github.com/antonzhukov) | 1 |
| [blombard](https://github.com/blombard) | 1 |
| [CodeLingoBot](https://github.com/CodeLingoBot) | 1 |
Expand All @@ -239,5 +240,6 @@ Binaries will be published once the codebase reaches a stable condition.
| [mgravitt](https://github.com/mgravitt) | 1 |
| [mKurrels](https://github.com/mKurrels) | 1 |
| [m1kola](https://github.com/m1kola) | 1 |
| [mortensorensen](https://github.com/mortensorensen) | 1 |
| [idoall](https://github.com/idoall) | 1 |
| [starit](https://github.com/starit) | 1 |
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/binance.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/binanceus.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/bitfinex.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/bitflyer.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/bithumb.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/bitmex.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/bitstamp.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/btcmarkets.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/btse.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/bybit.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := b.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/coinbasepro.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := c.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/coinut.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := c.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/deribit.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := d.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/exmo.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := e.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/gateio.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := g.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/gemini.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := g.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/hitbtc.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := h.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/huobi.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := h.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/kraken.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := k.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/lbank.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := l.Trade(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/okx.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ if err != nil {
// Private calls - make sure your APIKEY and APISECRET are set and
// AuthenticatedAPISupport is set to true

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
orderID, err := ok.SubmitOrder(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/poloniex.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := p.PlaceOrder(...)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/exchanges_templates/yobit.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ if err != nil {
// Handle error
}

// Submits an order and the exchange and returns its tradeID
// Submits an order to the exchange and returns its tradeID
tradeID, err := y.Trade("BTCUSD", "MARKET", 1, 2)
if err != nil {
// Handle error
Expand Down
2 changes: 1 addition & 1 deletion cmd/documentation/root_templates/root_readme.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader

## Exchange Support Table

| Exchange | REST API | Streaming API | FIX API |
| Exchange | REST API | Websocket | FIX API |
|----------|------|-----------|-----|
| Binance.US| Yes | Yes | NA |
| Binance| Yes | Yes | NA |
Expand Down
8 changes: 4 additions & 4 deletions cmd/exchange_template/wrapper.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,14 @@ func (e *Exchange) SetDefaults() {

fmt1 := currency.PairStore{
AssetEnabled: true,
RequestFormat: &currency.PairFormat{Uppercase: true},
ConfigFormat: &currency.PairFormat{Uppercase: true},
RequestFormat: &currency.PairFormat{Uppercase: true, Delimiter: "_"},
ConfigFormat: &currency.PairFormat{Uppercase: true, Delimiter: "_"},
}

fmt2 := currency.PairStore{
AssetEnabled: true,
RequestFormat: &currency.PairFormat{Uppercase: true},
ConfigFormat: &currency.PairFormat{Uppercase: true, Delimiter: ":"},
RequestFormat: &currency.PairFormat{Uppercase: true, Delimiter: "-"},
ConfigFormat: &currency.PairFormat{Uppercase: true, Delimiter: "_"},
}

if err := e.SetAssetPairStore(asset.Spot, fmt1); err != nil {
Expand Down
Loading
Loading