bitflyer-promise/README.md

Bitflyer API helper with Promise

# bitflyer node
## How to
```typescript
import { Bitflyer } from 'bitflyer-promise'

const bitflyer = new Bitflyer();

bitflyer.get_balance()
.then(console.log)
.catch(console.error)
```

## Set credential
key and secret are specified by following order

1. call bitflyer.set_credentials(key, secret);
2. set Environment Variable BITFLYER_KEY and BITFLYER_SECRET

## With options
```typescript
import { Bitflyer } from 'bitflyer-promise'

const bitflyer = new Bitflyer();

bitflyer.send_child_order({
  product_code: 'BTC_JPY',
  child_order_type: 'LIMIT',
  side: 'BUY',
  price: 100000,
  size: 0.001,
  minute_to_expire: 30,
})
.then(console.log)
.catch(console.error)
```

## Using streaming API
Currently not supported.  
Please use [bitflyer-node](https://www.npmjs.com/package/bitflyer-node)

## Any issues?
please notify me on https://github.com/kiyonori-matsumoto/bitflyer-promise/issues