Submit Funding Offer

Submit a new funding offer.

What is FRR?

The FRR, or Flash Return Rate, is a dynamic rate that is a derivative of current market conditions.
See the Knowledge Base for more information.

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.

📘

Funding Order Types

LIMIT: Place an order at an explicit, static rate
e.g. Placing a LIMIT order with a rate of 0.01 will put an order on the book with a rate of 0.01. Do note that rates are percentages expressed as decimals, so a rate of 0.01 will equal 1%.


FRRDELTAFIX: Place an order at an implicit, static rate, relative to the FRR
e.g. Given that the FRR was 0.03 at the time, placing a FRRDELTAFIX order with a rate of 0.01 will put an order on the book with a rate of 0.04 (FRR + rate).

The rate will not change, even if the FRR goes up or down; it becomes static once the order has been created.

The offset can be negative or positive for FRRDELTAFIX.


FRRDELTAVAR: Place an order at an implicit, dynamic rate, relative to the FRR
e.g. Given that the FRR was 0.03 at the time, placing a FRRDELTAVAR order with a rate of 0.01 will put an order on the book with a rate of 0.04 (FRR + rate).

Unlike the static rate order types, the rate of a FRRDELTAVAR order that on the book can change; Its rate is dynamic. How the rate changes correlates 1:1 with any changes to the FRR following order creation.

e.g. If the FRR increased by 0.01, then all FRRDELTAVAR that are on the book and were created prior to the rate rise, will see their own rates rise by 0.01.

Once an order with a variable rate has been matched, the rate becomes fixed for the duration of the loan agreement.

The offset can only be positive for FRRDELTAVAR.

Response Fields

TermTypeDescription
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 (percentage expressed as decimal number i.e. 1% = 0.01)
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

Ratelimit: 90 req/min

Language