From 043ecddc7aa0487e8cc405b0fb0e020b4b7e9e98 Mon Sep 17 00:00:00 2001 From: Sidharthan Chandrasekaran Kamaraj Date: Sat, 17 Sep 2022 09:37:13 +0200 Subject: [PATCH 1/4] add main code example in readme and examples --- README.md | 37 +++++++++++++++++++ examples/get-client/get_client_example.go | 45 +++++++++++++++++++++++ 2 files changed, 82 insertions(+) create mode 100644 examples/get-client/get_client_example.go diff --git a/README.md b/README.md index 1b63d9d..a42b9f3 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,43 @@ This Project is under active development. Please feel free to contribute. go get -u github.com/cksidharthan/go-bybit ``` +## Example +```go +func main() { + client := rest.NewRestClient(bybit.BybitTestnetBaseURL, os.Getenv("BYBIT_API_KEY"), os.Getenv("BYBIT_API_SECRET")) + + // Get spot market client + spotClient := client.Spot() + // Get linear market client + linearClient := client.Linear() + // Get inverse perpetual market client + inverseClient := client.InversePerpetual() + + spotResponse, err := spotClient.Market().GetSymbols(context.Background()) + if err != nil { + fmt.Errorf("error: %v", err) + } + + linearResponse, err := linearClient.Market().GetSymbolInformation(context.Background(), &linear.GetSymbolInformationParams{ + Symbol: "BTCUSDT", + }) + if err != nil { + fmt.Errorf("error: %v", err) + } + + inverseResponse, err := inverseClient.Market().GetSymbolInformation(context.Background(), &inverseperp.GetSymbolInformationParams{ + Symbol: "BTCUSD", + }) + if err != nil { + fmt.Errorf("error: %v", err) + } + + fmt.Println(spotResponse) + fmt.Println(linearResponse) + fmt.Println(inverseResponse) +} +``` + # Enpoints completed | Category | SubCategory | Created | Testcases | diff --git a/examples/get-client/get_client_example.go b/examples/get-client/get_client_example.go new file mode 100644 index 0000000..c9fc2ad --- /dev/null +++ b/examples/get-client/get_client_example.go @@ -0,0 +1,45 @@ +package main + +import ( + "context" + "fmt" + "github.com/cksidharthan/go-bybit/bybit" + "github.com/cksidharthan/go-bybit/rest" + inverseperp "github.com/cksidharthan/go-bybit/rest/domain/inverse_perpetual" + "github.com/cksidharthan/go-bybit/rest/domain/linear" + "os" +) + +func main() { + client := rest.NewRestClient(bybit.BybitTestnetBaseURL, os.Getenv("BYBIT_API_KEY"), os.Getenv("BYBIT_API_SECRET")) + + // Get spot market client + spotClient := client.Spot() + // Get linear market client + linearClient := client.Linear() + // Get inverse perpetual market client + inverseClient := client.InversePerpetual() + + spotResponse, err := spotClient.Market().GetSymbols(context.Background()) + if err != nil { + fmt.Errorf("error: %v", err) + } + + linearResponse, err := linearClient.Market().GetSymbolInformation(context.Background(), &linear.GetSymbolInformationParams{ + Symbol: "BTCUSDT", + }) + if err != nil { + fmt.Errorf("error: %v", err) + } + + inverseResponse, err := inverseClient.Market().GetSymbolInformation(context.Background(), &inverseperp.GetSymbolInformationParams{ + Symbol: "BTCUSD", + }) + if err != nil { + fmt.Errorf("error: %v", err) + } + + fmt.Println(spotResponse) + fmt.Println(linearResponse) + fmt.Println(inverseResponse) +} From f65930fc9df8c2dae408c183c626d977af62fd34 Mon Sep 17 00:00:00 2001 From: Sidharthan Chandrasekaran Kamaraj Date: Sat, 17 Sep 2022 09:38:16 +0200 Subject: [PATCH 2/4] fix typos --- README.md | 2 +- examples/get-client/get_client_example.go | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a42b9f3..d1c1380 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ func main() { } ``` -# Enpoints completed +# Endpoints completed | Category | SubCategory | Created | Testcases | |-------------------|----------------------------------------------------------------------------------------|:------------------:|:------------------:| diff --git a/examples/get-client/get_client_example.go b/examples/get-client/get_client_example.go index c9fc2ad..a050671 100644 --- a/examples/get-client/get_client_example.go +++ b/examples/get-client/get_client_example.go @@ -22,21 +22,21 @@ func main() { spotResponse, err := spotClient.Market().GetSymbols(context.Background()) if err != nil { - fmt.Errorf("error: %v", err) + _ = fmt.Errorf("error: %v", err) } linearResponse, err := linearClient.Market().GetSymbolInformation(context.Background(), &linear.GetSymbolInformationParams{ Symbol: "BTCUSDT", }) if err != nil { - fmt.Errorf("error: %v", err) + _ = fmt.Errorf("error: %v", err) } inverseResponse, err := inverseClient.Market().GetSymbolInformation(context.Background(), &inverseperp.GetSymbolInformationParams{ Symbol: "BTCUSD", }) if err != nil { - fmt.Errorf("error: %v", err) + _ = fmt.Errorf("error: %v", err) } fmt.Println(spotResponse) From 6fd6ba2e82d58bba3f1742eddc6a71a360497757 Mon Sep 17 00:00:00 2001 From: Sidharthan Chandrasekaran Kamaraj Date: Sat, 17 Sep 2022 09:50:04 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index d1c1380..f07f65b 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,9 @@ func main() { } ``` +All the tests in this repository interact with the Bybit API directly. Please refer them for examples, when using this library. :) +In the meantime, I'll be adding more examples to `./examples` folder. + # Endpoints completed | Category | SubCategory | Created | Testcases | From 0a45f9c9aeb368c2fdcf84a738b2b1344b873739 Mon Sep 17 00:00:00 2001 From: Sidharthan Chandrasekaran Kamaraj Date: Sat, 17 Sep 2022 09:50:39 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f07f65b..e17fa22 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,7 @@ func main() { ``` All the tests in this repository interact with the Bybit API directly. Please refer them for examples, when using this library. :) + In the meantime, I'll be adding more examples to `./examples` folder. # Endpoints completed