binance-api-react-native  

> A complete API wrapper for the Binance API.

This wrapper is a adaptation of a
https://github.com/HyperCubeProject/binance-api-node for React Native
1) crypto is replaced with crypto-js
2) fetch?
3) fixed issue with Packager and .babelrc

$3

yarn add binance-api-react-native

$3

Import the module and create a new client. Passing api keys is optional only if
you don't plan on doing authenticated calls. You can create an api key
here.

``js
import Binance from 'binance-api-react-native'

const client = Binance()

// Authenticated client, can make signed calls
const client2 = Binance({
apiKey: 'xxx',
apiSecret: 'xxx',
})

client.time().then(time => console.log(time))
`

If you do not have an appropriate babel config, you will need to use the basic commonjs requires.

`js
const Binance = require('binance-api-node').default
`

Every REST method returns a Promise, making this library async await ready.
Following examples will use the await form, which requires some configuration you will have to lookup.

$3

- Public REST Endpoints
- ping
- time
- exchangeInfo
- book
- candles
- aggTrades
- trades
- dailyStats
- prices
- allBookTickers
- Authenticated REST Endpoints
- order
- orderTest
- getOrder
- cancelOrder
- openOrders
- allOrders
- accountInfo
- myTrades
- tradesHistory
- depositHistory
- withdrawHistory
- withdraw
- depositAddress
- Websockets
- depth
- partialDepth
- ticker
- allTickers
- candles
- aggTrades
- trades
- user
- ErrorCodes

$3

#### ping

Test connectivity to the API.

`js
console.log(await client.ping())
`

#### time

Test connectivity to the Rest API and get the current server time.

`js
console.log(await client.time())
`

#### exchangeInfo

Get the current exchange trading rules and symbol information.

`js
console.log(await client.exchangeInfo())
`

#### book

Get the order book for a symbol.

`js
console.log(await client.book({ symbol: 'ETHBTC' }))
`

|Param|Type|Required|Default|
|--- |--- |--- |--- |
|symbol|String|true|
|limit|Number|false|100|

#### candles

Retrieves Candlestick for a symbol. Candlesticks are uniquely identified by their open time.

`js
console.log(await client.candles({ symbol: 'ETHBTC' }))
`

|Param|Type|Required|Default|Description|
|--- |--- |--- |--- |--- |
|symbol|String|true|
|interval|String|false|5m|1m, 3m, 5m, 15m, 30m, 1h, 2h,
4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M|
|limit|Number|false|500|Max 500|
|startTime|Number|false|
|endTime|Number|false|

#### aggTrades

Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.

`js
console.log(await client.aggTrades({ symbol: 'ETHBTC' }))
`

|Param|Type|Required|Default|Description|
|--- |--- |--- |--- |--- |
|symbol|String|true|
|fromId|String|false||ID to get aggregate trades from INCLUSIVE.|
|startTime|Number|false||Timestamp in ms to get aggregate trades from INCLUSIVE.
|endTime|Number|false||Timestamp in ms to get aggregate trades until INCLUSIVE.|
|limit|Number|false|500|Max 500|

Note: If both startTime and endTime are sent, limit should not be sent AND the distance between startTime and endTime must be less than 24 hours.

Note: If frondId, startTime, and endTime are not sent, the most recent aggregate trades will be returned.

#### trades

Get recent trades of a symbol.

`js
console.log(await client.trades({ symbol: 'ETHBTC' }))
`

|Param|Type|Required|Default|Description|
|--- |--- |--- |--- |--- |
|symbol|String|true|
|limit|Number|false|500|Max 500|

#### dailyStats

24 hour price change statistics, not providing a symbol will return all tickers and is resource-expensive.

`js
console.log(await client.dailyStats({ symbol: 'ETHBTC' }))
`

|Param|Type|Required|
|--- |--- |--- |
|symbol|String|false|

#### prices

Latest price for all symbols.

`js
console.log(await client.prices())
`

#### allBookTickers

Best price/qty on the order book for all symbols.

`js
console.log(await client.allBookTickers())
`

$3

Note that for all authenticated endpoints, you can pass an extra parameter
useServerTime set to true in order to fetch the server time before making
the request.

#### order

Creates a new order.

`js
console.log(await client.order({
symbol: 'XLMETH',
side: 'BUY',
quantity: 100,
price: 0.0002,
}))
`

|Param|Type|Required|Default|Description|
|--- |--- |--- |--- |--- |
|symbol|String|true|
|side|String|true||BUY,SELL|
|type|String|false|LIMIT|LIMIT, MARKET|
|quantity|Number|true|
|price|Number|true||Optional for MARKET orders|
|timeInForce|String|false|GTC|FOK, GTC, IOC|
|newClientOrderId|String|false||A unique id for the order. Automatically generated if not sent.|
|stopPrice|Number|false||Used with stop orders|
|newOrderRespType|String|false|RESULT|Returns more complete info of the order. ACK, RESULT, or FULL|
|icebergQty|Number|false||Used with iceberg orders|
|recvWindow|Number|false|

Additional mandatory parameters based on type:

Type | Additional mandatory parameters
------------ | ------------
LIMIT | timeInForce, quantity, price
MARKET | quantity
STOP_LOSS | quantity, stopPrice
STOP_LOSS_LIMIT | timeInForce, quantity, price, stopPrice
TAKE_PROFIT | quantity, stopPrice
TAKE_PROFIT_LIMIT | timeInForce, quantity, price, stopPrice
LIMIT_MAKER | quantity, price

* LIMIT_MAKER are LIMIT orders that will be rejected if they would immediately match and trade as a taker.
* STOP_LOSS and TAKE_PROFIT will execute a MARKET order when the stopPrice is reached.
* Any LIMIT or LIMIT_MAKER type order can be made an iceberg order by sending an icebergQty.
* Any order with an icebergQty MUST have timeInForce set to GTC.

#### orderTest

Test new order creation and signature/recvWindow. Creates and validates a new order but does not send it into the matching engine.

Same API as above, but does not return any output on success.

#### getOrder

Check an order's status.

`js
console.log(await client.getOrder({
symbol: 'ETHBTC',
orderId: 1,
}))
`

|Param|Type|Required|Description|
|--- |--- |--- |--- |
|symbol|String|true|
|orderId|Number|true|Not required if origClientOrderId is used|
|origClientOrderId|String|false|
|recvWindow|Number|false|

#### cancelOrder

Cancels an active order.

`js
console.log(await client.cancelOrder({
symbol: 'ETHBTC',
orderId: 1,
}))
`

|Param|Type|Required|Description|
|--- |--- |--- |--- |
|symbol|String|true|
|orderId|Number|true|Not required if origClientOrderId is used|
|origClientOrderId|String|false|
|newClientOrderId|String|false|Used to uniquely identify this cancel. Automatically generated by default.|
|recvWindow|Number|false|

#### openOrders

Get all open orders on a symbol.

`js
console.log(await client.openOrders({
symbol: 'XLMBTC',
}))
`

|Param|Type|Required|
|--- |--- |--- |
|symbol|String|true|
|recvWindow|Number|false|

#### allOrders

Get all account orders on a symbol; active, canceled, or filled.

`js
console.log(await client.allOrders({
symbol: 'ETHBTC',
}))
`

|Param|Type|Required|Default|Description|
|--- |--- |--- |--- |--- |
|symbol|String|true|
|orderId|Number|false||If set, it will get orders >= that orderId. Otherwise most recent orders are returned.|
|limit|Number|false|500|Max 500|
|recvWindow|Number|false|

#### accountInfo

Get current account information.

`js
console.log(await client.accountInfo())
`

|Param|Type|Required|
|--- |--- |--- |
|recvWindow|Number|false|

#### myTrades

Get trades for the current authenticated account and symbol.

`js
console.log(await client.myTrades({
symbol: 'ETHBTC',
}))
`

|Param|Type|Required|Default|Description|
|--- |--- |--- |--- |--- |
|symbol|String|true|
|limit|Number|false|500|Max 500|
|fromId|Number|false||TradeId to fetch from. Default gets most recent trades.|
|recvWindow|Number|false|

#### tradesHistory

Lookup symbol trades history.

`js
console.log(await client.tradesHistory({ symbol: 'ETHBTC' }))
`

|Param|Type|Required|Default|Description|
|--- |--- |--- |--- |--- |
|symbol|String|true|
|limit|Number|false|500|Max 500|
|fromId|Number|false|null|TradeId to fetch from. Default gets most recent trades.|

#### depositHistory

Get the account deposit history.

`js
console.log(await client.depositHistory())
`

|Param|Type|Required|Description|
|--- |--- |--- |--- |
|asset|String|false|
|status|Number|false|0 (0: pending, 1: success)|
|startTime|Number|false|
|endTime|Number|false|
|recvWindow|Number|false|

#### withdrawHistory

Get the account withdraw history.

`js
console.log(await client.withdrawHistory())
`

|Param|Type|Required|Description|
|--- |--- |--- |--- |
|asset|String|false|
|status|Number|false|0 (0: Email Sent, 1: Cancelled 2: Awaiting Approval, 3: Rejected, 4: Processing, 5: Failure, 6: Completed)|
|startTime|Number|false|
|endTime|Number|false|
|recvWindow|Number|false|

#### withdraw

Triggers the withdraw process (untested for now).

`js
console.log(await client.withdraw({
asset: 'ETH',
address: '0xfa97c22a03d8522988c709c24283c0918a59c795',
amount: 100,
}))
`

|Param|Type|Required|Description|
|--- |--- |--- |--- |
|asset|String|true|
|address|String|true|
|amount|Number|true|
|name|String|false|Description of the address|
|recvWindow|Number|false|

#### depositAddress

Retrieve the account deposit address for a specific asset.

`js
console.log(await client.depositAddress({ asset: 'NEO' }))
`

|Param|Type|Required|Description|
|--- |--- |--- |--- |
|asset|String|true|The asset name|

$3

Every websocket utility returns a function you can call to close the opened
connection and avoid memory issues.

`js
const clean = client.ws.depth('ETHBTC', depth => {
console.log(depth)
})

