Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pioug/poloniex
A tiny Node.js wrapper for Poloniex API
https://github.com/pioug/poloniex
api bitcoin cryptocurrency exchange poloniex
Last synced: 2 days ago
JSON representation
A tiny Node.js wrapper for Poloniex API
- Host: GitHub
- URL: https://github.com/pioug/poloniex
- Owner: pioug
- License: mit
- Created: 2017-07-08T13:42:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-17T12:40:28.000Z (about 7 years ago)
- Last Synced: 2024-11-13T17:54:43.900Z (5 days ago)
- Topics: api, bitcoin, cryptocurrency, exchange, poloniex
- Language: JavaScript
- Homepage: https://npm.im/@pioug/poloniex
- Size: 8.79 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @pioug/poloniex
> A tiny Node.js wrapper for Poloniex API.
I created this module because I believe that simple and readable code matters for code audit since [Poloniex API](https://poloniex.com/) can be used for trading real money.
## Features
- Complete implementation of Poloniex HTTP API
- About 100 lines on code
- One dependency ([axios](https://github.com/mzabriskie/axios))
- Promise-based
- Environment variables for API key and secret
## Setup
### Requirements
- Node 8 (for **object rest and spread properties** support)
- npm 5.1.0 (for **npm lockfiles** support)
### Installation
```sh
npm install --save @pioug/poloniex
```
## Usage
It is recommended to use environment variables for `POLONIEX_KEY` and `POLONIEX_SECRET`:
```sh
POLONIEX_KEY=my_api_key POLONIEX_SECRET=my_secret node app.js
```
The wrapper API is following this format:
```
Poloniex.()
```
For authenticated requests (_trading API_), additional parameters can be passed:
- **nonce**: An integer which must always be greater than the previous nonce used
- Optional
- Default is `Date.now()`
- **key**: Your Poloniex API key
- Optional
- Default is `process.env.POLONIEX_KEY`
- **secret**: Your Poloniex key secret
- Optional
- Default is `process.env.POLONIEX_SECRET`
Every method returns a promise.
## Code example
### Public request
```js
const Poloniex = require('@pioug/poloniex');
Poloniex.returnLoanOrders({
currency: 'BTC'
})
.then(console.log);
```
### Authenticated request
```js
const Poloniex = require('@pioug/poloniex');
Poloniex.buy({
amount: '338.8732',
currencyPair: 'BTC_XVC',
rate: '0.00000173',
nonce: 1
key: 'my_api_key',
secret: 'my_secret'
})
.then(console.log);
```
## API Reference
See the full documentation of Poloniex API: https://poloniex.com/support/api/.