View your Prosper account balance – accounts API

Use the accounts API to retrieve Prosper account balance information for the user. You might call this method before purchasing a borrower payment dependent note (“Note”) to make sure the Prosper account has enough funds to cover the Note.

Supported methods

GET

Example URI

GET <prosper_base_address>/accounts/prosper/
   Authorization: bearer<access_token> 
   Accept: application/json

HTTP Headers

Field name Expected value Required?
Authorization bearer <access_token> Y
Accept application/json Y
timezone By default, all dates returned in the response are in UTC format. However, you can specify the timezone in full format.

Examples:
America/Los_Angeles
America/New_York

 N

Query Parameters

Field name Possible values
filters AVAILABLE_CASH
Pass this query parameter to return just the available_cash_balance element in the response. See the response object elements table below for a description of the available_cash_balance element.

Example: GET <prosper_base_address> /accounts/prosper/?filters=AVAILABLE_CASH
suppress_in_flight_gross true | false
By default, the value of this parameter is “true”.

If you want to view the inflight_gross element and its value, pass this query parameter with a value of “false” when making the call. See the response object elements table below for a description of the inflight_gross element.

Example: GET <prosper_base_address> /accounts/prosper/?suppress_in_flight_gross=false

Accounts response object elements

Name Type Description
available_cash_balance decimal Current cash balance
pending_investments_primary_market decimal The amount of money invested in Notes in the primary market that are pending origination.
pending_investments_secondary_market decimal The maximum amount of money invested or bid on Notes in the secondary market that are pending completion or still have remaining time on which to be bid by other investors.
pending_quick_invest_orders decimal The amount of money invested in Notes via automated or manual quick invest.
total_principal_received_on_active_notes decimal Total principal payments received on currently active Notes from Prosper Note investments.
total_amount_invested_on_active_notes decimal Total amount invested in Notes on the Prosper platform through both the primary and secondary markets.
outstanding_principal_on_active_notes decimal Total principal outstanding on active Notes with a minimum of $0.
total_account_value decimal Total dollars held in the following combined:

Available cash balance
+ pending investments in the Primary market
+ pending investments in the Secondary market
+ (total amount invested on active Notes
– total principal received on active Notes)
– pending quick invest orders
inflight_gross decimal Total loan payment amount that borrowers have paid that are in-flight in the following combined:

Principal
+ interest
+ insufficient funds fees
+ late Fees

The total above also includes any Prosper processing fees that will be charged to an investor.

There may be times when a payment that is already deposited to the investor account can be reversed. In cases when this happens, the inflight_gross value may be negative if the amount to be reversed is greater than the total inflight_gross to be paid.

Note: By default, the inflight_gross element and its value are not returned by a GET <prosper_base_address>/accounts/prosper/ API call, as excluding it will provide significant performance improvement for your API client.

If you need to view the value of this element, add the suppress_in_flight_gross query parameter to the GET call with a value of false.

Example: GET <prosper_base_address> /accounts/prosper/?suppress_in_flight_gross=false

If there is no in-flight payment, this element will not be returned.
last_deposit_amount decimal The total amount of your last deposit to your Prosper account.
last_deposit_date date The date of your last deposit to your Prosper account.
last_withdraw_amount decimal The total amount of your last withdrawal from your Prosper account.
last_withdraw_date date The date of your last withdrawal from your Prosper account.
external_user_id string A unique id associated with the user.
prosper_account_digest string A sha256 hash that can be used by a third-party agent to differentiate between multiple Prosper accounts.
This is only needed when a user authorizes the third-party agent to link to multiple Prosper accounts.
If you need this functionality, please contact us.
invested_notes object Original investment amount for all owned notes that are current within each Prosper note rating (NA,HR,E,D,C,B,A,AA).

The values within invested_notes can be used to determine note diversification of your current holdings.

Note: Current notes are notes that are either paid on time, or less than 121 days past due. Once a note is paid or charged off, the value of the note will be deducted from the note total.

Example invested_notes object:

"invested_notes": {
    "NA": 2000,
    "HR": 8100,
    "E": 28000,
    "D": 87500,
    "C": 110588,
    "B": 12150,
    "A": 90759.83,
    "AA": 54998.73
  }
pending_bids object An object containing total outstanding bid amounts for notes within each Prosper note rating (NA,HR,E,D,C,B,A,AA).

Pending bids represent investments in listings that have not yet originated. Once a listing has been verified, funded, and originated, the pending bid value will transfer to the invested_notes value within the correct Prosper note rating.

Listings that are withdrawn will be deducted from the pending_notes total, and returned to the total_account_value field.

Example pending_bids object:

"pending_bids": {
    "NA": 0,
    "HR": 0,
    "E": 700,
    "D": 700,
    "C": 1900,
    "B": 600,
    "A": 900,
    "AA": 900 
  }

Examples

Example one

A request for account information.

Request:

GET <prosper_base_address>/accounts/prosper/

Response:

{
  "available_cash_balance": 524640.95,
  "pending_investments_primary_market": 16970,
  "pending_investments_secondary_market": 0,
  "pending_quick_invest_orders": 0,
  "total_principal_received_on_active_notes": 9.95,
  "total_amount_invested_on_active_notes": 4975,
  "outstanding_principal_on_active_notes": 4965.05,
  "total_account_value": 546576,
  "last_deposit_amount": 546576,
  "last_deposit_date": "2016-05-31",
  "external_user_id": "FEBB3F4C-CADD-4A83-B9DD-F839DB74A487",
  "prosper_account_digest": "naFyouq85i13145QVNDPyCmv9AxC21V30qvZeHAvOUY=",
  "invested_notes": {
    "NA": 0,
    "E": 0,
    "D": 0,
    "C": 0,
    "B": 0,
    "A": 0,
    "AA": 4975
  },
  "pending_bids": {
    "NA": 0,
    "E": 6775,
    "D": 0,
    "C": 0,
    "B": 2475,
    "A": 3695,
    "AA": 4025
  }
}

Example two

A request for account information that includes the inflight_gross element in the response. Note that this is an expensive operation.

Request:

GET <prosper_base_address>/accounts/prosper/?suppress_in_flight_gross=false

Response:

{
  "available_cash_balance": 524640.95,
  "pending_investments_primary_market": 16970,
  "pending_investments_secondary_market": 0,
  "pending_quick_invest_orders": 0,
  "total_principal_received_on_active_notes": 9.95,
  "total_amount_invested_on_active_notes": 4975,
  "outstanding_principal_on_active_notes": 4965.05,
  "total_account_value": 546576,
  "inflight_gross": 298.5,
  "last_deposit_amount": 546576,
  "last_deposit_date": "2016-05-31",
  "external_user_id": "FEBB3F4C-CADD-4A83-B9DD-F839DB74A487",
  "prosper_account_digest": "naFyouq85i13145QVNDPyCmv9AxC21V30qvZeHAvOUY=",
  "invested_notes": {
    "NA": 0,
    "E": 0,
    "D": 0,
    "C": 0,
    "B": 0,
    "A": 0,
    "AA": 4975
  },
  "pending_bids": {
    "NA": 0,
    "E": 6775,
    "D": 0,
    "C": 0,
    "B": 2475,
    "A": 3695,
    "AA": 4025
  }
}

Example three

A request for account information that returns only the available_cash_balance element.

Request:

GET <prosper_base_address>/accounts/prosper?filters=AVAILABLE_CASH

Response:

{
  "available_cash_balance": 524640.95
}