Constructor
new RESTv2(opts)
Instantiate a new REST v2 transport.
Parameters:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
object | options Properties
|
Methods
accountFees(paramsopt, cbopt) → {Promise}
Request account withdrawl fees
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
accountSummary(paramsopt, cbopt) → {Promise}
Returns a 30-day summary of your trading volume and return on margin funding.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
accountTrades(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
activeOrders(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
activeOrdersWithIds(params, cb) → {Promise}
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||
cb |
function | legacy callback |
Returns:
p
- Type
- Promise
addPulse(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
addPulseComment(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
alertDelete(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
alertList(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
alertSet(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
calcAvailableBalance(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
cancelAllFundingOffers(params, cbopt) → {Promise}
Cancel all existing funding offers
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
cancelFundingOffer(params, cbopt) → {Promise}
Cancel existing funding offer
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
cancelOrder(params, cbopt) → {Promise}
Cancel existing order
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
cancelOrderMulti(params, cbopt) → {Promise}
Cancel multiple orders simultaneously.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | Cancel order parameters Properties
|
|||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
cancelOrders(params, cbopt) → {Promise}
Cancel orders.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
cancelOrderWithCid(params, cb) → {Promise}
Cancel existing order using the cID
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||
cb |
function | legacy callback |
Returns:
p
- Type
- Promise
cancelRecurringAlgoOrder(params, cbopt) → {Promise}
Cancel recurring algo order
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
candles(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
changeLogs(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
claimPosition(params, cbopt) → {Promise}
Claim existing open position
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
closeFunding(params, cbopt) → {Promise}
Close funding
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
closePosition(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
conf(paramsopt, cbopt) → {Promise}
Query configuration information
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
(async) currencies(paramsopt, cbopt) → {Promise}
Get a list of valid currencies ids, full names, pool and explorer
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
deletePulse(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
deleteSettings(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
derivsPositionCollateralSet(params, cbopt) → {Promise}
- Source:
- See:
Changes the collateral value of an active derivatives position for a certain pair.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
(async) exchangeRate(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
fetchPulseComments(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
fundingCreditHistory(params, cbopt) → {Promise}
- Source:
- See:
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
fundingCredits(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
fundingInfo(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
fundingLoanHistory(params, cbopt) → {Promise}
- Source:
- See:
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
fundingLoans(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
fundingOfferHistory(params, cbopt) → {Promise}
- Source:
- See:
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
fundingOffers(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
fundingTrades(params, cbopt) → {Promise}
- Source:
- See:
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
futures(paramsopt, cbopt) → {Promise}
Get a list of valid symbol names
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
generateInvoice(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
generateToken(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
getCoreSettings(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
getDepositAddress(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
getRecurringAlgoOrder(params, cbopt) → {Promise}
Get recurring algo order by id
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
getRecurringAlgoOrders(params, cbopt) → {Promise}
Get recurring algo orders
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | search query params Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
getSettings(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
getURL() → {boolean}
Returns:
url
- Type
- boolean
getWeightedAverages(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
inactiveSymbols(paramsopt, cbopt) → {Promise}
Get a list of inactive symbol names
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
invalidateAuthToken(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
keepFunding(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
keyPermissions(paramsopt, cbopt) → {Promise}
Fetch the permissions of the key or token being used to generate this request
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
|
|||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
liquidations(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
lnxInvoicePayments(params) → {Promise}
Parameters:
Name | Type | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
Returns:
p
- Type
- Promise
logins(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
marginInfo(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
marketAveragePrice(params, cbopt) → {Promise}
- Source:
- See:
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
movementInfo(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||
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
|
||||||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
orderBook(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
orderHistory(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
orderHistoryWithIds(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
orderMultiOp(params, cbopt) → {Promise}
Send Multiple order-related operations.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
orderTrades(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payAddCurrencyConversion(cbopt) → {Promise}
Add bitfinex pay currency conversions
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}
List bitfinex pay currency conversions
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
payCurrencyList(parameters, cbopt) → {Promise}
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}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
query parameters Properties
|
||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payDepositsUnlinked(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | query parameters Properties
|
|||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payInvoiceComplete(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | query parameters Properties
|
|||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payInvoiceCreate(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | invoice parameters Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payInvoiceCreatePos(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | invoice parameters Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payInvoiceCurrencyDetailed(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | list of feedbacks Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payInvoiceEvents(paramsopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
query parameters Properties
|
Returns:
p
- Type
- Promise
payInvoiceExpire(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | query parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payInvoiceList(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
query parameters Properties
|
||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payInvoiceListPaginated(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
query parameters Properties
|
||||||||||||||||||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payInvoiceMarkRefunded(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | query parameters Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payInvoiceUpdate(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
Object | An object containing the following properties: Properties
|
|||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payMerchantDailyLimit(cbopt) → {Promise}
Returns the daily limits for merchant
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}
Reads multiple merchant settings
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}
Reads merchant settings
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}
Sets merchant settings
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}
Sets merchant settings
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params.settings |
string | Setting keys and values Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payPublicInvoiceCurrencyDetailed(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | list of feedbacks Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payRefundInvoice(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | query parameters Properties
|
|||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
payRemoveCurrencyConversion(cbopt) → {Promise}
Remove bitfinex pay currency conversions
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}
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
positions(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
positionsAudit(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
positionsHistory(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
positionsSnapshot(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
publicPulseHistory(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
publicPulseProfile(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
pulseHistory(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
stats(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
status(paramsopt, cbopt) → {Promise}
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
|
||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
submitAutoFunding(params, cbopt) → {Promise}
Submit automatic funding
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
submitFundingOffer(params, cbopt) → {Promise}
Submit new funding offer
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
submitOrder(params, cbopt) → {Promise}
Submit new order
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
submitOrderMulti(params, cbopt) → {Promise}
Submit multiple orders.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
submitRecurringAlgoOrder(params, cbopt) → {Promise}
Submit recurring algo order
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
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}
Get a list of valid symbol names and details
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
symbols(paramsopt, cbopt) → {Promise}
Get a list of valid symbol names
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
ticker(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
tickers(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
tickersHistory(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
trades(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
transfer(params, cbopt) → {Promise}
Execute a balance transfer between wallets
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
updateOrder(params, cbopt) → {Promise}
Update existing order
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object | changes |
||
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
updateOrderMulti(params, cbopt) → {Promise}
Update multiple orders.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
updateRecurringAlgoOrder(params, cbopt) → {Promise}
Update recurring algo order
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
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}
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
|||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
userInfo(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
usesAgent() → {boolean}
Returns:
usesAgent
- Type
- boolean
wallets(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
params |
object |
<optional> |
parameters |
|
cb |
function |
<optional> |
null
|
legacy callback |
Returns:
p
- Type
- Promise
walletsHistory(paramsopt, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object |
<optional> |
parameters Properties
|
||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise
withdraw(params, cbopt) → {Promise}
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
object | parameters Properties
|
||||||||||||||||
cb |
function |
<optional> |
legacy callback |
Returns:
p
- Type
- Promise