Skip to content

Commit dd5b639

Browse files
First readme update.
1 parent cfa197a commit dd5b639

File tree

1 file changed

+42
-4
lines changed

1 file changed

+42
-4
lines changed

README.md

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,45 @@
1-
<p align="center">
2-
<br>
3-
<a href="https://bitvavo.com"><img src="https://bitvavo.com/assets/static/ext/logo-shape.svg" width="100" title="Bitvavo Logo"></a>
4-
</p>
1+
2+
<table cellspacing="0" cellpadding="0" border="0" >
3+
<tr>
4+
<td>
5+
<table cellspacing="3" border="0">
6+
<tr>
7+
<td><a href="https://bitvavo.com"><img src="https://bitvavo.com/press/blue/bitvavo-mark-square/bitvavo-mark-square-blue.svg" width="100" title="Bitvavo Logo"></td>
8+
<td><h1>Bitvavo API for Python</h1></td>
9+
</tr>
10+
</table>
11+
</td>
12+
</tr>
13+
<tr align="center">
14+
<td rowspan="2"> <a href="https://github.com/bitvavo/python-bitvavo-api.git" alt="Downloads">
15+
<img src="https://img.shields.io/npm/dt/bitvavo.svg?style=flat-square" /></a></td>
16+
</tr>
17+
</table>
18+
19+
Crypto starts with Bitvavo. You use Bitvavo API for Node.js to buy, sell and store over 200 digital assets on Bitvavo from inside your own app.
20+
21+
To trade and execute your advanced trading strategies, Bitvavo API for Node.js is a wrapper that enables you to easily call every endpoint in [Bitvavo API](https://docs.bitvavo.com/)
22+
23+
## Prerequisites
24+
25+
To start programming with Bitvavo API for Node.js you need:
26+
27+
- [Node.js](https://nodejs.org/en) installed on your development environment
28+
- An [API key and secret](https://support.bitvavo.com/hc/en-us/articles/4405059841809) associated with your Bitvavo account
29+
30+
You control the actions your app has rights to do using the rights you assign to the API key. Possible rights are:
31+
- **View**: retrieve information about your balance, account, deposit and withdrawals.
32+
- **Trade**: place, update, view and cancel orders.
33+
- **Withdraw**: withdraw funds. Best practice is to not grant his privilage, withdrawals using the API do not require 2FA and e-mail confirmation.
34+
35+
## Get started
36+
37+
38+
39+
1. In your development environment, install the Bitvavo API for Node.js package from npm:
40+
```terminal
41+
npm i bitvavo
42+
```
543

644
# Python Bitvavo Api
745
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/)

0 commit comments

Comments
 (0)