RESTv2

RESTv2

Communicates with v2 of the Bitfinex HTTP API

Constructor

new RESTv2(opts)

Description:
  • Instantiate a new REST v2 transport.

Source:
Parameters:
Name Type Description
opts object

options

Properties
Name Type Attributes Description
affCode string <optional>

affiliate code to be applied to all orders

apiKey string <optional>

API key

apiSecret string <optional>

API secret

authToken string <optional>

optional auth option

url string <optional>

endpoint URL

transform boolean <optional>

default false

agent object <optional>

optional node agent for connection (proxy)

timeout number <optional>

default 15000

Methods

accountFees(paramsopt, cbopt) → {Promise}

Description:
  • Request account withdrawl fees

Source:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

accountSummary(paramsopt, cbopt) → {Promise}

Description:
  • Returns a 30-day summary of your trading volume and return on margin funding.

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

accountTrades(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
symbol string <optional>

optional, omit/leave empty for all

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

sort number <optional>

if 1, sorts results oldest first

cb function <optional>

legacy callback

Returns:

p

Type
Promise

activeOrders(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

activeOrdersWithIds(params, cb) → {Promise}

Source:
See:
Parameters:
Name Type Description
params object

parameters

Properties
Name Type Description
ids Array

order ids

cb function

legacy callback

Returns:

p

Type
Promise

alertDelete(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
symbol string

symbol

price number

price

cb function <optional>

legacy callback

Returns:

p

Type
Promise

alertList(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
type string

type

cb function <optional>

legacy callback

Returns:

p

Type
Promise

alertSet(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
type string

type

symbol string

symbol

price number

price

cb function <optional>

legacy callback

Returns:

p

Type
Promise

calcAvailableBalance(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
symbol string

symbol

type string

type

dir string <optional>

dir

rate number <optional>

rate

lev string <optional>

lev

cb function <optional>

legacy callback

Returns:

p

Type
Promise

cancelAllFundingOffers(params, cbopt) → {Promise}

Description:
  • Cancel all existing funding offers

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
currency string

currency i.e USD

cb function <optional>

legacy callback

Returns:

p

Type
Promise

cancelFundingOffer(params, cbopt) → {Promise}

Description:
  • Cancel existing funding offer

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
id number

offer id

cb function <optional>

legacy callback

Returns:

p

Type
Promise

cancelOrder(params, cbopt) → {Promise}

Description:
  • Cancel existing order

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
id number

order id

cb function <optional>

legacy callback

Returns:

p

Type
Promise

cancelOrderMulti(params, cbopt) → {Promise}

Description:
  • Cancel multiple orders simultaneously.

Source:
See:
Parameters:
Name Type Attributes Description
params object

Cancel order parameters

Properties
Name Type Attributes Description
id Array.<number> <optional>

array of order ID's

gid Array.<number> <optional>

array of group ID's

cid Array.<ClientOrderIdPayload> <optional>

i.e. [[ 1234, 2020-05-28']]

all number <optional>

flag, i.e. 1 to cancel all open orders

cb function <optional>

legacy callback

Returns:

p

Type
Promise

cancelOrderWithCid(params, cb) → {Promise}

Description:
  • Cancel existing order using the cID

Source:
Parameters:
Name Type Description
params object

parameters

Properties
Name Type Description
cid number

cid

date string

Date of order YYYY-MM-DD

cb function

legacy callback

Returns:

p

Type
Promise

cancelOrders(params, cbopt) → {Promise}

Description:
  • Cancel orders.

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
ids Array.<number>

list of order ids to cancel

cb function <optional>

legacy callback

Returns:

p

Type
Promise

cancelRecurringAlgoOrder(params, cbopt) → {Promise}

Description:
  • Cancel recurring algo order

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
algoOrderId string

algo order id to cancel

cb function <optional>

legacy callback

Returns:

p

Type
Promise

candles(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
timeframe string

1m, 5m, 15m, 30m, 1h, 3h, 6h, 12h, 1D, 7D, 14D, 1M

symbol string

symbol

section string

hist, last

query object <optional>

query params

Properties
Name Type Attributes Description
sort number <optional>

query sort param

start number <optional>

query sort param

end number <optional>

query sort param

limit number <optional>

query sort param

cb function <optional>

legacy callback

Returns:

p

Type
Promise

changeLogs(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

claimPosition(params, cbopt) → {Promise}

Description:
  • Claim existing open position

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
id number

position id

cb function <optional>

legacy callback

Returns:

p

Type
Promise

closeFunding(params, cbopt) → {Promise}

Description:
  • Close funding

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
id number

funding id

type string

funding type LIMIT | FRRDELTAVAR

cb function <optional>

legacy callback

Returns:

p

Type
Promise

closePosition(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
position_id number

position ID

cb function <optional>

legacy callback

Returns:

p

Type
Promise

conf(paramsopt, cbopt) → {Promise}

Description:
  • Query configuration information

Source:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
keys Array.<string> <optional>

keys

cb function <optional>

legacy callback

Returns:

p

Type
Promise

(async) currencies(paramsopt, cbopt) → {Promise}

Description:
  • Get a list of valid currencies ids, full names, pool and explorer

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

deleteSettings(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
keys Array.<string>

keys

cb function <optional>

legacy callback

Returns:

p

Type
Promise

derivsPositionCollateralSet(params, cbopt) → {Promise}

Description:
  • Changes the collateral value of an active derivatives position for a certain pair.

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
symbol string

symbol

collateral number

collateral

cb function <optional>

legacy callback

Returns:

p

Type
Promise

(async) exchangeRate(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
ccy1 string

i.e. BTC

ccy2 string

i.e. USD

cb function <optional>

legacy callback

Returns:

p

Type
Promise

fundingCreditHistory(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
symbol string <optional>

omit/leave empty for all

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

fundingCredits(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
symbol string

symbol

cb function <optional>

legacy callback

Returns:

p

Type
Promise

fundingInfo(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
key string

key

cb function <optional>

legacy callback

Returns:

p

Type
Promise

fundingLoanHistory(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
symbol string <optional>

omit/leave empty for all

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

fundingLoans(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
symbol string

symbol

cb function <optional>

legacy callback

Returns:

p

Type
Promise

fundingOfferHistory(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
symbol string <optional>

omit/leave empty for all

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

fundingOffers(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
symbol string

symbol

cb function <optional>

legacy callback

Returns:

p

Type
Promise

fundingTrades(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
symbol string <optional>

optional, omit/leave empty for all

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

futures(paramsopt, cbopt) → {Promise}

Description:
  • Get a list of valid symbol names

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

generateInvoice(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
currency string

currency for which you wish to generate an invoice. Currently only LNX (Bitcoin Lightning Network) is available

wallet string

wallet that will receive the invoice payment. Currently only 'exchange' is available

amount string

amount that you wish to deposit (in BTC; min 0.000001, max 0.02)

cb function <optional>

legacy callback

Returns:

p

Type
Promise

generateToken(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
scope string

scope of the token

ttl number <optional>

time-to-live in seconds

caps Array.<string> <optional>

token caps/permissions

writePermission boolean <optional>

token write permission

_cust_ip string <optional>

user ip address

cb function <optional>

legacy callback

Returns:

p

Type
Promise

getCoreSettings(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
keys Array.<string>

keys

cb function <optional>

legacy callback

Returns:

p

Type
Promise

getDepositAddress(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
wallet string

wallet i.e exchange, margin

method string

protocol method i.e bitcoin, tetherus

opRenew number

if 1 then generates a new address

cb function <optional>

legacy callback

Returns:

p

Type
Promise

getRecurringAlgoOrder(params, cbopt) → {Promise}

Description:
  • Get recurring algo order by id

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
algoOrderId string

algo order id to get

cb function <optional>

legacy callback

Returns:

p

Type
Promise

getRecurringAlgoOrders(params, cbopt) → {Promise}

Description:
  • Get recurring algo orders

Source:
Parameters:
Name Type Attributes Description
params object

search query params

Properties
Name Type Attributes Description
page number <optional>

search query results page number

limit number <optional>

search query results limit

sortField string <optional>

search query sort field

sortOrder 'asc' | 'desc' <optional>

search query sort order

filter object <optional>

object with filter params

Properties
Name Type Attributes Description
status string | Array.<string> <optional>

Comma separated statuses or array of statuses

alias string <optional>

search filter for alias field

startedAt Date <optional>

search filter for startedAt field

endedAt Date <optional>

search filter for endedAt field

endless boolean <optional>

search filter for endless field

recurrence 'daily' | 'weekly' | 'monthly' <optional>

search filter for recurrence field

action 'buy' | 'sell' <optional>

search filter for action field

_symbol string <optional>

search filter for _symbol field

currency string <optional>

search filter for currency field

cb function <optional>

legacy callback

Returns:

p

Type
Promise

getRecurringAoOrders(params, cbopt) → {Promise}

Description:
  • Get list of orders executed by Recurring AO

Source:
Parameters:
Name Type Attributes Description
params object

search query params

Properties
Name Type Attributes Description
algoOrderId number <optional>

algo order id to search

page number <optional>

search query results page number

limit number <optional>

search query results limit

sortField string <optional>

search query sort field

sortOrder 'asc' | 'desc' <optional>

search query sort order

filter object <optional>

object with filter params

Properties
Name Type Attributes Description
status string | Array.<string> <optional>

Comma separated statuses or array of statuses

cb function <optional>

legacy callback

Returns:

p

Type
Promise

getSettings(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
keys Array.<string>

keys

cb function <optional>

legacy callback

Returns:

p

Type
Promise

getURL() → {boolean}

Source:
Returns:

url

Type
boolean

getWeightedAverages(paramsopt, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
symbol string <optional>

query symbol

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

inactiveSymbols(paramsopt, cbopt) → {Promise}

Description:
  • Get a list of inactive symbol names

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

invalidateAuthToken(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
authToken string

target that will be invalidated

cb function <optional>

legacy callback

Returns:

p

Type
Promise

keepFunding(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
type string

Specify the funding type ('credit' or 'loan')

id string

The loan or credit id

cb function <optional>

legacy callback

Returns:

p

Type
Promise

keyPermissions(paramsopt, cbopt) → {Promise}

Description:
  • Fetch the permissions of the key or token being used to generate this request

Source:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

ledgers(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
filters object | string

filters

start number <optional>

query start

end number <optional>

query end

limit number <optional>

default 25

cb function <optional>

legacy callback

Returns:

p

Type
Promise

liquidations(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

sort number <optional>

if 1, sorts results oldest first

cb function <optional>

legacy callback

Returns:

p

Type
Promise

lnxInvoicePayments(params) → {Promise}

Source:
See:
Parameters:
Name Type Description
params object

parameters

Properties
Name Type Description
action string

Query action, use one of getPaymentsByUser, getInvoicesByUser, getInvoiceById, getPaymentById

query object

Query params

Properties
Name Type Attributes Description
offset object <optional>

Optional offset, supported only by getInvoicesByUser and getPaymentsByUser actions

txid object <optional>

Optional payment hash, required by getInvoiceById and getPaymentById actions

Returns:

p

Type
Promise

logins(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

marginInfo(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
key string <optional>

key

cb function <optional>

legacy callback

Returns:

p

Type
Promise

marketAveragePrice(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
symbol string

Symbol you want information about i.e tBTCUSD, fUSD

amount string

Amount. Positive for buy, negative for sell (ex. "1.123")

period string <optional>

(optional) Maximum period for Margin Funding

rate_limit string <optional>

Limit rate/price (ex. "1000.5")

cb function <optional>

legacy callback

Returns:

p

Type
Promise

movementInfo(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
id number <optional>

movement id

cb function <optional>

legacy callback

Returns:

p

Type
Promise

movements(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
ccy string <optional>

i.e. ETH

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit, default 25

address string <optional>

query address

id Array.<number> <optional>

Optional array of deposit/withdrawal ids

cb function <optional>

legacy callback

Returns:

p

Type
Promise

orderBook(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
symbol string

i.e. tBTCUSD

prec string

i.e. P0

cb function <optional>

legacy callback

Returns:

p

Type
Promise

orderHistory(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
symbol string <optional>

optional, omit/leave empty for all

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

orderHistoryWithIds(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
ids Array

order ids

cb function <optional>

legacy callback

Returns:

p

Type
Promise

orderMultiOp(params, cbopt) → {Promise}

Description:
  • Send Multiple order-related operations.

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
ops Array.<MultiOrderOp>

array of order operations

cb function <optional>

legacy callback

Returns:

p

Type
Promise

orderTrades(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
symbol string

symbol

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

orderId number

order ID

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payAddCurrencyConversion(cbopt) → {Promise}

Description:
  • Add bitfinex pay currency conversions

Source:
See:
Parameters:
Name Type Attributes Description
params.baseCcy number

Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!

params.convertCcy number

Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payCurrencyConversionList(cbopt) → {Promise}

Description:
  • List bitfinex pay currency conversions

Source:
See:
Parameters:
Name Type Attributes Default Description
cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

payCurrencyList(parameters, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
parameters object

list of feedbacks

params.detailed boolean

detailed

params.id string <nullable>

invoice id

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payDeposits(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

query parameters

Properties
Name Type Attributes Description
id number <optional>

Deposit/Ledger entry Id to search for, use either id or from and to fields, id has priority over from, to fields

from number <optional>

Millisecond start time

to number <optional>

Millisecond end time

ccy string <optional>

Pay currency to search deposits for

unlinked boolean <optional>

Include only unlinked payments

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payDepositsUnlinked(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

query parameters

Properties
Name Type Attributes Description
ccy string

pay currency to search deposits for

start number <optional>

millisecond start time, if omitted it will be end - 1 day if end is present otherwise it will be yesterday. Min value is 1614758400000

end number <optional>

Millisecond end time, if omitted it will be start + 1 day if start is present otherwise it will be current time. Max difference between start and end is 2 days!

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payInvoiceComplete(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

query parameters

Properties
Name Type Attributes Description
id string

unique invoice identifier

payCcy string

paid invoice currency, should be one of values under payCurrencies field on invoice

depositId number <optional>

movement/deposit Id linked to invoice as payment

depositIds Array.<number> <optional>

movement/deposit ids list linked to invoice as payment

ledgerId number <optional>

ledger entry Id linked to invoice as payment, use either depositId or ledgerId

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payInvoiceCreate(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

invoice parameters

Properties
Name Type Attributes Description
amount string

invoice amount in currency

currency string

invoice currency

payCurrencies Array.<string>

currencies in which invoice accepts the payments

duration number <optional>

optional, invoice expire time in seconds, minimal duration is 5 mins and maximal duration is 3 days. Default value is 15 minutes

orderId string

reference order identifier in merchant's platform

webhook string <optional>

the endpoint that will be called once the payment is completed or expired

redirectUrl string <optional>

merchant redirect URL, this one is used in UI to redirect customer to merchant's site once the payment is completed or expired

customerInfo object

information related to customer against who the invoice is issued

Properties
Name Type Attributes Description
nationality string

customer's nationality, alpha2 code or full country name (alpha2 preffered)

residCountry string

customer's residential country, alpha2 code or full country name (alpha2 preffered)

residState string <optional>

optional, customer's residential state/province

residCity string

customer's residential city/town

residZipCode string

customer's residential zip code/postal code

residStreet string

customer's residential street address

residBuildingNo string <optional>

optional, customer's residential building number/name

fullName string

customer's full name

email string

customer's email address

ip string <optional>

customer's ip

meta object <optional>

metadata

Properties
Name Type Attributes Description
env string <optional>

merchant environment, allowed values: production, test, staging, development

tags Array.<string> <optional>

invoice tags, max number of tags is 5 and max length of tag is 5 characters

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payInvoiceCreatePos(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

invoice parameters

Properties
Name Type Attributes Description
amount string

invoice amount in currency

currency string

invoice currency

payCurrencies Array.<string>

currencies in which invoice accepts the payments

duration number <optional>

optional, invoice expire time in seconds, minimal duration is 5 mins and maximal duration is 3 days. Default value is 15 minutes

orderId string

reference order identifier in merchant's platform

webhook string <optional>

the endpoint that will be called once the payment is completed or expired

redirectUrl string <optional>

merchant redirect URL, this one is used in UI to redirect

meta object <optional>

metadata

Properties
Name Type Attributes Description
env string <optional>

merchant environment, allowed values: production, test, staging, development

tags Array.<string> <optional>

invoice tags, max number of tags is 5 and max length of tag is 5 characters

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payInvoiceCurrencyDetailed(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

list of feedbacks

Properties
Name Type Description
detailed boolean

detailed

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payInvoiceEvents(paramsopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object <optional>

query parameters

Properties
Name Type Attributes Description
id string <optional>

invoice id of which events will be returned

Returns:

p

Type
Promise

payInvoiceExpire(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

query parameters

Properties
Name Type Description
id string

unique invoice identifier

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payInvoiceList(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

query parameters

Properties
Name Type Attributes Description
id string <optional>

unique invoice identifier

start number <optional>

millisecond start time

end number <optional>

millisecond end time

limit number <optional>

number of records (Max 100), default 10

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payInvoiceListPaginated(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

query parameters

Properties
Name Type Attributes Description
page number <optional>

Current page, default 1 100

pageSize number <optional>

Number of records per page, default 10, max 100

sort string <optional>

Sort order, default asc, accepted values are asc and desc

sortField string <optional>

Sort field, default t, allowed values: t, amount, status

status string <optional>

invoice status, allowed array item values are: CREATED, PENDING, COMPLETED, EXPIRED

fiat Array.<string> <optional>

fiat filter, should be array of strings

crypto Array.<string> <optional>

crypto filter, should be array of strings

id string <optional>

unique invoice identifier

orderId string <optional>

erchant order id

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payInvoiceMarkRefunded(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

query parameters

Properties
Name Type Description
id string

unique invoice identifier

refundId string

id of the refund

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payInvoiceUpdate(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params Object

An object containing the following properties:

Properties
Name Type Description
id Object

The id property.

fields Object
Properties
Name Type Description
customerInfo Object
Properties
Name Type Description
tosAccepted Object

TOS Accepted by customer

privateNote Object

Private note

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payMerchantDailyLimit(cbopt) → {Promise}

Description:
  • Returns the daily limits for merchant

Source:
See:
Parameters:
Name Type Attributes Description
params.customerEmails Array.<string> <optional>

Optional, customer emails for e-commerce usage

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payMerchantSettingsList(cbopt) → {Promise}

Description:
  • Reads multiple merchant settings

Source:
See:
Parameters:
Name Type Attributes Description
params.keys Array.<string>

Setting keys, if empty array all settings will be returned

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payMerchantSettingsRead(cbopt) → {Promise}

Description:
  • Reads merchant settings

Source:
See:
Parameters:
Name Type Attributes Description
params.key string

Setting key. Check doc link for possible values

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payMerchantSettingsWrite(cbopt) → {Promise}

Description:
  • Sets merchant settings

Source:
See:
Parameters:
Name Type Attributes Description
params.key string

Setting key. Check doc link for possible values

params.value string

Setting value, if null it means unset

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payMerchantSettingsWriteBatch(cbopt) → {Promise}

Description:
  • Sets merchant settings

Source:
See:
Parameters:
Name Type Attributes Description
params.settings string

Setting keys and values

Properties
Name Type Description
key string

Setting key. Check doc link for possible values

value string

Setting value, if null it means unset

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

list of feedbacks

Properties
Name Type Description
detailed boolean

detailed

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payRefundInvoice(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

query parameters

Properties
Name Type Description
id string

unique invoice identifier

ccy string

currency to be refunded

amount string

amount to be refunded

address object

address of refund

Properties
Name Type Description
address object

address of the wallet

payment_id object

tag memo

cb function <optional>

legacy callback

Returns:

p

Type
Promise

payRemoveCurrencyConversion(cbopt) → {Promise}

Description:
  • Remove bitfinex pay currency conversions

Source:
See:
Parameters:
Name Type Attributes Description
params.baseCcy number

Base currency that will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!

params.convertCcy number

Currency to which base currency will be converted, could be bfx pay currency symbol (e.g. UST-ETH) or global api symbol (UST), result is stored as global api symbol!

cb function <optional>

legacy callback

Returns:

p

Type
Promise

performance(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

positions(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

positionsAudit(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
id Array.<number> <optional>

ids of positions to audit

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

positionsHistory(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

positionsSnapshot(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

stats(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
key string

key

context string

context

cb function <optional>

legacy callback

Returns:

p

Type
Promise

status(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

statusMessages(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
type string <optional>

type

keys Array.<string> <optional>

keys

cb function <optional>

legacy callback

Returns:

p

Type
Promise

submitAutoFunding(params, cbopt) → {Promise}

Description:
  • Submit automatic funding

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
status number

status

currency string

currency i.e fUSD

amount number

amount to borrow/lend

rate number

if == 0 then FRR is used

period number

time the offer remains locked in for

cb function <optional>

legacy callback

Returns:

p

Type
Promise

submitFundingOffer(params, cbopt) → {Promise}

Description:
  • Submit new funding offer

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
offer FundingOffer

offer model instance

cb function <optional>

legacy callback

Returns:

p

Type
Promise

submitOrder(params, cbopt) → {Promise}

Description:
  • Submit new order

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
order Order

order model instance

cb function <optional>

legacy callback

Returns:

p

Type
Promise

submitOrderMulti(params, cbopt) → {Promise}

Description:
  • Submit multiple orders.

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
orders Array.<(Order|object)>

list of orders (can be object literal or Order class instance)

cb function <optional>

legacy callback

Returns:

p

Type
Promise

submitRecurringAlgoOrder(params, cbopt) → {Promise}

Description:
  • Submit recurring algo order

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
order object

new algo order

order.alias string

alias or name for the order

order._symbol string

trading pair symbol

order.currency string

base or quote currency

order.action 'buy' | 'sell'

buy or sell side

order.amount number

amount in base or quote currency

order.recurrence 'daily' | 'weekly' | 'monthly'

order frequency

order.startedAt Date <optional>

start date of orders execution

order.endedAt Date <optional>

algo order will expire on this date (null if endless is true)

order.endless boolean <optional>

order never expires if set to true (null if endedAt date is set)

cb function <optional>

legacy callback

Returns:

p

Type
Promise

symbolDetails(paramsopt, cbopt) → {Promise}

Description:
  • Get a list of valid symbol names and details

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
includeFuturePairs boolean <optional>

optional, default value is true

cb function <optional>

legacy callback

Returns:

p

Type
Promise

symbols(paramsopt, cbopt) → {Promise}

Description:
  • Get a list of valid symbol names

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

ticker(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
symbol string

symbol

cb function <optional>

legacy callback

Returns:

p

Type
Promise

tickers(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
symbols Array.<string> <optional>

symbols

cb function <optional>

legacy callback

Returns:

p

Type
Promise

tickersHistory(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
symbols Array.<string> <optional>

symbols

start number <optional>

query start timestamp

end number <optional>

query end timestamp

limit number <optional>

query limit

cb function <optional>

legacy callback

Returns:

p

Type
Promise

trades(params, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
symbol string

symbol

start number <optional>

query start

end number <optional>

query end

limit number <optional>

query limit

sort number <optional>

if 1, sorts results oldest first

cb function <optional>

legacy callback

Returns:

p

Type
Promise

transfer(params, cbopt) → {Promise}

Description:
  • Execute a balance transfer between wallets

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
amount string

amount to transfer

from string

wallet from

to string

wallet to

currency string

currency from

currencyTo string

currency to

cb function <optional>

legacy callback

Returns:

p

Type
Promise

updateOrder(params, cbopt) → {Promise}

Description:
  • Update existing order

Source:
Parameters:
Name Type Attributes Default Description
params object

changes

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

updateOrderMulti(params, cbopt) → {Promise}

Description:
  • Update multiple orders.

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
orders Array.<(Order|object)>

list of orders (can be object literal or Order class instance)

cb function <optional>

legacy callback

Returns:

p

Type
Promise

updateRecurringAlgoOrder(params, cbopt) → {Promise}

Description:
  • Update recurring algo order

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
order object

algo order to update

order.algoOrderId string

algo order id

order.alias string <optional>

alias or name for the order

order._symbol string <optional>

trading pair symbol

order.currency string <optional>

base or quote currency

order.action 'buy' | 'sell' <optional>

buy or sell side

order.amount number <optional>

amount in base or quote currency

order.recurrence 'daily' | 'weekly' | 'monthly' <optional>

order frequency

order.endedAt Date <optional>

algo order will expire on this date (null if endless is true)

order.endless boolean <optional>

order never expires if set to true (null if endedAt date is set)

cb function <optional>

legacy callback

Returns:

p

Type
Promise

updateSettings(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Description
settings object

key:value map

cb function <optional>

legacy callback

Returns:

p

Type
Promise

userInfo(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

usesAgent() → {boolean}

Source:
Returns:

usesAgent

Type
boolean

wallets(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Default Description
params object <optional>

parameters

cb function <optional>
null

legacy callback

Returns:

p

Type
Promise

walletsHistory(paramsopt, cbopt) → {Promise}

Source:
See:
Parameters:
Name Type Attributes Description
params object <optional>

parameters

Properties
Name Type Attributes Description
end number <optional>

query end

currency string <optional>

currency

cb function <optional>

legacy callback

Returns:

p

Type
Promise

withdraw(params, cbopt) → {Promise}

Source:
Parameters:
Name Type Attributes Description
params object

parameters

Properties
Name Type Attributes Description
wallet string

wallet i.e exchange, margin

method string

protocol method i.e bitcoin, tetherus

amount number <optional>

amount of withdrawal (not used for LNX)

address string <optional>

destination address (not used for LNX)

invoice string <optional>

used instead of address for LNBTC (method: 'lnx')

payment_id string <optional>

specify a tag/memo/etc

fee_deduct number <optional>

set to 1 to deduct the withdrawal fee from the withdrawal amount

note string <optional>

optional note for withdrawal

travel_rule_tos boolean <optional>

flag to voluntarily send travel rule details for withdrawal

vasp_did string <optional>

virtual asset provider identifier (see /v2/int/vasps), optional info for travel rule purpose, if missing on /v2/int/vasps or self custody ignore the field

vasp_name string <optional>

virtual asset provider name (see /v2/int/vasps), optional info for travel rule purpose, if missing on /v2/int/vasps provide manual input, if self custody ignore the field

dest_firstname string <optional>

destination entity first name for travel rule purpose

dest_lastname string <optional>

destination entity last name for travel rule purpose

dest_corp_name string <optional>

destination entity corporate name for travel rule purpose, use either dest_firstname + dest_lastname or dest_corp_name

cb function <optional>

legacy callback

Returns:

p

Type
Promise