Skip to content
Brent Kirkland edited this page Nov 10, 2017 · 18 revisions

v1 REST API

Here is some documentation that will help you along your way. If you would like to read more, visit the Bitfinex Docs

Install

Install bitfinex-api-node via npm:

npm install bitfinex-api-node

new BFX(APIKey, APISecret, opts).rest

Param Type Description
APIKey string Your BFX API Key
APISecret string Your BFX Secret Key
Opts object opts = {version: 1}

where Opts consists of:

const opts = {
  version: 1 // for v1
}

BFX.ticker(pair, cb)

Param Type Description
pair string BTCUSD, LTCUSD, ETHUSD...
cb function callback of error, result

Example:

const bfxRest = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
BFX.ticker('BTCUSD', (err, data) => {
  if (err) console.log(err)
  console.log('Ticker:', data)
})

BFX.ticker(pair, cb)

Param Type Description
pair string BTCUSD, LTCUSD, ETHUSD...
cb function callback of error, result

Example:

const bfxRest = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
BFX.ticker('BTCUSD', (err, data) => {
  if (err) console.log(err)
  console.log('Ticker:', data)
})

BFX.fundingbook(currency, {options}, cb)

Param Type Description
currency string USD, GBP, JPY
options sting i.e. options = {'limit_asks': 2, 'limit_bids': 2}.
cb function callback with error, result as params

Example:

const bfxRest = const bfxRest = new BFX(apiKey, apiSecretKey, opts).rest
const options = {'limit_asks': 2, 'limit_bids': 2}
BFX.fundingbook('BTCUSD', (err, data) => {
  if (err) console.log(err)
  console.log('Ticker:', data)
})

Actively working...

Clone this wiki locally