-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
53 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,54 @@ | ||
# node-kiwicoin | ||
Unofficial kiwi-coin.com API client for Node.js | ||
Unofficial [Kiwi-Coin.com](https://kiwi-coin.com) API client for Node.js. | ||
|
||
## Installation | ||
|
||
The package is available on [NPM](https://www.npmjs.com/package/kiwicoin) as `kiwicoin`. | ||
|
||
```Shell | ||
npm install kiwicoin | ||
``` | ||
|
||
## Usage | ||
|
||
Using the private services: | ||
|
||
```javascript | ||
var Kiwicoin = require('kiwicoin'); | ||
|
||
var kiwiClient = new Kiwicoin("YourUserId", "YourApiKey", "YourSecret"); | ||
kiwiClient.balance(function(err, info) { | ||
console.log(err, info); | ||
}); | ||
``` | ||
|
||
Take a look on the wiki to get instructions on how to: | ||
|
||
* [Find my userId](<https://github.com/wcomnisky/node-kiwicoin/wiki/Kiwi-Coin#how-to-find-the-userid>) | ||
* [Create/Enable my API Key and Secret](<https://github.com/wcomnisky/node-kiwicoin/wiki/Kiwi-Coin#how-to-createfindenable-the-api-key>) | ||
|
||
If you just want to use the public services you __don't need__ to provide the userID / API Key / Secret. | ||
|
||
The public services are: | ||
|
||
* Ticker (`ticker`) | ||
* Order book (`order_book`) | ||
|
||
```javascript | ||
var Kiwicoin = require('kiwicoin'); | ||
|
||
var kiwiClient = new Kiwicoin(); | ||
kiwiClient.ticker(function(err, info) { | ||
console.log(err, info); | ||
}); | ||
``` | ||
|
||
### Kiwi-Coin Request limits | ||
|
||
Be aware about their limits: | ||
|
||
> _Do not make more than 600 requests per 10 minutes or we will ban your IP address._ | ||
## License | ||
|
||
[MIT](LICENSE) |