Funding Loans

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'
  [
    [
      LOAN_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

Term	Type	Description
CHAN_ID	int	Identification number for the channel subscribtion. Funding loan events are always sent through the account information channel with CHAN_ID = 0
TYPE	string	'fls' (funding loans snapshot), 'fln' (funding loan new), 'flu' (funding loan update), 'flc' (funding loan close).
LOAN_ID	integer	Loan ID
SYMBOL	string	The currency of the loan (fUSD, etc)
SIDE	int	1 if you are the lender, 0 if you are both the lender and borrower, -1 if you're the borrower
MTS_CREATE	int	Millisecond Time Stamp when the loan was created
MTS_UPDATE	int	Millisecond Time Stamp when the loan was updated
AMOUNT	float	Amount the loan is for
FLAGS	object	future params object (stay tuned)
STATUS	string	Loan Status: ACTIVE, EXECUTED, PARTIALLY FILLED, CANCELED
RATE	float	Rate of the loan
PERIOD	int	Period of the loan
MTS_OPENING	int	Millisecond Time Stamp of when funding was opened
MTS_LAST_PAYOUT	int	Millisecond Time Stamp of when last payout was received
NOTIFY	int	0 if false, 1 if true
HIDDEN	int	0 if false, 1 if true
RENEW	int	0 if false, 1 if true
RATE_REAL	float	the calculated rate for FRR and FRRDELTAFIX
NO_CLOSE	int	If funding will be returned when position is closed. 0 if false, 1 if true