bfx-api-node-rest
Version:
Official Bitfinex REST v1 & v2 API interfaces
605 lines (532 loc) • 14.9 kB
JavaScript
'use strict'
/* eslint-disable */
/* legacy API interface, not cleaned up with new eslint rules */
const fetch = require('node-fetch')
const debug = require('debug')('bfx:rest1')
const { genAuthSig, nonce } = require('bfx-api-node-util')
const API_URL = 'https://api.bitfinex.com'
/**
* Communicates with v1 of the Bitfinex HTTP API
*/
class RESTv1 {
/**
* Instantiate a new REST v1 transport.
*
* @param {Object} opts
* @param {string?} opts.apiKey
* @param {string?} opts.apiSecret
* @param {string?} opts.url - endpoint URL
* @param {Object?} opts.agent - optional node agent for connection (proxy)
* @param {Method?} opts.nonceGenerator - optional, should return a nonce
*/
constructor (opts = {}) {
this._url = opts.url || API_URL
this._apiKey = opts.apiKey || ''
this._apiSecret = opts.apiSecret || ''
this._agent = opts.agent
this._generateNonce = (typeof opts.nonceGenerator === 'function')
? opts.nonceGenerator
: nonce
}
/**
* @param {string} body - raw JSON
* @param {Method} cb
* @private
*/
_parse_req_body (result, cb) {
if (typeof result.message === 'string') {
if (result.message.indexOf('Nonce is too small') !== -1) {
result.message += ' See https://github.com/bitfinexcom/bitfinex-api-node/blob/master/README.md#nonce-too-small for help'
}
return cb(new Error(result.message))
}
return cb(null, result)
}
/**
* @param {string} path
* @param {Object} params
* @param {Method} cb
* @private
*/
async make_request (path, params, cb) {
if (!this._apiKey || !this._apiSecret) {
return cb(new Error('missing api key or secret'))
}
if (!path) {
return cb(new Error('path is missing'))
}
const payload = Object.assign({
request: `/v1/${path}`,
nonce: JSON.stringify(this._generateNonce())
}, params)
const payloadBase64 = Buffer.from(JSON.stringify(payload)).toString('base64')
const { sig } = genAuthSig(this._apiSecret, payloadBase64)
const url = `${this._url}/v1/${path}`
debug('POST %s', url)
const reqOpts = {
method: 'POST',
timeout: 15000,
agent: this._agent,
headers: {
'X-BFX-APIKEY': this._apiKey,
'X-BFX-PAYLOAD': payloadBase64,
'X-BFX-SIGNATURE': sig
}
}
try {
const resp = await fetch(url, reqOpts)
if (!resp.ok && +resp.status !== 400) {
throw new Error(`HTTP code ${resp.status} ${resp.statusText || ''}`)
}
const json = await resp.json()
return this._parse_req_body(json, cb)
} catch (err) {
return cb(err)
}
}
/**
* @param {string} path
* @param {Method} cb
* @private
*/
async make_public_request (path, cb) {
if (!path) {
return cb(new Error('path is missing'))
}
const url = `${this._url}/v1/${path}`
debug('GET %s', url)
const reqOpts = {
method: 'GET',
agent: this._agent,
timeout: 15000
}
try {
const resp = await fetch(url, reqOpts)
if (!resp.ok && +resp.status !== 400) {
throw new Error(`HTTP code ${resp.status} ${resp.statusText || ''}`)
}
const json = await resp.json()
return this._parse_req_body(json, cb)
} catch (err) {
return cb(err)
}
}
/**
* @param {string} symbol
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-public-ticker
*/
ticker (symbol = 'BTCUSD', cb) {
if (!cb) {
cb = (err, data) => {
if (err) {
console.error(err)
}
console.log(data)
}
}
return this.make_public_request(`pubticker/${symbol}`, cb)
}
/**
* @param {string} symbol
* @param {Method} cb
*/
today (symbol, cb) {
return this.make_public_request(`today/${symbol}`, cb)
}
/**
* @param {string} symbol
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-public-stats
*/
stats (symbol, cb) {
return this.make_public_request(`stats/${symbol}`, cb)
}
/**
* @param {string} currency
* @param {Object} options
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-public-fundingbook
*/
fundingbook (currency, options, cb) {
let uri = `lendbook/${currency}`
if (typeof options === 'function') {
cb = options
} else {
const keys = Object.keys(options)
for (let i = 0; i < keys.length; i++) {
uri += `${i === 0 ? '/?' : '&'}${keys[i]}=${options[keys[i]]}`
}
}
return this.make_public_request(uri, cb)
}
/**
* @param {string} symbol
* @param {Object} options
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-public-orderbook
*/
orderbook (symbol, options, cb) {
let uri = `book/${symbol}`
if (typeof options === 'function') {
cb = options
} else {
const keys = Object.keys(options)
for (let i = 0; i < keys.length; i++) {
uri += `${i === 0 ? '/?' : '&'}${keys[i]}=${options[keys[i]]}`
}
}
return this.make_public_request(uri, cb)
}
/**
* @param {string} symbol
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-public-trades
*/
trades (symbol, cb) {
return this.make_public_request('trades/' + symbol, cb)
}
/**
* @param {string} symbol
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-public-lends
*/
lends (currency, cb) {
return this.make_public_request('lends/' + currency, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-public-symbols
*/
get_symbols (cb) {
return this.make_public_request('symbols', cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-public-symbol-details
*/
symbols_details (cb) {
return this.make_public_request('symbols_details', cb)
}
/**
* @param {string} symbol
* @param {number} amount
* @param {number} price
* @param {string} exchange
* @param {string} side
* @param {string} type
* @param {boolean} is_hidden
* @param {boolean} postOnly
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-new-order
*/
new_order (symbol, amount, price, exchange, side, type, is_hidden, postOnly, cb) {
if (typeof is_hidden === 'function') {
cb = is_hidden
is_hidden = false
}
if (typeof postOnly === 'function') {
cb = postOnly
postOnly = false
}
const params = {
symbol,
amount,
price,
exchange,
side,
type
}
if (postOnly) params.post_only = true
if (is_hidden) params.is_hidden = true
return this.make_request('order/new', params, cb)
}
/**
* @param {Object[]} orders
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-multiple-new-orders
*/
multiple_new_orders (orders, cb) {
return this.make_request('order/new/multi', { orders }, cb)
}
/**
* @param {number} order_id
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-cancel-order
*/
cancel_order (order_id, cb) {
return this.make_request('order/cancel', {
order_id: parseInt(order_id)
}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-cancel-all-orders
*/
cancel_all_orders (cb) {
return this.make_request('order/cancel/all', {}, cb)
}
/**
* @param {number[]} order_ids
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-cancel-multiple-orders
*/
cancel_multiple_orders (order_ids, cb) {
return this.make_request('order/cancel/multi', {
order_ids: order_ids.map(id => parseInt(id))
}, cb)
}
/**
* @param {number} order_id
* @param {string} symbol
* @param {number} amount
* @param {number} price
* @param {string} exchange
* @param {string} side
* @param {string} type
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-replace-order
*/
replace_order (order_id, symbol, amount, price, exchange, side, type, cb) {
return this.make_request('order/cancel/replace', {
order_id: parseInt(order_id),
symbol,
amount,
price,
exchange,
side,
type
}, cb)
}
/**
* @param {string} order_id
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-order-status
*/
order_status (order_id, cb) {
return this.make_request('order/status', {
order_id: parseInt(order_id)
}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-active-orders
*/
active_orders (cb) {
return this.make_request('orders', {}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-orders-history
*/
orders_history (cb) {
return this.make_request('orders/hist', {}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-active-positions
*/
active_positions (cb) {
return this.make_request('positions', {}, cb)
}
/**
* @param {string} position_id
* @param {number} amount
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-claim-position
*/
claim_position (position_id, amount, cb) {
return this.make_request('position/claim', {
position_id: parseInt(position_id),
amount
}, cb)
}
/**
* @param {string} currency
* @param {Object} options
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-balance-history
*/
balance_history (currency, options, cb) {
const params = { currency }
if (typeof options === 'function') {
cb = options
} else if (options && options.constructor.name === 'Object') {
Object.assign(params, options)
}
return this.make_request('history', params, cb)
}
/**
* @param {string} currency
* @param {Object} options
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-deposit-withdrawal-history
*/
movements (currency, options, cb) {
const params = { currency }
if (typeof options === 'function') {
cb = options
} else if (options && options.constructor.name === 'Object') {
Object.assign(params, options)
}
return this.make_request('history/movements', params, cb)
}
/**
* @param {string} symbol
* @param {Object} options
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-past-trades
*/
past_trades (symbol, options, cb) {
const params = { symbol }
if (typeof options === 'function') {
cb = options
} else if (options && options.constructor.name === 'Object') {
Object.assign(params, options)
}
return this.make_request('mytrades', params, cb)
}
/**
* @param {string} currency
* @param {string} method
* @param {string} wallet_name
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-deposit
*/
new_deposit (currency, method, wallet_name, cb) {
return this.make_request('deposit/new', {
currency,
method,
wallet_name
}, cb)
}
/**
* @param {string} currency
* @param {number} amount
* @param {number} rate
* @param {number} period
* @param {string} direction
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-new-offer
*/
new_offer (currency, amount, rate, period, direction, cb) {
return this.make_request('offer/new', {
currency,
amount,
rate,
period,
direction
}, cb)
}
/**
* @param {string} offer_id
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-cancel-offer
*/
cancel_offer (offer_id, cb) {
return this.make_request('offer/cancel', {
offer_id: parseInt(offer_id)
}, cb)
}
/**
* @param {string} offer_id
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-offer-status
*/
offer_status (offer_id, cb) {
return this.make_request('offer/status', {
offer_id: parseInt(offer_id)
}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-offers
*/
active_offers (cb) {
return this.make_request('offers', {}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-active-credits
*/
active_credits (cb) {
return this.make_request('credits', {}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-wallet-balances
*/
wallet_balances (cb) {
return this.make_request('balances', {}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-active-funding-used-in-a-margin-position
*/
taken_swaps (cb) {
return this.make_request('taken_funds', {}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-total-taken-funds
*/
total_taken_swaps (cb) {
return this.make_request('total_taken_funds', {}, cb)
}
/**
* @param {string} swap_id
* @param {Method} cb
*/
close_swap (swap_id, cb) {
return this.make_request('swap/close', {
swap_id: parseInt(swap_id)
}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-account-info
*/
account_infos (cb) {
return this.make_request('account_infos', {}, cb)
}
/**
* @param {Method} cb
* @see https://docs.bitfinex.com/v1/reference#rest-auth-margin-information
*/
margin_infos (cb) {
return this.make_request('margin_infos', {}, cb)
}
/**
* POST /v1/withdraw
*
* @param {string} withdrawType "bitcoin", "litecoin", "darkcoin" or "mastercoin"
* @param {string} walletSelected origin of the wallet to withdraw from, can be "trading", "exchange", or "deposit"
* @param {number} amount amount to withdraw
* @param {string} address destination address for withdrawal
*/
withdraw (withdrawType, walletSelected, amount, address, cb) {
return this.make_request('withdraw', {
withdrawType,
walletSelected,
amount,
address
}, cb)
}
/**
* POST /v1/transfer
*
* @param {number} amount amount to transfer
* @param {string} currency currency of funds to transfer
* @param {string} walletFrom wallet to transfer from
* @param {string} walletTo wallet to transfer to
*/
transfer (amount, currency, walletFrom, walletTo, cb) {
return this.make_request('transfer', {
amount,
currency,
walletFrom,
walletTo
}, cb)
}
}
module.exports = RESTv1