// After you're done
clean()
`

#### depth

Live depth market data feed. The first parameter can either
be a single symbol string or an array of symbols.

`js
client.ws.depth('ETHBTC', depth => {
console.log(depth)
})
`

#### partialDepth

Top levels bids and asks, pushed every second. Valid levels are 5, 10, or 20.
Accepts an array of objects for multiple depths.

`js
client.ws.partialDepth({ symbol: 'ETHBTC', level: 10 }, depth => {
console.log(depth)
})
`

#### ticker

24hr Ticker statistics for a symbol pushed every second. Accepts an array of symbols.

`js
client.ws.ticker('HSRETH', ticker => {
console.log(ticker)
})
`

#### allTickers

Retrieves all the tickers.

`js
client.ws.allTickers(tickers => {
console.log(tickers)
})
`

#### candles

Live candle data feed for a given interval. You can pass either a symbol string
or a symbol array.

`js
client.ws.candles('ETHBTC', '1m', candle => {
console.log(candle)
})
`

#### trades

Live trade data feed. Pass either a single symbol string or an array of symbols. The trade streams push raw trade information; each trade has a unique buyer and seller.

`js
client.ws.trades(['ETHBTC', 'BNBBTC'], trade => {
console.log(trade)
})
`

#### aggTrades

Live trade data feed. Pass either a single symbol string or an array of symbols. The aggregate trade streams push trade information that is aggregated for a single taker order.

`js
client.ws.aggTrades(['ETHBTC', 'BNBBTC'], trade => {
console.log(trade)
})
`

#### user

Live user messages data feed.

Requires authentication

`js
const clean = await client.ws.user(msg => {
console.log(msg)
})
`

Note that this method returns a promise which will resolve the clean callback.

$3

An utility error code map is also being exported by the package in order for you to make readable
conditionals upon specific errors that could occur while using the API.

`js
import Binance, { ErrorCodes } from 'binance-api-node'

console.log(ErrorCodes.INVALID_ORDER_TYPE) // -1116
``