diff --git a/README.md b/README.md index 1b63d9d..e17fa22 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,48 @@ This Project is under active development. Please feel free to contribute. go get -u github.com/cksidharthan/go-bybit ``` -# Enpoints completed +## 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) +} +``` + +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 | |-------------------|----------------------------------------------------------------------------------------|:------------------:|:------------------:| diff --git a/examples/get-client/get_client_example.go b/examples/get-client/get_client_example.go new file mode 100644 index 0000000..a050671 --- /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) +}