Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dutu/gemini-api-node
Gemini API client for REST and WebSocket
https://github.com/dutu/gemini-api-node
api api-client api-wrapper bitcoin cryptocurrency gemini gemini-api promise push-api rest rest-api sandbox websocket websocket-api
Last synced: 18 days ago
JSON representation
Gemini API client for REST and WebSocket
- Host: GitHub
- URL: https://github.com/dutu/gemini-api-node
- Owner: dutu
- License: mit
- Created: 2019-03-22T08:21:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:41:21.000Z (about 2 years ago)
- Last Synced: 2024-12-17T07:59:51.974Z (about 2 months ago)
- Topics: api, api-client, api-wrapper, bitcoin, cryptocurrency, gemini, gemini-api, promise, push-api, rest, rest-api, sandbox, websocket, websocket-api
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/gemini-api-node
- Size: 548 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
gemini-api-node
====
[](https://travis-ci.com/dutu/gemini-api-node) [](https://dependencyci.com/github/dutu/gemini-api-node)
**gemini-api-node** is a simple node.js wrapper for Gemini REST and WebSocket API.
### Contents
* [Changelog](#changelog)
* [Installation](#installation)
* [Quick examples](#quick-examples)
* [API](#api)
* [Contributors](#contributors)
* [License](#license)
# Changelog
See detailed [Changelog](CHANGELOG.md)
# Installation
```
npm install --save gemini-api-node
```
# Quick examples
Clients for both the [REST API](https://docs.gemini.com/rest-api/) and
[streaming WebSocket API](https://docs.gemini.com/websocket-api/) are included.
Private endpoints as indicated in the API docs require authentication with an API
key and secret key.
### REST API example:
```js
import Gemini from 'gemini-api-node'
const gemini = new Gemini({ key, secret, sandbox: false })
gemini.getOrderBook('btcusd', { limit_asks: 10, limit_bids: 10 })
.then(console.log)
.catch(console.error)
```
### WebSocket API examples:
```js
import Gemini from 'gemini-api-node'
const gemini = new Gemini()
let ws = gemini.newWebSocketMarketData('btcusd', { 'top_of_book' : 'true', 'offers': true })
ws.onopen = () => {
console.log('Websocket is open')
}
ws.onmessage = (message) => {
let data = JSON.parse(message.data)
console.log('Websocket data received')
}
```
```js
import Gemini from 'gemini-api-node'
const gemini = new Gemini({ key, secret, sandbox: true })
let ws = gemini.newWebSocketOrderEvents({ symbolFilter: ['btcusd'], eventTypeFilter: ['fill', 'closed']})
ws.onopen = () => {
console.log('Websocket is open')
}
ws.onmessage = (message) => {
let data = JSON.parse(message.data)
console.log('Websocket data received')
}
```
# API
## REST
All methods return promises.
* `getAllSymbols()`
* `getTicker(symbol)`
* `getOrderBook(symbol, params = {})`
* `getTradeHistory(symbol, params = {})`
* `getCurrentAuction(symbol)`
* `getAuctionHistory(symbol, params = {})`
* `newOrder(params = {})`
* `cancelOrder({ order_id })`
* `cancelAllSessionOrders()`
* `cancelAllActiveOrders()`
* `getMyOrderStatus({ order_id })`
* `getMyActiveOrders()`
* `getMyPastTrades(params = {})`
* `getMyTradeVolume()`
* `getMyAvailableBalances()`
* `newAddress(currency)`
## WebSocket
All methods return a [`WebSocket`](https://github.com/websockets/ws) object.
* `newWebSocketMarketData(symbol, params = {})`
* `newWebSocketOrderEvents(params = {})`
# License
[MIT](LICENSE)