Loan Balances

Get loan balances

GET /v1/loan/balances

Retrieves all active deals with funded loans where loan balance and principal balance are greater than 0. Returns up to 1000 records per call.

Query parameters

Field	Type	Description
dealIds	string[]	Filter to specific deal public IDs.
statuses	string[]	Filter by deal status.
nextId	string	Public ID of the last deal from the previous response, for pagination.
limit	number	Max 1000, defaults to 1000.

Example

balances = client.loans.get_balances(limit=100)
for loan in balances.data:
    print(loan.dealId, loan.loanBalance)
 
if balances.nextId:
    next_page = client.loans.get_balances(limit=100, next_id=balances.nextId)

Example response

{
  "success": true,
  "count": 1,
  "data": [
    {
      "dealId": "abc123xyz",
      "dealName": "ABC Corp Loan",
      "companyName": "ABC Corporation",
      "status": "Funded",
      "totalRepaid": 5000,
      "loanBalance": 15000,
      "principalBalance": 12000
    }
  ],
  "nextId": null
}