Skip to content

Commit f89d307

Browse files
committed
updated README with new data
1 parent 6bac6a6 commit f89d307

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,16 @@ The general convention used in all functions (both REST and websockets), is that
6262

6363
### Getting started
6464

65-
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/python-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.
65+
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/python-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.
6666
```python
6767
from python_bitvavo_api.bitvavo import Bitvavo
68-
bitvavo = Bitvavo({
69-
'APIKEY': "<APIKEY>",
70-
'APISECRET': "<APISECRET>",
68+
bitvavo = Bitvavo({
69+
'APIKEY': '<APIKEY>',
70+
'APISECRET': '<APISECRET>',
71+
'RESTURL': 'https://api.bitvavo.com/v2',
72+
'WSURL': 'wss://ws.bitvavo.com/v2/',
7173
'ACCESSWINDOW': 10000,
72-
'DEBUGGING': True
74+
'DEBUGGING': False
7375
})
7476
```
7577

0 commit comments

Comments
 (0)