bitvavo-api-upgraded 1.15.8__py3-none-any.whl → 1.16.0__py3-none-any.whl

bitvavo_api_upgraded-1.16.0.dist-info/METADATA

@@ -0,0 +1,2429 @@
+Metadata-Version: 2.3
+Name: bitvavo-api-upgraded
+Version: 1.16.0
+Summary: A unit-tested fork of the Bitvavo API
+Project-URL: homepage, https://github.com/Thaumatorium/bitvavo-api-upgraded
+Project-URL: repository, https://github.com/Thaumatorium/bitvavo-api-upgraded
+Project-URL: changelog, https://github.com/Thaumatorium/bitvavo-api-upgraded/blob/master/CHANGELOG.md
+Author: Bitvavo BV (original code)
+Author-email: NostraDavid <55331731+NostraDavid@users.noreply.github.com>
+Maintainer-email: NostraDavid <55331731+NostraDavid@users.noreply.github.com>
+License: ISC License
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Pytest
+Classifier: Framework :: tox
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: ISC License (ISCL)
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: python-decouple==3.*,>=3.5
+Requires-Dist: requests==2.*,>=2.26
+Requires-Dist: structlog==24.*,>=21.5
+Requires-Dist: websocket-client==1.*,>=1.2
+Description-Content-Type: text/markdown
+
+# Bitvavo API (upgraded)
+
+## Userguide
+
+`pip install bitvavo_api_upgraded`
+
+Works the same as the official API lib, but I have:
+
+- typing for _all_ functions and classes
+- unit tests (I already found three bugs that I fixed, because the original code
+  wasn't tested, at all)
+- a changelog, so you can track of the changes that I make
+- compatible with Python 3.7 and newer ([3.6 isn't supported as of
+  2021-12-23](https://endoflife.date/python))
+
+## Devguide
+
+```shell
+echo "install development requirements"
+pip install -r requirements/dev.txt
+echo "install lib as editable code (changes are directly propogated)"
+pip install -e .
+echo "run tox, a program that creates separate environments for different python versions, for testing purposes (among other things)"
+tox
+```
+
+### Semantic Versioning (SemVer)
+
+I'm using semantic versioning, which means that changes mean this:
+
+1. MAJOR version when you make incompatible API changes,
+1. MINOR version when you add functionality in a backwards compatible manner,
+   and
+1. PATCH version when you make backwards compatible bug fixes.
+
+### Versioning
+
+Copy the following block to CHANGELOG.md and add all information since last
+version bump
+
+```markdown
+## $UNRELEASED
+
+### Added
+
+...
+
+### Changed
+
+...
+
+### Removed
+
+...
+```
+
+Commit those changes.
+
+After that, run `bump-my-version bump (major|minor|patch)` to automatically
+replace `$UNRELEASED` with the new version number, and also automatically tag
+and commit (with tag) to release a new version via the Github workflow.
+
+## py.typed
+
+Perhaps a curious file, but it simply exists to let `mypy` know that the code is
+typed: [Don't forget `py.typed` for your typed Python package
+](https://blog.whtsky.me/tech/2021/dont-forget-py.typed-for-your-typed-python-package/)
+
+## Last note
+
+_below this line is the old README.md_
+
+---
+
+<p align="center">
+  <br>
+  <a href="https://bitvavo.com"><img src="https://bitvavo.com/assets/static/ext/logo-shape.svg" width="100" title="Bitvavo Logo"></a>
+</p>
+
+# Python Bitvavo Api
+
+This is the python wrapper for the Bitvavo API. This project can be used to
+build your own projects which interact with the Bitvavo platform. Every function
+available on the API can be called through a REST request or over websockets.
+For info on the specifics of every parameter consult the [Bitvavo API
+documentation](https://docs.bitvavo.com/)
+
+- Getting started
+  [REST](https://github.com/bitvavo/python-bitvavo-api#getting-started)
+  [Websocket](https://github.com/bitvavo/python-bitvavo-api#getting-started-1)
+- General
+  - Time [REST](https://github.com/bitvavo/python-bitvavo-api#get-time)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-time-1)
+  - Markets [REST](https://github.com/bitvavo/python-bitvavo-api#get-markets)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-markets-1)
+  - Assets [REST](https://github.com/bitvavo/python-bitvavo-api#get-assets)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-assets-1)
+- Market Data
+  - Book
+    [REST](https://github.com/bitvavo/python-bitvavo-api#get-book-per-market)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-book-per-market-1)
+  - Public Trades
+    [REST](https://github.com/bitvavo/python-bitvavo-api#get-trades-per-market)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-trades-per-market-1)
+  - Candles
+    [REST](https://github.com/bitvavo/python-bitvavo-api#get-candles-per-market)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-candles-per-market-1)
+  - Price Ticker
+    [REST](https://github.com/bitvavo/python-bitvavo-api#get-price-ticker)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-price-ticker-1)
+  - Book Ticker
+    [REST](https://github.com/bitvavo/python-bitvavo-api#get-book-ticker)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-book-ticker-1)
+  - 24 Hour Ticker
+    [REST](https://github.com/bitvavo/python-bitvavo-api#get-24-hour-ticker)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-24-hour-ticker-1)
+- Private
+  - Place Order
+    [REST](https://github.com/bitvavo/python-bitvavo-api#place-order)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#place-order-1)
+  - Update Order
+    [REST](https://github.com/bitvavo/python-bitvavo-api#update-order)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#update-order-1)
+  - Get Order [REST](https://github.com/bitvavo/python-bitvavo-api#get-order)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-order-1)
+  - Cancel Order
+    [REST](https://github.com/bitvavo/python-bitvavo-api#cancel-order)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#cancel-order-1)
+  - Get Orders [REST](https://github.com/bitvavo/python-bitvavo-api#get-orders)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-orders-1)
+  - Cancel Orders
+    [REST](https://github.com/bitvavo/python-bitvavo-api#cancel-orders)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#cancel-orders-1)
+  - Orders Open
+    [REST](https://github.com/bitvavo/python-bitvavo-api#get-orders-open)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-orders-open-1)
+  - Trades [REST](https://github.com/bitvavo/python-bitvavo-api#get-trades)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-trades-1)
+  - Account [REST](https://github.com/bitvavo/python-bitvavo-api#get-account)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-account-1)
+  - Balance [REST](https://github.com/bitvavo/python-bitvavo-api#get-balance)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-balance-1)
+  - Deposit Assets
+    [REST](https://github.com/bitvavo/python-bitvavo-api#deposit-assets)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#deposit-assets-1)
+  - Withdraw Assets
+    [REST](https://github.com/bitvavo/python-bitvavo-api#withdraw-assets)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#withdraw-assets-1)
+  - Deposit History
+    [REST](https://github.com/bitvavo/python-bitvavo-api#get-deposit-history)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-deposit-history-1)
+  - Withdrawal History
+    [REST](https://github.com/bitvavo/python-bitvavo-api#get-withdrawal-history)
+    [Websocket](https://github.com/bitvavo/python-bitvavo-api#get-withdrawal-history-1)
+- [Subscriptions](https://github.com/bitvavo/python-bitvavo-api#subscriptions)
+  - [Ticker
+    Subscription](https://github.com/bitvavo/python-bitvavo-api#ticker-subscription)
+  - [Ticker 24 Hour
+    Subscription](https://github.com/bitvavo/python-bitvavo-api#ticker-24-hour-subscription)
+  - [Account
+    Subscription](https://github.com/bitvavo/python-bitvavo-api#account-subscription)
+  - [Candles
+    Subscription](https://github.com/bitvavo/python-bitvavo-api#candles-subscription)
+  - [Trades
+    Subscription](https://github.com/bitvavo/python-bitvavo-api#trades-subscription)
+  - [Book
+    Subscription](https://github.com/bitvavo/python-bitvavo-api#book-subscription)
+  - [Book subscription with local
+    copy](https://github.com/bitvavo/python-bitvavo-api#book-subscription-with-local-copy)
+
+## Installation
+
+```
+pip install python-bitvavo-api
+```
+
+## Rate Limiting
+
+Bitvavo uses a weight based rate limiting system, with an allowed limit of 1000
+per IP or API key each minute. Please inspect each endpoint in the [Bitvavo API
+documentation](https://docs.bitvavo.com/) to see the weight. Failure to respect
+the rate limit will result in an IP or API key ban. Since the remaining limit is
+returned in the header on each REST request, the remaining limit is tracked
+locally and can be requested through:
+
+```
+limit = bitvavo.getRemainingLimit()
+```
+
+The websocket functions however do not return a remaining limit, therefore the
+limit is only updated locally once a ban has been issued.
+
+## REST requests
+
+The general convention used in all functions (both REST and websockets), is that
+all optional parameters are passed as an dictionary, while required parameters
+are passed as separate values. Only when [placing
+orders](https://github.com/bitvavo/python-bitvavo-api#place-order) some of the
+optional parameters are required, since a limit order requires more information
+than a market order. The returned responses are all converted to a dictionary as
+well, such that `response['<key>'] = '<value>'`.
+
+### Getting started
+
+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.
+
+```python
+from bitvavo_api_upgraded.bitvavo import Bitvavo
+
+bitvavo = Bitvavo(
+    {
+        "APIKEY": "<APIKEY>",
+        "APISECRET": "<APISECRET>",
+        "RESTURL": "https://api.bitvavo.com/v2",
+        "WSURL": "wss://ws.bitvavo.com/v2/",
+        "ACCESSWINDOW": 10000,
+        "DEBUGGING": False,
+    }
+)
+```
+
+### General
+
+#### Get time
+
+```python
+response = bitvavo.time()
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"time": 1543397021396}
+```
+
+</details>
+
+#### Get markets
+
+```python
+# options: market
+response = bitvavo.markets({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "market": "ADA-BTC",
+    "status": "trading",
+    "base": "ADA",
+    "quote": "BTC",
+    "pricePrecision": 5,
+    "minOrderInBaseAsset": "100",
+    "minOrderInQuoteAsset": "0.001",
+    "orderTypes": ["market", "limit"],
+}
+{
+    "market": "ADA-EUR",
+    "status": "trading",
+    "base": "ADA",
+    "quote": "EUR",
+    "pricePrecision": 5,
+    "minOrderInBaseAsset": "100",
+    "minOrderInQuoteAsset": "10",
+    "orderTypes": ["market", "limit"],
+}
+{
+    "market": "AE-BTC",
+    "status": "trading",
+    "base": "AE",
+    "quote": "BTC",
+    "pricePrecision": 5,
+    "minOrderInBaseAsset": "10",
+    "minOrderInQuoteAsset": "0.001",
+    "orderTypes": ["market", "limit"],
+}
+{
+    "market": "AE-EUR",
+    "status": "trading",
+    "base": "AE",
+    "quote": "EUR",
+    "pricePrecision": 5,
+    "minOrderInBaseAsset": "10",
+    "minOrderInQuoteAsset": "10",
+    "orderTypes": ["market", "limit"],
+}
+...
+```
+
+</details>
+
+#### Get assets
+
+```python
+# options: symbol
+response = bitvavo.assets({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "symbol": "ADA",
+        "name": "Cardano",
+        "decimals": 6,
+        "depositFee": "0",
+        "depositConfirmations": 20,
+        "depositStatus": "OK",
+        "withdrawalFee": "0.2",
+        "withdrawalMinAmount": "0.2",
+        "withdrawalStatus": "OK",
+        "networks": ["Mainnet"],
+        "message": "",
+    },
+    {
+        "symbol": "AE",
+        "name": "Aeternity",
+        "decimals": 8,
+        "depositFee": "0",
+        "depositConfirmations": 30,
+        "depositStatus": "OK",
+        "withdrawalFee": "2",
+        "withdrawalMinAmount": "2",
+        "withdrawalStatus": "OK",
+        "networks": ["Mainnet"],
+        "message": "",
+    },
+    {
+        "symbol": "AION",
+        "name": "Aion",
+        "decimals": 8,
+        "depositFee": "0",
+        "depositConfirmations": 0,
+        "depositStatus": "",
+        "withdrawalFee": "3",
+        "withdrawalMinAmount": "3",
+        "withdrawalStatus": "",
+        "networks": ["Mainnet"],
+        "message": "",
+    },
+    {
+        "symbol": "ANT",
+        "name": "Aragon",
+        "decimals": 8,
+        "depositFee": "0",
+        "depositConfirmations": 30,
+        "depositStatus": "OK",
+        "withdrawalFee": "2",
+        "withdrawalMinAmount": "2",
+        "withdrawalStatus": "OK",
+        "networks": ["Mainnet"],
+        "message": "",
+    },
+    ...,
+]
+```
+
+</details>
+
+### Market Data
+
+#### Get book per market
+
+```python
+# options: depth
+response = bitvavo.book("BTC-EUR", {})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "market": "BTC-EUR",
+    "nonce": 26393,
+    "bids": [
+        ["3008.8", "1.47148675"],
+        ["3008.3", "1.10515032"],
+        ["3007.7", "1.38627613"],
+        ["3007.2", "0.72343843"],
+        ["3006.7", "0.96668815"],
+        ["3006.2", "3.50846635"],
+        ...,
+    ],
+    "asks": [
+        ["3009.2", "2.74009412"],
+        ["3011.3", "3.03788636"],
+        ["3013.1", "3.91270989"],
+        ["3015.1", "4.33891895"],
+        ["3016", "1.34888815"],
+        ["3016.5", "1.95726644"],
+        ...,
+    ],
+}
+```
+
+</details>
+
+#### Get trades per market
+
+```python
+# options: limit, start, end, tradeIdFrom, tradeIdTo
+response = bitvavo.publicTrades("BTC-EUR", {})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+  {
+    "id": "041689b3-cbb6-49ec-9964-2fb2d353dd1b",
+    "timestamp": 1565672192018,
+    "amount": "0.12735922",
+    "price": "10147",
+    "side": "sell"
+  },
+  {
+    "id": "fb1712f2-e183-457c-b9e5-ff0d31fccd1f",
+    "timestamp": 1565672192014,
+    "amount": "0.08703703",
+    "price": "10149",
+    "side": "sell"
+  },
+  {
+    "id": "b8cf5e20-65ca-4f45-a94c-44b7cb3952a5",
+    "timestamp": 1565672192009,
+    "amount": "0.0979994",
+    "price": "10151",
+    "side": "sell"
+  },
+  {
+    "id": "d10cc7ec-a735-4d5c-8169-c3099f8b5003",
+    "timestamp": 1565672144747,
+    "amount": "0.01975188",
+    "price": "10151",
+    "side": "sell"
+  }
+  ...
+]
+```
+
+</details>
+
+#### Get candles per market
+
+```python
+# options: limit, start, end
+response = bitvavo.candles("BTC-EUR", "1h", {})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    [1548669600000, "3012.9", "3015.8", "3000", "3012.9", "8"],
+    [1548669600000, "3012.9", "3015.8", "3000", "3012.9", "8"],
+    [1548669600000, "3012.9", "3015.8", "3000", "3012.9", "8"],
+    [1548417600000, "3124", "3125.1", "3124", "3124", "0.1"],
+    [1548237600000, "3143", "3143.3", "3141.1", "3143", "60.67250851"],
+    ...,
+]
+```
+
+</details>
+
+#### Get price ticker
+
+```python
+# options: market
+response = bitvavo.tickerPrice({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {"market": "EOS-EUR", "price": "2.0142"},
+    {"market": "XRP-EUR", "price": "0.27848"},
+    {"market": "ETH-EUR", "price": "99.877"},
+    {"market": "IOST-EUR", "price": "0.005941"},
+    {"market": "BCH-EUR", "price": "106.57"},
+    {"market": "BTC-EUR", "price": "3008.9"},
+    {"market": "STORM-EUR", "price": "0.0025672"},
+    {"market": "EOS-BTC", "price": "0.00066289"},
+    ...,
+]
+```
+
+</details>
+
+#### Get book ticker
+
+```python
+# options: market
+response = bitvavo.tickerBook({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "market": "ZIL-BTC",
+        "bid": "0.00000082",
+        "ask": "0.00000083",
+        "bidSize": "13822.00651664",
+        "askSize": "5743.88893286",
+    },
+    {
+        "market": "ZIL-EUR",
+        "bid": "0.0082973",
+        "ask": "0.0084058",
+        "bidSize": "19586.15862762",
+        "askSize": "19048.86640562",
+    },
+    {
+        "market": "ZRX-BTC",
+        "bid": "0.00001625",
+        "ask": "0.00001629",
+        "bidSize": "823.87743487",
+        "askSize": "868.23901671",
+    },
+    {
+        "market": "ZRX-EUR",
+        "bid": "0.16443",
+        "ask": "0.16498",
+        "bidSize": "898.35016343",
+        "askSize": "419.16696625",
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Get 24 hour ticker
+
+```python
+# options: market
+response = bitvavo.ticker24h({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "market": "XVG-EUR",
+        "open": "0.0045692",
+        "high": "0.0045853",
+        "low": "0.0043599",
+        "last": "0.0044047",
+        "volume": "594786.9689017",
+        "volumeQuote": "2648.07",
+        "bid": "0.0043493",
+        "bidSize": "1561220.43836043",
+        "ask": "0.004453",
+        "askSize": "1457312.74672114",
+        "timestamp": 1565684835077,
+    },
+    {
+        "market": "ZIL-EUR",
+        "open": "0.0081178",
+        "high": "0.0084196",
+        "low": "0.0077389",
+        "last": "0.0084071",
+        "volume": "950455.78568402",
+        "volumeQuote": "7687.71",
+        "bid": "0.008294",
+        "bidSize": "19593.90088084",
+        "ask": "0.0084",
+        "askSize": "19048.86640562",
+        "timestamp": 1565684834952,
+    },
+    {
+        "market": "ZRX-EUR",
+        "open": "0.1731",
+        "high": "0.1731",
+        "low": "0.16426",
+        "last": "0.16477",
+        "volume": "22486.29651877",
+        "volumeQuote": "3727.45",
+        "bid": "0.16436",
+        "bidSize": "898.75082725",
+        "ask": "0.16476",
+        "askSize": "419.31541176",
+        "timestamp": 1565684835335,
+    },
+    ...,
+]
+```
+
+</details>
+
+### Private
+
+#### Place order
+
+When placing an order, make sure that the correct optional parameters are set.
+For a limit order it is required to set both the amount and price. A market
+order is valid if either amount or amountQuote is set.
+
+```python
+# optional parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection),
+#                      stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+#                      stopLossLimit/takeProfitLimit:(amount, price, postOnly, triggerType, triggerReference, triggerAmount)
+#                      all orderTypes: timeInForce, selfTradePrevention, responseRequired
+response = bitvavo.placeOrder(
+    "BTC-EUR", "buy", "limit", {"amount": "1", "price": "3000"}
+)
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "orderId": "5444f908-67c4-4c5d-a138-7e834b94360e",
+    "market": "BTC-EUR",
+    "created": 1548671550610,
+    "updated": 1548671550610,
+    "status": "new",
+    "side": "buy",
+    "orderType": "limit",
+    "amount": "1",
+    "amountRemaining": "1",
+    "price": "3000",
+    "onHold": "3007.5",
+    "onHoldCurrency": "EUR",
+    "filledAmount": "0",
+    "filledAmountQuote": "0",
+    "feePaid": "0",
+    "feeCurrency": "EUR",
+    "fills": [],
+    "selfTradePrevention": "decrementAndCancel",
+    "visible": true,
+    "timeInForce": "GTC",
+    "postOnly": false,
+}
+```
+
+</details>
+
+#### Update order
+
+When updating an order make sure that at least one of the optional parameters
+has been set. Otherwise nothing can be updated.
+
+```python
+# Optional parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
+#          untriggered stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+#                      stopLossLimit/takeProfitLimit: (amount, price, postOnly, triggerType, triggerReference, triggerAmount)
+response = bitvavo.updateOrder(
+    "BTC-EUR", "5444f908-67c4-4c5d-a138-7e834b94360e", {"amount": "1.1"}
+)
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "orderId": "5444f908-67c4-4c5d-a138-7e834b94360e",
+    "market": "BTC-EUR",
+    "created": 1548671550610,
+    "updated": 1548671831685,
+    "status": "new",
+    "side": "buy",
+    "orderType": "limit",
+    "amount": "1.1",
+    "amountRemaining": "1.1",
+    "price": "3000",
+    "onHold": "3308.25",
+    "onHoldCurrency": "EUR",
+    "filledAmount": "0",
+    "filledAmountQuote": "0",
+    "feePaid": "0",
+    "feeCurrency": "EUR",
+    "fills": [],
+    "selfTradePrevention": "decrementAndCancel",
+    "visible": true,
+    "timeInForce": "GTC",
+    "postOnly": false,
+}
+```
+
+</details>
+
+#### Get order
+
+```python
+response = bitvavo.getOrder("BTC-EUR", "5444f908-67c4-4c5d-a138-7e834b94360e")
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "orderId": "5444f908-67c4-4c5d-a138-7e834b94360e",
+    "market": "BTC-EUR",
+    "created": 1548671550610,
+    "updated": 1548671550610,
+    "status": "new",
+    "side": "buy",
+    "orderType": "limit",
+    "amount": "1",
+    "amountRemaining": "1",
+    "price": "3000",
+    "onHold": "3007.5",
+    "onHoldCurrency": "EUR",
+    "filledAmount": "0",
+    "filledAmountQuote": "0",
+    "feePaid": "0",
+    "feeCurrency": "EUR",
+    "fills": [],
+    "selfTradePrevention": "decrementAndCancel",
+    "visible": true,
+    "timeInForce": "GTC",
+    "postOnly": false,
+}
+```
+
+</details>
+
+#### Cancel order
+
+```python
+response = bitvavo.cancelOrder("BTC-EUR", "5986db7b-8d6e-4577-8003-22f363fb3626")
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"orderId": "5986db7b-8d6e-4577-8003-22f363fb3626"}
+```
+
+</details>
+
+#### Get orders
+
+Returns the same as get order, but can be used to return multiple orders at
+once.
+
+```python
+# options: limit, start, end, orderIdFrom, orderIdTo
+response = bitvavo.getOrders("BTC-EUR", {})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "orderId": "bad72641-7755-464c-8dcb-7c1d59b142ab",
+        "market": "BTC-EUR",
+        "created": 1548670024870,
+        "updated": 1548670024870,
+        "status": "partiallyFilled",
+        "side": "buy",
+        "orderType": "limit",
+        "amount": "1",
+        "amountRemaining": "0.5",
+        "price": "3000",
+        "onHold": "1504.5",
+        "onHoldCurrency": "EUR",
+        "filledAmount": "0.5",
+        "filledAmountQuote": "1500",
+        "feePaid": "3",
+        "feeCurrency": "EUR",
+        "fills": [
+            {
+                "id": "108c3633-0276-4480-a902-17a01829deae",
+                "timestamp": 1548671992530,
+                "amount": "0.5",
+                "price": "3000",
+                "taker": false,
+                "fee": "3",
+                "feeCurrency": "EUR",
+                "settled": true,
+            }
+        ],
+        "selfTradePrevention": "decrementAndCancel",
+        "visible": true,
+        "timeInForce": "GTC",
+        "postOnly": false,
+    },
+    {
+        "orderId": "da1d8330-d6b7-4753-800a-01ad510a679b",
+        "market": "BTC-EUR",
+        "created": 1548666570234,
+        "updated": 1548666570234,
+        "status": "filled",
+        "side": "sell",
+        "orderType": "limit",
+        "amount": "0.1",
+        "amountRemaining": "0",
+        "price": "4000",
+        "onHold": "0",
+        "onHoldCurrency": "BTC",
+        "filledAmount": "0.1",
+        "filledAmountQuote": "400",
+        "feePaid": "0.8",
+        "feeCurrency": "EUR",
+        "fills": [
+            {
+                "id": "79e4bf2f-4fac-4895-9bb2-a5c9c6e2ff3f",
+                "timestamp": 1548666712071,
+                "amount": "0.1",
+                "price": "4000",
+                "taker": false,
+                "fee": "0.8",
+                "feeCurrency": "EUR",
+                "settled": true,
+            }
+        ],
+        "selfTradePrevention": "decrementAndCancel",
+        "visible": true,
+        "timeInForce": "GTC",
+        "postOnly": false,
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Cancel orders
+
+Cancels all orders in a market. If no market is specified, all orders of an
+account will be canceled.
+
+```python
+# options: market
+response = bitvavo.cancelOrders({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+  {
+    "orderId": "4f9a809b-859f-4d8d-97b3-037113cdf2d0"
+  },
+  {
+    "orderId": "95313ae5-ad65-4430-a0fb-63591bbc337c".
+  },
+  {
+    "orderId": "2465c3ab-5ae2-4d4d-bec7-345f51b3494d"
+  },
+  ...
+]
+```
+
+</details>
+
+#### Get orders open
+
+Returns all orders which are not filled or canceled.
+
+```python
+# options: market
+response = bitvavo.ordersOpen({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "orderId": "bad72641-7755-464c-8dcb-7c1d59b142ab",
+        "market": "BTC-EUR",
+        "created": 1548670024870,
+        "updated": 1548670024870,
+        "status": "partiallyFilled",
+        "side": "buy",
+        "orderType": "limit",
+        "amount": "1",
+        "amountRemaining": "0.5",
+        "price": "3000",
+        "onHold": "1504.5",
+        "onHoldCurrency": "EUR",
+        "filledAmount": "0.5",
+        "filledAmountQuote": "1500",
+        "feePaid": "3",
+        "feeCurrency": "EUR",
+        "fills": [
+            {
+                "id": "108c3633-0276-4480-a902-17a01829deae",
+                "timestamp": 1548671992530,
+                "amount": "0.5",
+                "price": "3000",
+                "taker": false,
+                "fee": "3",
+                "feeCurrency": "EUR",
+                "settled": true,
+            }
+        ],
+        "selfTradePrevention": "decrementAndCancel",
+        "visible": true,
+        "timeInForce": "GTC",
+        "postOnly": false,
+    },
+    {
+        "orderId": "7586d610-2732-4ee6-8516-bed18cfc853b",
+        "market": "BTC-EUR",
+        "created": 1548670088749,
+        "updated": 1548670088749,
+        "status": "new",
+        "side": "buy",
+        "orderType": "limit",
+        "amount": "1",
+        "amountRemaining": "1",
+        "price": "3000",
+        "onHold": "3007.5",
+        "onHoldCurrency": "EUR",
+        "filledAmount": "0",
+        "filledAmountQuote": "0",
+        "feePaid": "0",
+        "feeCurrency": "EUR",
+        "fills": [],
+        "selfTradePrevention": "decrementAndCancel",
+        "visible": true,
+        "timeInForce": "GTC",
+        "postOnly": false,
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Get trades
+
+Returns all trades within a market for this account.
+
+```python
+# options: limit, start, end, tradeIdFrom, tradeIdTo
+response = bitvavo.trades("BTC-EUR", {})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "id": "108c3633-0276-4480-a902-17a01829deae",
+        "timestamp": 1548671992530,
+        "market": "BTC-EUR",
+        "side": "buy",
+        "amount": "0.5",
+        "price": "3000",
+        "taker": false,
+        "fee": "3",
+        "feeCurrency": "EUR",
+        "settled": true,
+    },
+    {
+        "id": "79e4bf2f-4fac-4895-9bb2-a5c9c6e2ff3f",
+        "timestamp": 1548666712071,
+        "market": "BTC-EUR",
+        "side": "sell",
+        "amount": "0.1",
+        "price": "4000",
+        "taker": false,
+        "fee": "0.8",
+        "feeCurrency": "EUR",
+        "settled": true,
+    },
+    {
+        "id": "102486d3-5b72-4fa2-89cf-84c934edb7ae",
+        "timestamp": 1548666561486,
+        "market": "BTC-EUR",
+        "side": "sell",
+        "amount": "0.1",
+        "price": "4000",
+        "taker": true,
+        "fee": "1",
+        "feeCurrency": "EUR",
+        "settled": true,
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Get account
+
+Returns the fee tier for this account.
+
+```python
+response = bitvavo.account()
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"fees": {"taker": "0.0025", "maker": "0.0015", "volume": "100.00"}}
+```
+
+</details>
+
+#### Get balance
+
+Returns the balance for this account.
+
+```python
+# options: symbol
+response = bitvavo.balance({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {"symbol": "EUR", "available": "2599.95", "inOrder": "2022.65"},
+    {"symbol": "BTC", "available": "1.65437", "inOrder": "0.079398"},
+    {"symbol": "ADA", "available": "4.8", "inOrder": "0"},
+    {"symbol": "BCH", "available": "0.00952811", "inOrder": "0"},
+    {"symbol": "BSV", "available": "0.00952811", "inOrder": "0"},
+    ...,
+]
+```
+
+</details>
+
+#### Deposit assets
+
+Returns the address which can be used to deposit funds.
+
+```python
+response = bitvavo.depositAssets("BTC")
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"address": "BitcoinAddress"}
+```
+
+</details>
+
+#### Withdraw assets
+
+Can be used to withdraw funds from Bitvavo.
+
+```python
+# optional parameters: paymentId, internal, addWithdrawalFee
+response = bitvavo.withdrawAssets("BTC", "1", "BitcoinAddress", {})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"success": True, "symbol": "BTC", "amount": "1"}
+```
+
+</details>
+
+#### Get deposit history
+
+Returns the deposit history of your account.
+
+```python
+# options: symbol, limit, start, end
+response = bitvavo.depositHistory({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "timestamp": 1521550025000,
+        "symbol": "EUR",
+        "amount": "1",
+        "fee": "0",
+        "status": "completed",
+        "address": "NL12RABO324234234",
+    },
+    {
+        "timestamp": 1511873910000,
+        "symbol": "BTC",
+        "amount": "0.099",
+        "fee": "0",
+        "status": "completed",
+        "txId": "0c6497e608212a516b8218674cb0ca04f65b67a00fe8bddaa1ecb03e9b029255",
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Get withdrawal history
+
+Returns the withdrawal history of an account.
+
+```python
+# options: symbol, limit, start, end
+response = bitvavo.withdrawalHistory({})
+print(response)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "timestamp": 1548425559000,
+        "symbol": "BTC",
+        "amount": "0.09994",
+        "fee": "0.00006",
+        "status": "awaiting_processing",
+        "address": "1CqtG5z55x7bYD5GxsAXPx59DEyujs4bjm",
+    },
+    {
+        "timestamp": 1548409721000,
+        "symbol": "EUR",
+        "amount": "50",
+        "fee": "0",
+        "status": "completed",
+        "address": "NL123BIM",
+    },
+    {
+        "timestamp": 1537803091000,
+        "symbol": "BTC",
+        "amount": "0.01939",
+        "fee": "0.00002",
+        "status": "completed",
+        "txId": "da2299c86fce67eb899aeaafbe1f81cf663a3850cf9f3337c92b2d87945532db",
+        "address": "3QpyxeA7yWWsSURXEmuBBzHpxjqn7Rbyme",
+    },
+    ...,
+]
+```
+
+</details>
+
+## Websockets
+
+All requests which can be done through REST requests can also be performed over
+websockets. Bitvavo also provides six
+[subscriptions](https://github.com/bitvavo/python-bitvavo-api#subscriptions). If
+subscribed to these, updates specific for that type/market are pushed
+immediately.
+
+### Getting started
+
+The websocket object should be intialised through the `newWebsocket()` function.
+After which a callback for the errors should be set. After this any desired
+function can be called. Finally the main thread should be kept alive for as long
+as you want the socket to stay open. This can be achieved through a simple
+`while()` loop, where the remaining limit is checked. This is in case a ban has
+been issued, otherwise the websocket object will keep trying to reconnect, while
+our servers keep closing the connection.
+
+```python
+def errorCallback(error):
+    print("Handle error here", error)
+
+
+def ownCallback(response):
+    print("Handle function response here", response)
+
+
+websocket = bitvavo.newWebsocket()
+websocket.setErrorCallback(errorCallback)
+
+# Call functions here, like:
+# websocket.time(ownCallback)
+
+limit = bitvavo.getRemainingLimit()
+try:
+    while limit > 0:
+        time.sleep(0.5)
+        limit = bitvavo.getRemainingLimit()
+except KeyboardInterrupt:
+    websocket.closeSocket()
+```
+
+The api key and secret are copied from the bitvavo object. Therefore if you want
+to use the private portion of the websockets API, you should set both the key
+and secret as specified in [REST
+requests](https://github.com/bitvavo/python-bitvavo-api#rest-requests).
+
+### Public
+
+#### Get time
+
+```python
+websocket.time(ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"time": 1543397021396}
+```
+
+</details>
+
+#### Get markets
+
+```python
+# options: market
+websocket.markets({}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "market": "ADA-BTC",
+    "status": "trading",
+    "base": "ADA",
+    "quote": "BTC",
+    "pricePrecision": 5,
+    "minOrderInBaseAsset": "100",
+    "minOrderInQuoteAsset": "0.001",
+    "orderTypes": ["market", "limit"],
+}
+{
+    "market": "ADA-EUR",
+    "status": "trading",
+    "base": "ADA",
+    "quote": "EUR",
+    "pricePrecision": 5,
+    "minOrderInBaseAsset": "100",
+    "minOrderInQuoteAsset": "10",
+    "orderTypes": ["market", "limit"],
+}
+{
+    "market": "AE-BTC",
+    "status": "trading",
+    "base": "AE",
+    "quote": "BTC",
+    "pricePrecision": 5,
+    "minOrderInBaseAsset": "10",
+    "minOrderInQuoteAsset": "0.001",
+    "orderTypes": ["market", "limit"],
+}
+{
+    "market": "AE-EUR",
+    "status": "trading",
+    "base": "AE",
+    "quote": "EUR",
+    "pricePrecision": 5,
+    "minOrderInBaseAsset": "10",
+    "minOrderInQuoteAsset": "10",
+    "orderTypes": ["market", "limit"],
+}
+...
+```
+
+</details>
+
+#### Get assets
+
+```python
+# options: symbol
+websocket.assets({}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "symbol": "ADA",
+        "name": "Cardano",
+        "decimals": 6,
+        "depositFee": "0",
+        "depositConfirmations": 20,
+        "depositStatus": "OK",
+        "withdrawalFee": "0.2",
+        "withdrawalMinAmount": "0.2",
+        "withdrawalStatus": "OK",
+        "networks": ["Mainnet"],
+        "message": "",
+    },
+    {
+        "symbol": "AE",
+        "name": "Aeternity",
+        "decimals": 8,
+        "depositFee": "0",
+        "depositConfirmations": 30,
+        "depositStatus": "OK",
+        "withdrawalFee": "2",
+        "withdrawalMinAmount": "2",
+        "withdrawalStatus": "OK",
+        "networks": ["Mainnet"],
+        "message": "",
+    },
+    {
+        "symbol": "AION",
+        "name": "Aion",
+        "decimals": 8,
+        "depositFee": "0",
+        "depositConfirmations": 0,
+        "depositStatus": "",
+        "withdrawalFee": "3",
+        "withdrawalMinAmount": "3",
+        "withdrawalStatus": "",
+        "networks": ["Mainnet"],
+        "message": "",
+    },
+    {
+        "symbol": "ANT",
+        "name": "Aragon",
+        "decimals": 8,
+        "depositFee": "0",
+        "depositConfirmations": 30,
+        "depositStatus": "OK",
+        "withdrawalFee": "2",
+        "withdrawalMinAmount": "2",
+        "withdrawalStatus": "OK",
+        "networks": ["Mainnet"],
+        "message": "",
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Get book per market
+
+```python
+# options: depth
+websocket.book("BTC-EUR", {}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "market": "BTC-EUR",
+    "nonce": 26393,
+    "bids": [
+        ["3008.8", "1.47148675"],
+        ["3008.3", "1.10515032"],
+        ["3007.7", "1.38627613"],
+        ["3007.2", "0.72343843"],
+        ["3006.7", "0.96668815"],
+        ["3006.2", "3.50846635"],
+        ...,
+    ],
+    "asks": [
+        ["3009.2", "2.74009412"],
+        ["3011.3", "3.03788636"],
+        ["3013.1", "3.91270989"],
+        ["3015.1", "4.33891895"],
+        ["3016", "1.34888815"],
+        ["3016.5", "1.95726644"],
+        ...,
+    ],
+}
+```
+
+</details>
+
+#### Get trades per market
+
+```python
+# options: limit, start, end, tradeIdFrom, tradeIdTo
+websocket.publicTrades("BTC-EUR", {}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+  {
+    "id": "041689b3-cbb6-49ec-9964-2fb2d353dd1b",
+    "timestamp": 1565672192018,
+    "amount": "0.12735922",
+    "price": "10147",
+    "side": "sell"
+  },
+  {
+    "id": "fb1712f2-e183-457c-b9e5-ff0d31fccd1f",
+    "timestamp": 1565672192014,
+    "amount": "0.08703703",
+    "price": "10149",
+    "side": "sell"
+  },
+  {
+    "id": "b8cf5e20-65ca-4f45-a94c-44b7cb3952a5",
+    "timestamp": 1565672192009,
+    "amount": "0.0979994",
+    "price": "10151",
+    "side": "sell"
+  },
+  {
+    "id": "d10cc7ec-a735-4d5c-8169-c3099f8b5003",
+    "timestamp": 1565672144747,
+    "amount": "0.01975188",
+    "price": "10151",
+    "side": "sell"
+  }
+  ...
+]
+```
+
+</details>
+
+#### Get candles per market
+
+```python
+# options: limit
+websocket.candles("BTC-EUR", "1h", {}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    [1548669600000, "3012.9", "3015.8", "3000", "3012.9", "8"],
+    [1548669600000, "3012.9", "3015.8", "3000", "3012.9", "8"],
+    [1548669600000, "3012.9", "3015.8", "3000", "3012.9", "8"],
+    [1548417600000, "3124", "3125.1", "3124", "3124", "0.1"],
+    [1548237600000, "3143", "3143.3", "3141.1", "3143", "60.67250851"],
+    ...,
+]
+```
+
+</details>
+
+#### Get price ticker
+
+```python
+# options: market
+websocket.tickerPrice({}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {"market": "EOS-EUR", "price": "2.0142"},
+    {"market": "XRP-EUR", "price": "0.27848"},
+    {"market": "ETH-EUR", "price": "99.877"},
+    {"market": "IOST-EUR", "price": "0.005941"},
+    {"market": "BCH-EUR", "price": "106.57"},
+    {"market": "BTC-EUR", "price": "3008.9"},
+    {"market": "STORM-EUR", "price": "0.0025672"},
+    {"market": "EOS-BTC", "price": "0.00066289"},
+    ...,
+]
+```
+
+</details>
+
+#### Get book ticker
+
+```python
+# options: market
+websocket.tickerBook({}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "market": "ZIL-BTC",
+        "bid": "0.00000082",
+        "ask": "0.00000083",
+        "bidSize": "13822.00651664",
+        "askSize": "5743.88893286",
+    },
+    {
+        "market": "ZIL-EUR",
+        "bid": "0.0082973",
+        "ask": "0.0084058",
+        "bidSize": "19586.15862762",
+        "askSize": "19048.86640562",
+    },
+    {
+        "market": "ZRX-BTC",
+        "bid": "0.00001625",
+        "ask": "0.00001629",
+        "bidSize": "823.87743487",
+        "askSize": "868.23901671",
+    },
+    {
+        "market": "ZRX-EUR",
+        "bid": "0.16443",
+        "ask": "0.16498",
+        "bidSize": "898.35016343",
+        "askSize": "419.16696625",
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Get 24 hour ticker
+
+```python
+# options: market
+websocket.ticker24h({}, timeCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "market": "XVG-EUR",
+        "open": "0.0045692",
+        "high": "0.0045853",
+        "low": "0.0043599",
+        "last": "0.0044047",
+        "volume": "594786.9689017",
+        "volumeQuote": "2648.07",
+        "bid": "0.0043493",
+        "bidSize": "1561220.43836043",
+        "ask": "0.004453",
+        "askSize": "1457312.74672114",
+        "timestamp": 1565684835077,
+    },
+    {
+        "market": "ZIL-EUR",
+        "open": "0.0081178",
+        "high": "0.0084196",
+        "low": "0.0077389",
+        "last": "0.0084071",
+        "volume": "950455.78568402",
+        "volumeQuote": "7687.71",
+        "bid": "0.008294",
+        "bidSize": "19593.90088084",
+        "ask": "0.0084",
+        "askSize": "19048.86640562",
+        "timestamp": 1565684834952,
+    },
+    {
+        "market": "ZRX-EUR",
+        "open": "0.1731",
+        "high": "0.1731",
+        "low": "0.16426",
+        "last": "0.16477",
+        "volume": "22486.29651877",
+        "volumeQuote": "3727.45",
+        "bid": "0.16436",
+        "bidSize": "898.75082725",
+        "ask": "0.16476",
+        "askSize": "419.31541176",
+        "timestamp": 1565684835335,
+    },
+    ...,
+]
+```
+
+</details>
+
+### Private
+
+#### Place order
+
+When placing an order, make sure that the correct optional parameters are set.
+For a limit order it is required to set both the amount and price. A market
+order is valid if either amount or amountQuote has been set.
+
+```python
+# optional parameters: limit:(amount, price, postOnly), market:(amount, amountQuote, disableMarketProtection),
+#                      stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+#                      stopLossLimit/takeProfitLimit:(amount, price, postOnly, triggerType, triggerReference, triggerAmount)
+#                      all orderTypes: timeInForce, selfTradePrevention, responseRequired
+websocket.placeOrder(
+    "BTC-EUR", "buy", "limit", {"amount": "1", "price": "3000"}, ownCallback
+)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "orderId": "5444f908-67c4-4c5d-a138-7e834b94360e",
+    "market": "BTC-EUR",
+    "created": 1548671550610,
+    "updated": 1548671550610,
+    "status": "new",
+    "side": "buy",
+    "orderType": "limit",
+    "amount": "1",
+    "amountRemaining": "1",
+    "price": "3000",
+    "onHold": "3007.5",
+    "onHoldCurrency": "EUR",
+    "filledAmount": "0",
+    "filledAmountQuote": "0",
+    "feePaid": "0",
+    "feeCurrency": "EUR",
+    "fills": [],
+    "selfTradePrevention": "decrementAndCancel",
+    "visible": true,
+    "timeInForce": "GTC",
+    "postOnly": false,
+}
+```
+
+</details>
+
+#### Update order
+
+When updating an order make sure that at least one of the optional parameters
+has been set. Otherwise nothing can be updated.
+
+```python
+# Optional parameters: limit:(amount, amountRemaining, price, timeInForce, selfTradePrevention, postOnly)
+#          untriggered stopLoss/takeProfit:(amount, amountQuote, disableMarketProtection, triggerType, triggerReference, triggerAmount)
+#                      stopLossLimit/takeProfitLimit: (amount, price, postOnly, triggerType, triggerReference, triggerAmount)
+websocket.updateOrder(
+    "BTC-EUR", "5444f908-67c4-4c5d-a138-7e834b94360e", {"amount": "1.1"}, ownCallback
+)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "orderId": "5444f908-67c4-4c5d-a138-7e834b94360e",
+    "market": "BTC-EUR",
+    "created": 1548671550610,
+    "updated": 1548671831685,
+    "status": "new",
+    "side": "buy",
+    "orderType": "limit",
+    "amount": "1.1",
+    "amountRemaining": "1.1",
+    "price": "3000",
+    "onHold": "3308.25",
+    "onHoldCurrency": "EUR",
+    "filledAmount": "0",
+    "filledAmountQuote": "0",
+    "feePaid": "0",
+    "feeCurrency": "EUR",
+    "fills": [],
+    "selfTradePrevention": "decrementAndCancel",
+    "visible": true,
+    "timeInForce": "GTC",
+    "postOnly": false,
+}
+```
+
+</details>
+
+#### Get order
+
+```python
+websocket.getOrder("BTC-EUR", "5444f908-67c4-4c5d-a138-7e834b94360e", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "orderId": "5444f908-67c4-4c5d-a138-7e834b94360e",
+    "market": "BTC-EUR",
+    "created": 1548671550610,
+    "updated": 1548671550610,
+    "status": "new",
+    "side": "buy",
+    "orderType": "limit",
+    "amount": "1",
+    "amountRemaining": "1",
+    "price": "3000",
+    "onHold": "3007.5",
+    "onHoldCurrency": "EUR",
+    "filledAmount": "0",
+    "filledAmountQuote": "0",
+    "feePaid": "0",
+    "feeCurrency": "EUR",
+    "fills": [],
+    "selfTradePrevention": "decrementAndCancel",
+    "visible": true,
+    "timeInForce": "GTC",
+    "postOnly": false,
+}
+```
+
+</details>
+
+#### Cancel order
+
+```python
+websocket.cancelOrder("BTC-EUR", "5986db7b-8d6e-4577-8003-22f363fb3626", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"orderId": "5986db7b-8d6e-4577-8003-22f363fb3626"}
+```
+
+</details>
+
+#### Get orders
+
+Returns the same as get order, but can be used to return multiple orders at
+once.
+
+```python
+# options: limit, start, end, orderIdFrom, orderIdTo
+websocket.getOrders("BTC-EUR", {}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "orderId": "bad72641-7755-464c-8dcb-7c1d59b142ab",
+        "market": "BTC-EUR",
+        "created": 1548670024870,
+        "updated": 1548670024870,
+        "status": "partiallyFilled",
+        "side": "buy",
+        "orderType": "limit",
+        "amount": "1",
+        "amountRemaining": "0.5",
+        "price": "3000",
+        "onHold": "1504.5",
+        "onHoldCurrency": "EUR",
+        "filledAmount": "0.5",
+        "filledAmountQuote": "1500",
+        "feePaid": "3",
+        "feeCurrency": "EUR",
+        "fills": [
+            {
+                "id": "108c3633-0276-4480-a902-17a01829deae",
+                "timestamp": 1548671992530,
+                "amount": "0.5",
+                "price": "3000",
+                "taker": false,
+                "fee": "3",
+                "feeCurrency": "EUR",
+                "settled": true,
+            }
+        ],
+        "selfTradePrevention": "decrementAndCancel",
+        "visible": true,
+        "timeInForce": "GTC",
+        "postOnly": false,
+    },
+    {
+        "orderId": "da1d8330-d6b7-4753-800a-01ad510a679b",
+        "market": "BTC-EUR",
+        "created": 1548666570234,
+        "updated": 1548666570234,
+        "status": "filled",
+        "side": "sell",
+        "orderType": "limit",
+        "amount": "0.1",
+        "amountRemaining": "0",
+        "price": "4000",
+        "onHold": "0",
+        "onHoldCurrency": "BTC",
+        "filledAmount": "0.1",
+        "filledAmountQuote": "400",
+        "feePaid": "0.8",
+        "feeCurrency": "EUR",
+        "fills": [
+            {
+                "id": "79e4bf2f-4fac-4895-9bb2-a5c9c6e2ff3f",
+                "timestamp": 1548666712071,
+                "amount": "0.1",
+                "price": "4000",
+                "taker": false,
+                "fee": "0.8",
+                "feeCurrency": "EUR",
+                "settled": true,
+            }
+        ],
+        "selfTradePrevention": "decrementAndCancel",
+        "visible": true,
+        "timeInForce": "GTC",
+        "postOnly": false,
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Cancel orders
+
+Cancels all orders in a market. If no market is specified, all orders of an
+account will be canceled.
+
+```python
+# options: market
+websocket.cancelOrders({}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+  {
+    "orderId": "4f9a809b-859f-4d8d-97b3-037113cdf2d0"
+  },
+  {
+    "orderId": "95313ae5-ad65-4430-a0fb-63591bbc337c".
+  },
+  {
+    "orderId": "2465c3ab-5ae2-4d4d-bec7-345f51b3494d"
+  },
+  ...
+]
+```
+
+</details>
+
+#### Get orders open
+
+Returns all orders which are not filled or canceled.
+
+```python
+# options: market
+websocket.ordersOpen({}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "orderId": "bad72641-7755-464c-8dcb-7c1d59b142ab",
+        "market": "BTC-EUR",
+        "created": 1548670024870,
+        "updated": 1548670024870,
+        "status": "partiallyFilled",
+        "side": "buy",
+        "orderType": "limit",
+        "amount": "1",
+        "amountRemaining": "0.5",
+        "price": "3000",
+        "onHold": "1504.5",
+        "onHoldCurrency": "EUR",
+        "filledAmount": "0.5",
+        "filledAmountQuote": "1500",
+        "feePaid": "3",
+        "feeCurrency": "EUR",
+        "fills": [
+            {
+                "id": "108c3633-0276-4480-a902-17a01829deae",
+                "timestamp": 1548671992530,
+                "amount": "0.5",
+                "price": "3000",
+                "taker": false,
+                "fee": "3",
+                "feeCurrency": "EUR",
+                "settled": true,
+            }
+        ],
+        "selfTradePrevention": "decrementAndCancel",
+        "visible": true,
+        "timeInForce": "GTC",
+        "postOnly": false,
+    },
+    {
+        "orderId": "7586d610-2732-4ee6-8516-bed18cfc853b",
+        "market": "BTC-EUR",
+        "created": 1548670088749,
+        "updated": 1548670088749,
+        "status": "new",
+        "side": "buy",
+        "orderType": "limit",
+        "amount": "1",
+        "amountRemaining": "1",
+        "price": "3000",
+        "onHold": "3007.5",
+        "onHoldCurrency": "EUR",
+        "filledAmount": "0",
+        "filledAmountQuote": "0",
+        "feePaid": "0",
+        "feeCurrency": "EUR",
+        "fills": [],
+        "selfTradePrevention": "decrementAndCancel",
+        "visible": true,
+        "timeInForce": "GTC",
+        "postOnly": false,
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Get trades
+
+Returns all trades within a market for this account.
+
+```python
+# options: limit, start, end, tradeIdFrom, tradeIdTo
+websocket.trades("BTC-EUR", {}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "id": "108c3633-0276-4480-a902-17a01829deae",
+        "timestamp": 1548671992530,
+        "market": "BTC-EUR",
+        "side": "buy",
+        "amount": "0.5",
+        "price": "3000",
+        "taker": false,
+        "fee": "3",
+        "feeCurrency": "EUR",
+        "settled": true,
+    },
+    {
+        "id": "79e4bf2f-4fac-4895-9bb2-a5c9c6e2ff3f",
+        "timestamp": 1548666712071,
+        "market": "BTC-EUR",
+        "side": "sell",
+        "amount": "0.1",
+        "price": "4000",
+        "taker": false,
+        "fee": "0.8",
+        "feeCurrency": "EUR",
+        "settled": true,
+    },
+    {
+        "id": "102486d3-5b72-4fa2-89cf-84c934edb7ae",
+        "timestamp": 1548666561486,
+        "market": "BTC-EUR",
+        "side": "sell",
+        "amount": "0.1",
+        "price": "4000",
+        "taker": true,
+        "fee": "1",
+        "feeCurrency": "EUR",
+        "settled": true,
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Get account
+
+Returns the fee tier for this account.
+
+```python
+websocket.account(ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"fees": {"taker": "0.0025", "maker": "0.0015", "volume": "100.00"}}
+```
+
+</details>
+
+#### Get balance
+
+Returns the balance for this account.
+
+```python
+# options: symbol
+websocket.balance({}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {"symbol": "EUR", "available": "2599.95", "inOrder": "2022.65"},
+    {"symbol": "BTC", "available": "1.65437", "inOrder": "0.079398"},
+    {"symbol": "ADA", "available": "4.8", "inOrder": "0"},
+    {"symbol": "BCH", "available": "0.00952811", "inOrder": "0"},
+    {"symbol": "BSV", "available": "0.00952811", "inOrder": "0"},
+    ...,
+]
+```
+
+</details>
+
+#### Deposit assets
+
+Returns the address which can be used to deposit funds.
+
+```python
+websocket.depositAssets("BTC", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"address": "BitcoinAddress"}
+```
+
+</details>
+
+#### Withdraw assets
+
+Can be used to withdraw funds from Bitvavo.
+
+```python
+# optional parameters: paymentId, internal, addWithdrawalFee
+websocket.withdrawAssets("BTC", "1", "BitcoinAddress", {}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{"success": True, "symbol": "BTC", "amount": "1"}
+```
+
+</details>
+
+#### Get deposit history
+
+Returns the deposit history of your account.
+
+```python
+# options: symbol, limit, start, end
+websocket.depositHistory({}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "timestamp": 1521550025000,
+        "symbol": "EUR",
+        "amount": "1",
+        "fee": "0",
+        "status": "completed",
+        "address": "NL12RABO324234234",
+    },
+    {
+        "timestamp": 1511873910000,
+        "symbol": "BTC",
+        "amount": "0.099",
+        "fee": "0",
+        "status": "completed",
+        "txId": "0c6497e608212a516b8218674cb0ca04f65b67a00fe8bddaa1ecb03e9b029255",
+    },
+    ...,
+]
+```
+
+</details>
+
+#### Get withdrawal history
+
+Returns the withdrawal history of an account.
+
+```python
+# options: symbol, limit, start, end
+websocket.withdrawalHistory({}, ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+[
+    {
+        "timestamp": 1548425559000,
+        "symbol": "BTC",
+        "amount": "0.09994",
+        "fee": "0.00006",
+        "status": "awaiting_processing",
+        "address": "1CqtG5z55x7bYD5GxsAXPx59DEyujs4bjm",
+    },
+    {
+        "timestamp": 1548409721000,
+        "symbol": "EUR",
+        "amount": "50",
+        "fee": "0",
+        "status": "completed",
+        "address": "NL123BIM",
+    },
+    {
+        "timestamp": 1537803091000,
+        "symbol": "BTC",
+        "amount": "0.01939",
+        "fee": "0.00002",
+        "status": "completed",
+        "txId": "da2299c86fce67eb899aeaafbe1f81cf663a3850cf9f3337c92b2d87945532db",
+        "address": "3QpyxeA7yWWsSURXEmuBBzHpxjqn7Rbyme",
+    },
+    ...,
+]
+```
+
+</details>
+
+### Subscriptions
+
+#### Ticker subscription
+
+Sends an update every time the best bid, best ask or last price changed.
+
+```python
+websocket.subscriptionTicker("BTC-EUR", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "event": "ticker",
+    "market": "BTC-EUR",
+    "bestBid": "9286.9",
+    "bestBidSize": "0.10705272",
+    "bestAsk": "9287.6",
+    "bestAskSize": "0.10990704",
+    "lastPrice": "9335",
+}
+```
+
+</details>
+
+#### Ticker 24 hour subscription
+
+Updated ticker24h objects are sent on this channel once per second. A ticker24h
+object is considered updated if one of the values besides timestamp has changed.
+
+```python
+websocket.subscriptionTicker24h("BTC-EUR", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "market": "BTC-EUR",
+    "open": "10140",
+    "high": "10216",
+    "low": "10062",
+    "last": "10119",
+    "volume": "37.59541492",
+    "volumeQuote": "381752.87",
+    "bid": "10118",
+    "bidSize": "0.07267404",
+    "ask": "10119",
+    "askSize": "0.09386124",
+    "timestamp": 1565685285795,
+}
+```
+
+</details>
+
+#### Account subscription
+
+Sends an update whenever an event happens which is related to the account. These
+are ‘order’ events (create, update, cancel) or ‘fill’ events (a trade occurred).
+
+```python
+websocket.subscriptionAccount("BTC-EUR", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+Fill:
+{
+  "event": "fill",
+  "timestamp": 1548674189411,
+  "market": "BTC-EUR",
+  "orderId": "78fef2d4-6278-4f4b-ade9-1a1c438680e5",
+  "fillId": "90d49d30-9d90-427d-ab4d-35d18c3356cb",
+  "side": "buy",
+  "amount": "0.03322362",
+  "price": "3002.4",
+  "taker": true,
+  "fee": "0.249403312",
+  "feeCurrency": "EUR"
+}
+
+Order:
+{
+  "event": "order",
+  "orderId": "78fef2d4-6278-4f4b-ade9-1a1c438680e5",
+  "market": "BTC-EUR",
+  "created": 1548674189406,
+  "updated": 1548674189406,
+  "status": "filled",
+  "side": "buy",
+  "orderType": "market",
+  "amountQuote": "100",
+  "amountQuoteRemaining": "0.249403312",
+  "onHold": "0",
+  "onHoldCurrency": "EUR",
+  "selfTradePrevention": "decrementAndCancel",
+  "visible": false,
+  "disableMarketProtection": false
+}
+```
+
+</details>
+
+#### Candles subscription
+
+Sends an updated candle after each trade for the specified interval and market.
+
+```python
+websocket.subscriptionCandles("BTC-EUR", "1h", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "event": "candle",
+    "market": "BTC-EUR",
+    "interval": "1h",
+    "candle": [[1548676800000, "2999.3", "2999.3", "2990.5", "2999.3", "11.15058838"]],
+}
+```
+
+</details>
+
+#### Trades subscription
+
+Sends an update whenever a trade has happened on this market. For your own
+trades, please subscribe to account.
+
+```python
+websocket.subscriptionTrades("BTC-EUR", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "event": "trade",
+    "timestamp": 1548677539543,
+    "market": "BTC-EUR",
+    "id": "d91bf798-e704-4f09-95f7-3444f8109346",
+    "amount": "0.88114879",
+    "price": "2992.2",
+    "side": "buy",
+}
+```
+
+</details>
+
+#### Book subscription
+
+Sends an update whenever the order book for this specific market has changed. A
+list of tuples (\[price, amount\]) are returned, where amount ‘0’ means that
+there are no more orders at this price. If you wish to maintain your own copy of
+the order book, consider using the next function.
+
+```python
+websocket.subscriptionBookUpdate("BTC-EUR", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "event": "book",
+    "market": "BTC-EUR",
+    "nonce": 14870,
+    "bids": [["2994.3", "0"], ["2994.2", "0.00334147"]],
+    "asks": [],
+}
+```
+
+</details>
+
+#### Book subscription with local copy
+
+This is a combination of get book per market and the book subscription which
+maintains a local copy. On every update to the order book, the entire order book
+is returned to the callback, while the book subscription will only return
+updates to the book.
+
+```python
+websocket.subscriptionBook("BTC-EUR", ownCallback)
+```
+
+<details>
+ <summary>View Response</summary>
+
+```python
+{
+    "bids": [
+        ["2996.7", "0.36620062"],
+        ["2994.8", "0.04231826"],
+        ["2994.2", "0.16617026"],
+        ["2993.7", "0.23002489"],
+        ...,
+    ],
+    "asks": [
+        ["2998.6", "8.64251588"],
+        ["3001.2", "5.91405558"],
+        ["3002.4", "3.5765691"],
+        ["3003.9", "3.842524"],
+        ...,
+    ],
+    "nonce": 21919,
+    "market": "BTC-EUR",
+}
+```
+
+</details>