Skip to content
This repository was archived by the owner on Oct 30, 2023. It is now read-only.

Commit f24320e

Browse files
authored
Futures API
1 parent ec0e5d3 commit f24320e

1 file changed

Lines changed: 24 additions & 36 deletions

File tree

README.md

Lines changed: 24 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
1-
![Downloads](https://img.shields.io/npm/dt/node-binance-api.svg?style=for-the-badge&maxAge=86400) ![Stars](https://img.shields.io/github/stars/jaggedsoft/node-binance-api.svg?style=for-the-badge&label=Stars) ![Contributors](https://img.shields.io/github/contributors/jaggedsoft/node-binance-api.svg?style=for-the-badge&maxAge=86400)
2-
3-
[![Latest Version](https://img.shields.io/github/release/jaggedsoft/node-binance-api.svg?style=flat-square)](https://github.com/jaggedsoft/node-binance-api/releases)
4-
[![GitHub last commit](https://img.shields.io/github/last-commit/jaggedsoft/node-binance-api.svg?maxAge=2400)](#)
5-
<!-- [![npm downloads](https://img.shields.io/npm/dt/node-binance-api.svg?maxAge=7200)](https://www.npmjs.com/package/node-binance-api) -->
6-
[![jaggedsoft on Twitter](https://img.shields.io/twitter/follow/jaggedsoft.svg?style=social)](https://twitter.com/jaggedsoft)
1+
[![Latest Version](https://img.shields.io/github/release/jaggedsoft/node-binance-api.svg?style=flat-square)](https://github.com/jaggedsoft/node-binance-api/releases) [![GitHub last commit](https://img.shields.io/github/last-commit/jaggedsoft/node-binance-api.svg?maxAge=2400)](#) <!-- [![npm downloads](https://img.shields.io/npm/dt/node-binance-api.svg?maxAge=7200)](https://www.npmjs.com/package/node-binance-api) --> [![jaggedsoft on Twitter](https://img.shields.io/twitter/follow/jaggedsoft.svg?style=social)](https://twitter.com/jaggedsoft)
72

83
[![NPM](https://nodei.co/npm/node-binance-api.png?compact=true)](https://npmjs.org/package/node-binance-api)
94

10-
[![Build Status](https://travis-ci.org/jaggedsoft/node-binance-api.svg?branch=master&style=flat-square)](https://travis-ci.org/jaggedsoft/node-binance-api)
11-
[![Coverage Status](https://coveralls.io/repos/github/jaggedsoft/node-binance-api/badge.svg?branch=master&style=flat-square)](https://coveralls.io/github/jaggedsoft/node-binance-api)
12-
[![CodeCov](https://codecov.io/gh/jaggedsoft/node-binance-api/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/github/jaggedsoft/node-binance-api/)
13-
<!-- [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/996757cec66542c0a64fca2b4cf8a936)](https://www.codacy.com/app/jaggedsoft/node-binance-api?utm_source=github.com&utm_medium=referral&utm_content=jaggedsoft/node-binance-api&utm_campaign=Badge_Coverage) -->
14-
[![Codacy Grade](https://api.codacy.com/project/badge/Grade/996757cec66542c0a64fca2b4cf8a936)](https://www.codacy.com/app/jaggedsoft/node-binance-api)
5+
[![Build Status](https://travis-ci.org/jaggedsoft/node-binance-api.svg?branch=master&style=flat-square)](https://travis-ci.org/jaggedsoft/node-binance-api) [![Coverage Status](https://coveralls.io/repos/github/jaggedsoft/node-binance-api/badge.svg?branch=master&style=flat-square)](https://coveralls.io/github/jaggedsoft/node-binance-api) [![CodeCov](https://codecov.io/gh/jaggedsoft/node-binance-api/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/github/jaggedsoft/node-binance-api/) <!-- [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/996757cec66542c0a64fca2b4cf8a936)](https://www.codacy.com/app/jaggedsoft/node-binance-api?utm_source=github.com&utm_medium=referral&utm_content=jaggedsoft/node-binance-api&utm_campaign=Badge_Coverage) --> [![Codacy Grade](https://api.codacy.com/project/badge/Grade/996757cec66542c0a64fca2b4cf8a936)](https://www.codacy.com/app/jaggedsoft/node-binance-api)
156

167
# Node Binance API
178
This project is designed to help you make your own projects that interact with the [Binance API](https://github.com/binance-exchange/binance-official-api-docs). You can stream candlestick chart data, market depth, or use other advanced features such as setting stop losses and iceberg orders. This project seeks to have complete API coverage including WebSockets.
@@ -34,25 +25,25 @@ const binance = new Binance().options({
3425
# Binance Futures API
3526
> **Work in progress, including documentation. Promises only**
3627
```js
37-
console.info( await api.futuresPrices() );
38-
console.info( await api.futuresTime() );
39-
console.info( await api.futuresExchangeInfo() );
40-
console.info( await api.futuresCandles( "TRXUSDT", "1m" ) );
41-
console.info( await api.futuresDepth( "ADAUSDT" ) );
42-
console.info( await api.futuresQuote() );
43-
console.info( await api.futuresQuote( "BCHUSDT" ) );
44-
console.info( await api.futuresDaily() );
45-
console.info( await api.futuresOpenInterest( "BTCUSDT" ) );
46-
console.info( await api.futuresMarkPrice() );
47-
console.info( await api.futuresMarkPrice( "ETHUSDT" ) );
48-
console.info( await api.futuresTrades( "LTCUSDT" ) );
49-
console.info( await api.futuresAggTrades( "XTZUSDT" ) );
50-
console.info( await api.futuresLiquidationOrders() );
51-
console.info( await api.futuresFundingRate() );
52-
console.info( await api.futuresHistoricalTrades( "XMRUSDT" ) );
53-
console.info( await api.futuresLeverageBracket( "LINKUSDT" ) );
54-
55-
// Currently in development:
28+
console.info( await binance.futuresPrices() );
29+
console.info( await binance.futuresTime() );
30+
console.info( await binance.futuresExchangeInfo() );
31+
console.info( await binance.futuresCandles( "TRXUSDT", "1m" ) );
32+
console.info( await binance.futuresDepth( "ADAUSDT" ) );
33+
console.info( await binance.futuresQuote() );
34+
console.info( await binance.futuresQuote( "BCHUSDT" ) );
35+
console.info( await binance.futuresDaily() );
36+
console.info( await binance.futuresOpenInterest( "BTCUSDT" ) );
37+
console.info( await binance.futuresMarkPrice() );
38+
console.info( await binance.futuresMarkPrice( "ETHUSDT" ) );
39+
console.info( await binance.futuresTrades( "LTCUSDT" ) );
40+
console.info( await binance.futuresAggTrades( "XTZUSDT" ) );
41+
console.info( await binance.futuresLiquidationOrders() );
42+
console.info( await binance.futuresFundingRate() );
43+
console.info( await binance.futuresHistoricalTrades( "XMRUSDT" ) );
44+
console.info( await binance.futuresLeverageBracket( "LINKUSDT" ) );
45+
46+
/* Currently in development:
5647
futuresMarketBuy
5748
futuresMarketSell
5849
futuresOrderStatus
@@ -63,18 +54,13 @@ futuresPositionRisk: private 'v1/positionRisk'
6354
futuresGetDataStream: private 'v1/listenKey' 'POST'
6455
futuresKeepDataStream: private 'v1/listenKey' 'PUT'
6556
futuresCloseDataStream: private 'v1/listenKey' 'DELETE'
66-
Futures WebSockets
57+
Futures WebSockets */
6758
```
6859

6960
#### Getting latest price of all symbols
7061
```javascript
7162
let ticker = await binance.prices();
7263
console.log(`Price of BNB: ${ticker.BNBUSDT}`);
73-
74-
binance.prices((error, ticker) => {
75-
console.log("prices()", ticker);
76-
console.log("Price of BTC: ", ticker.BTCUSDT);
77-
});
7864
```
7965

8066
#### Getting latest price of a symbol
@@ -1723,3 +1709,5 @@ binance.useServerTime(() => {
17231709

17241710
[![Views](http://hits.dwyl.io/jaggedsoft/node-binance-api.svg)](http://hits.dwyl.io/jaggedsoft/node-binance-api)
17251711
[![jaggedsoft on Twitter](https://img.shields.io/twitter/follow/jaggedsoft.svg?style=social)](https://twitter.com/jaggedsoft)
1712+
1713+
![Downloads](https://img.shields.io/npm/dt/node-binance-api.svg?style=for-the-badge&maxAge=86400) ![Stars](https://img.shields.io/github/stars/jaggedsoft/node-binance-api.svg?style=for-the-badge&label=Stars) ![Contributors](https://img.shields.io/github/contributors/jaggedsoft/node-binance-api.svg?style=for-the-badge&maxAge=86400)

0 commit comments

Comments
 (0)