Funding Credits

Subscribe to the account information channel to keep track of your funding credits. The account information channel provides a snapshot and updates on the funding credits in your account. The snapshot is delivered upon subscribing and any changes to your funding credits 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 credits events are sent with CHAN_ID = 0 and can be identified by looking at the TYPE stream field. Funding credits events will use one of the following abbreviations: 'fcs' (funding credits snapshot), 'fcn' (funding credits new), 'fcu' (funding credits update), 'fcc' (funding credits close).

[
  CHAN_ID,
  TYPE, //'fcs'
  [
    [
      CREDIT_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,
      POSITION_PAIR
    ],
    ...
  ]
]
    
[0,"fcs",[[26223578,"fUST",1,1575052261000,1575296187000,350,0,"ACTIVE",null,null,null,0,30,1575052261000,1575293487000,0,0,null,0,null,0,"tBTCUST"],[26223711,"fUSD",-1,1575291961000,1575296187000,180,0,"ACTIVE",null,null,null,0.002,7,1575282446000,1575295587000,0,0,null,0,null,0,"tETHUSD"]]]

[
  CHAN_ID,
  TYPE, // 'fcn', 'fcu', 'fcc':
  [
    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, 
    POSITION_PAIR
  ]
]

[0,"fcu",[26223578,"fUST",1,1575052261000,1575296787000,350,0,"ACTIVE",null,null,null,0,30,1575052261000,1575293487000,0,0,null,0,null,0,"tBTCUST"]]

Stream Fields

Term	Type	Description
CHAN_ID	int	Identification number for the channel subscribtion. Funding credits events are always sent through the account information channel with CHAN_ID = 0
TYPE	string	'fcs' (funding credits snapshot), 'fcn' (funding credits new), 'fcu' (funding credits update), 'fcc' (funding credits close).
CREDIT_ID	integer	Credit ID
SYMBOL	string	The currency of the credit (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 credit was created
MTS_UPDATE	int	Millisecond Time Stamp when the credit was created
AMOUNT	float	Amount the credit is for
FLAGS	object	future params object (stay tuned)
STATUS	string	Credit Status: ACTIVE, EXECUTED, PARTIALLY FILLED, CANCELED
RATE	float	Rate of the credit
PERIOD	int	Period of the credit
MTS_OPENING	int	Millisecond Time Stamp when the funding was opened
MTS_LAST_PAYOUT	int	Millisecond Time Stamp when the 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	0 if false, 1 if true (whether the funding should be closed when the position is closed)
POSITION_PAIR	string	The pair of the position that the funding is used for