New Offer

Create a new funding offer.

Create a new funding offer by constructing a payload using the "fon" (funding offer new) abbreviation and include an offer details object. Please look to the sidebar for examples.

Upon sending an offer, you will receive a confirmation as an 'n' (notification) event and, if the offer is placed successfully, a confirmation through a "fon" (funding offer new) event. Example responses are included in the sidebar. Please look to the Funding Offers and Notifications pages for further information.

Funding offer inputs require you to run the authentication code along with additional code for the input. The authentication code can be found on our Authenticated Channels and the additional code for inputs can be found on the Websocket Inputs page.

// Model
[
  0,
  "fon",
  null,
  {
    type: TYPE,
    symbol: SYMBOL,
    amount: AMOUNT,
    rate: RATE,
    period: PERIOD,
    flags: FLAGS
  }
]

// Examples
[
  0, 
  'fon', 
  null, 
  { 
    type: "LIMIT", 
    symbol: "fUSD", 
    amount: '50', 
    rate: '0.0002', 
    period: 7, 
    flags: 0 
  }
]

[
  0, 
  'fon', 
  null, 
  { 
    type: "FRRDELTAVAR", 
    symbol: "fUSD", 
    amount: '-50', 
    rate: '0.0001', 
    period: 7, 
    flags: 64 
  }
]
// When the offer request is submitted you will receive an 'n' (notification) event as confirmation. If the offer placement is successful, you will also receive  an 'fon' (funding offer new) event. Both events are sent through CHANNEL_ID = 0.

[
CHANNEL_ID
EVENT
 [
 MTS, //omitted for 'fon' event
 TYPE, //omitted for 'fon' event
 MESSAGE_ID, //omitted for 'fon' event
 null, //omitted for 'fon' event
  [
    ID,
    SYMBOL,
    MTS_CREATED,
    MTS_UPDATED,
    AMOUNT,
    AMOUNT_ORIG,
    OFFER_TYPE,
    _PLACEHOLDER,
    _PLACEHOLDER,
    FLAGS,
    OFFER_STATUS,
    _PLACEHOLDER,
    _PLACEHOLDER,
    _PLACEHOLDER,
    RATE,
    PERIOD,
    NOTIFY,
    HIDDEN,
    _PLACEHOLDER,
    RENEW,
    _PLACEHOLDER
  ]
 CODE, //omitted for 'fon' event
 STATUS, //omitted for 'fon' event
 TEXT //omitted for 'fon' event
 ]
]

[0,"n",[1575293958819,"fon-req",null,null,[41238934,null,null,null,500,null,null,null,null,null,null,null,null,null,0.02,2,null,null,null,null,null],null,"SUCCESS","Submitting funding offer of 500.0 UST at 2.000 for 2 days."]]

[0,"fon",[41238934,"fUST",1575293959000,1575293959000,500,500,"LIMIT",null,null,0,"ACTIVE",null,null,null,0.02,2,0,0,null,0,null]]

🚧

FRR offer

To place an FRR offer, use type FRRDELTAVAR and specify the rate as 0. This will place an FRRDELTAVAR offer with an offset of 0.

Request Fields

NameTypeDescription
typestringLIMIT, FRRDELTAVAR, FRRDELTAFIX
symbolstringsymbol (fUSD, fBTC, ...)
amountdecimal stringAmount (> 0 for offer, < 0 for bid)
ratedecimal stringRate (or offset for FRRDELTA offers)
perioddecimalTime period of offer. Minimum 2 days. Maximum 120 days.
flagsint16See https://docs.bitfinex.com/v2/docs/flag-values.

Response Fields

TermTypeDescription
CHANNEL_IDintID of the channel. (0 for account info messages)
EVENTstringType of event ('n' for notification)
MTSintMillisecond Time Stamp of the update
TYPEstringPurpose of notification ('on-req', 'oc-req', 'uca', 'fon-req', 'foc-req')
MESSAGE_IDintunique ID of the message
IDintegerOffer ID
SYMBOLstringThe currency of the offer (fUSD, etc)
MTS_CREATEDintMillisecond Time Stamp when the offer was created
MTS_UPDATEDintMillisecond Time Stamp when the offer was created
AMOUNTfloatCurrent amount of the offer
AMOUNT_ORIGfloatAmount of the initial offer
OFFER_TYPEstringOffer Type
FLAGSintFlags active on the offer; see https://docs.bitfinex.com/v2/docs/flag-values
OFFER_STATUSstringOffer Status: ACTIVE, EXECUTED, PARTIALLY FILLED, CANCELED
RATEfloatRate of the offer
PERIODintPeriod of the offer
NOTIFYbooleanTrue / false
HIDDENint0 if false, 1 if true
RENEWbooleanTrue / false
CODEnull or integerWork in progress
STATUSstringStatus of the notification; it may vary over time (SUCCESS, ERROR, FAILURE, ...)
TEXTstringText of the notification