Funding Loans

Receive a snapshot and updates for any funding loans (funds not used in active positions) on your account.

Subscribe to the account information channel to keep track of your funding loans. The account information channel provides a snapshot and updates on the funding loans in your account. The snapshot is delivered upon subscribing and any changes to your funding loans will be provided as updates for as long as the channel remains open. Any authenticated connection is automatically subscribed to the account information channel.

Example code to open an authenticated connection can be found on our Authenticated Channels Page.

Funding loan events are sent with CHAN_ID = 0 and can be identified by looking at the TYPE stream field. Funding loan events will use one of the following abbreviations: 'fls' (funding loans snapshot), 'fln' (funding loan new), 'flu' (funding loans update), 'flc' (funding loan close).

[
  CHAN_ID,
  TYPE, //'fls'
  [
    [
      ID,
      SYMBOL,
      SIDE,
      MTS_CREATE,
      MTS_UPDATE,
      AMOUNT,
      FLAGS,
      STATUS,
      _PLACEHOLDER,
      _PLACEHOLDER,
      _PLACEHOLDER,
      RATE,
      PERIOD,
      MTS_OPENING,
      MTS_LAST_PAYOUT,
      NOTIFY,
      HIDDEN,
      _PLACEHOLDER,
      RENEW,
      RATE_REAL,
      NO_CLOSE
    ],
    ...
  ]
]

[0,"fls",[[2995442,"fUSD",-1,1575291961000,1575295850000,820,0,"ACTIVE",null,null,null,0.002,7,1575282446000,1575295850000,0,0,null,0,null,0]]]
[
  CHAN_ID,
  <'fln', 'flu', 'flc'>,
  [
    ID,
    CURRENCY,
    SIDE,
    MTS_CREATE,
    MTS_UPDATE,
    AMOUNT,
    FLAGS,
    STATUS,
    _PLACEHOLDER,
    _PLACEHOLDER,
    _PLACEHOLDER,
    RATE,
    PERIOD,
    MTS_OPENING,
    MTS_LAST_PAYOUT,
    NOTIFY,
    HIDDEN,
    _PLACEHOLDER,
    RENEW,
    RATE_REAL,
    NO_CLOSE,
    ...
  ]
]

[0,"fln",[2995444,"fUSD",-1,1575298742000,1575298742000,1000,0,"ACTIVE",null,null,null,0.002,7,1575298742000,1575298742000,0,0,null,0,null,0]]

Stream Fields

TermTypeDescription
CHAN_IDintIdentification number for the channel subscribtion. Funding loan events are always sent through the account information channel with CHAN_ID = 0
TYPEstring'fls' (funding loans snapshot), 'fln' (funding loan new), 'flu' (funding loan update), 'flc' (funding loan close).
IDintegerOffer ID
SYMBOLstringThe currency of the offer (fUSD, etc)
SIDEint1 if you are the lender, 0 if you are both the lender and borrower, -1 if you're the borrower
MTS_CREATEintMillisecond Time Stamp when the offer was created
MTS_UPDATEintMillisecond Time Stamp when the offer was updated
AMOUNTfloatAmount the offer is for
FLAGSobjectfuture params object (stay tuned)
STATUSstringOffer Status: ACTIVE, EXECUTED, PARTIALLY FILLED, CANCELED
RATEfloatRate of the offer
PERIODintPeriod of the offer
MTS_OPENINGintMillisecond Time Stamp of when funding was opened
MTS_LAST_PAYOUTintMillisecond Time Stamp of when last payout was received
NOTIFYint0 if false, 1 if true
HIDDENint0 if false, 1 if true
RENEWint0 if false, 1 if true
RATE_REALfloatthe calculated rate for FRR and FRRDELTAFIX
NO_CLOSEintIf funding will be returned when position is closed. 0 if false, 1 if true