Skip to content

Commit ccb5f02

Browse files
committed
updated README with new data
1 parent 9890ef3 commit ccb5f02

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,17 +81,18 @@ if err != nil {
8181

8282
### Getting started
8383

84-
The API key and secret are required for private calls and optional for public calls. The access window and debugging parameter are optional for all calls. The access window is used to determine whether the request arrived within time, the value is specified in milliseconds. You can use the [time](https://github.com/bitvavo/go-bitvavo-api#get-time) function to synchronize your time to our server time if errors arise. Debugging should be set to true when you want to log additional information and full responses. Any parameter can be omitted, private functions will return an error when the api key and secret have not been set.
84+
The API key and secret are required for private calls and optional for public calls. The access window and debugging parameter are optional for all calls. The access window is used to determine whether the request arrived within time, the value is specified in milliseconds. You can use the [time](https://github.com/bitvavo/go-bitvavo-api#get-time) function to synchronize your time to our server time if errors arise. REST url and WS url can be used to set a different endpoint (for testing purposes). Debugging should be set to true when you want to log additional information and full responses. Any parameter can be omitted, private functions will return an error when the api key and secret have not been set.
8585

8686
```go
8787
import . "bitvavo"
8888

89-
bitvavo := Bitvavo{
90-
ApiKey: "<APIKEY>",
91-
ApiSecret: "<APISECRET>",
92-
AccessWindow: 10000,
93-
Debugging: true
94-
}
89+
bitvavo := bitvavo.Bitvavo{
90+
ApiKey: "<APIKEY>",
91+
ApiSecret: "<APISECRET>",
92+
RestUrl: "https://api.bitvavo.com/v2",
93+
WsUrl: "wss://ws.bitvavo.com/v2/",
94+
AccessWindow: 10000,
95+
Debugging: false}
9596
```
9697

9798
### General

0 commit comments

Comments
 (0)