View notes you own – notes API

A Borrower Payment Dependent Note (“Note”) is an obligation issued by Prosper that is dependent for payments on the payments Prosper receives on the corresponding Borrower loan. Notes are usually purchased in increments of $25, but you may purchase larger Notes.

The notes API allows you to retrieve a single Note, or a list of Notes that you own. You can set sorting and filters on the retrieved Notes to allow you to easily inspect and display information about Notes in your investment portfolio that are meaningful to you within a given context.

notes API

Use GET /notes/{loan_note_id} to retrieve a single owned Note.

Use GET /notes/{?query_parameters} to retrieve your owned Notes. You can pass in additional query parameters to filter and sort your result set.

By default, Prosper sends a limit of 25 Notes in your result set. You must paginate your results using “limit” and “offset” query parameters if you want to retrieve more.

The notes API provides powerful filtering and sorting options, allowing fine-grained search and display from the potentially large amount of Notes in your Prosper investment portfolio.

Supported methods

GET

Example URIs

GET <prosper_base_address>/notes/{loan_note_id}
   Authorization: bearer <access_token>
   Accept: application/json
GET <prosper_base_address>/notes/?offset=25&limit=10
   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

General parameters
Note: You must encode all parameters.

Name Description
offset Defaults to 0.

The starting Note within the query result set when paginating.

When making calls that may return a large result set, it is beneficial to page the result set.

By paginating your result set, you will get a much faster response than when requesting a larger, potentially large, data set for the limit value.

Example: If your first call specifies an offset of 0, and a limit of 25, your second call would have an offset value of 25. Your third call would have an offset value of 50. Your fourth call would have an offset value of 75, and so forth.
limit The default limit is 25.
The maximum limit is 100.

Determines how many Notes objects to return in the result set. There may be less remaining objects than the value you specify for the limit.
sort_by You can sort your search results by the following return fields, in ascending or descending order. Descriptions of these fields appear later in this page.

By default, the returned set of Notes will be sorted by listing_number in descending order.

  • loan_note_id
  • note_ownership_amount
  • amount_borrowed
  • borrower_rate
  • prosper_rating
  • term
  • age_in_months
  • origination_date
  • note_status

The possible values of the sort_by setting are:

  • asc – ascending (default)
  • desc – descending

Note: The sort order value (asc or desc) should be preceded by a space.

Example one: To sort the Notes returned by the Note’s origination date in descending order, you would enter the following:
GET /notes/?sort_by=origination_date desc

Example two: Performing a multiple sort. To sort the Notes by the term of the Note in ascending order and then by issuance date in descending order, you would enter the following:
GET /notes/?sort_by=term asc,origination_date desc

Request parameters

Name Description
{loan_note_id} If retrieving a single Note, the specific Note id to retrieve. This Note must be owned by the user.

Filterable fields

Filterable field Filter type Description
origination_date range The date the loan was originated and the Note was issued.The range filter type should be used for executing a search either above a certain value, below a certain value, or between two separate values for the notes parameter being searched.

You can append _min or _max to the filter name to denote the exclusive minimum and/or the exclusive maximum value for the range.

Example one: If you want to search for Notes owned on loans where the origination date is between May 23, 2015 and July 11, 2015, you would add the following parameter to your Notes search query:
GET /notes/?origination_date_min=2015-05-23
&origination_date_max=2015-07-11

Example two: If you want to search only for Notes where the origination date is after May 23, 2015, you would add the following parameter to your Notes search query:
GET /notes/?origination_date_min=2015-05-23

Example three: If you want to search for Notes where the origination date is before July 11, 2015, you would add the following parameter to your Notes search query:
GET /notes/?origination_date_max=2015-07-11
co_borrower_application boolean Determines which Notes objects to return in the result set. There may be fewer remaining objects than the value you specify, namely, there may be no co-borrower loan listings currently available.

Possible values:

  • If default is set (left blank), both co-borrower and single borrower loan listings will be included in the response.
  • If set to true, only co-borrower loans will be included in the response.
  • If set to false, only single borrowers will be included in the response.

Notes response object elements

Name Type Description
age_in_months integer Age of the loan in months.
amount_borrowed decimal The amount that was borrowed for the entire loan which corresponds to your Note.
borrower_rate decimal The borrower rate for the loan which corresponds to your Note.
collection_fees_paid_pro_rata_share decimal Your pro rata share paid to a collection agency for collecting on a loan that has defaulted.
days_past_due integer The number of days this loan is past due
debt_sale_proceeds_received_pro_rata_share decimal Money received as the result of selling post-chargeoff balances to a collection agency. Your pro rata share of the debt sale proceeds.
group_leader_award integer This field has been deprecated.
interest_paid_pro_rata_share decimal Total interest paid on this Note. Your pro rata share of the interest paid.
is_sold boolean If true, signifies that the Note was sold.
late_fees_paid_pro_rata_share decimal Late Fees paid on this Note. Your pro rata share of the late fees paid.
listing_number integer The identifier of the listing associated with the Note.
loan_note_id string The identifier associated with this Note.
loan_number integer The identifier of the loan associated with this investment Note.
next_payment_due_amount_pro_rata_share decimal Your expected pro rata share of the next payment due.
next_payment_due_date date The date the next payment on this Note is due.
note_default_reason integer Reason for Default:
1 = Delinquency
2 = Bankruptcy
3 = Deceased
4 = Repurchased
5 = PaidInFull
6 = SettledInFull
7 = Sold
null = not in default
note_default_reason_description string Textual description corresponding to the note_default_reason described above.
note_ownership_amount decimal The amount of the Note.
note_sale_fees_paid decimal Fees paid as a result of selling Prosper Notes in the secondary market.
note_sale_gross_amount_received decimal The gross amount of money received as the result of selling Prosper Notes in the secondary market and/or debt sale.
note_status integer 0 = ORIGINATIONDELAYED
1 = CURRENT
2 = CHARGEOFF
3 = DEFAULTED
4 = COMPLETED
5 = FINALPAYMENTINPROGRESS Deprecated.
6 = CANCELLED
note_status_description string Textual description corresponding to the note_status described above.
origination_date date The date the loan originated (was funded).
principal_balance_pro_rata_share decimal Your pro-rata share of the loan principal.
principal_paid_pro_rata_share decimal The principal amount that has been repaid toward this Note. Your pro rata share of the principal paid. If a note was transferred between accounts and a chargeback (reversal) takes place, this value will be negative.
prosper_fees_paid_pro_rata_share decimal Prosper fees, including failed payment and alternate payment convenience fees. Your pro rata share of the Prosper fees paid.
prosper_rating string Prosper rating of the listing for the loan which corresponds to your Note at the time the listing was created.

Possible values:

  • AA
  • A
  • B
  • C
  • D
  • E
  • HR
  • N/A
service_fees_paid_pro_rata_share decimal The service fees associated with the Note. Your pro rata share of the paid service fees.
term integer The term of the loan which corresponds to your Note in months.

Possible values:

  • 24
  • 36
  • 48
  • 60
co_borrower_application boolean If true, signifies that the loan listing is a co-borrower application

Possible values:

  • true
  • false

Examples

Example one:

The following example retrieves a single Note with the id 7772-64.

Request

GET <prosper_base_address>/notes/7772-64
   Authorization: bearer <user_access_token>
   Accept: application/json

Response

{
   "loan_number": 7772,
   "amount_borrowed": 15000,
   "borrower_rate": 0.169,
   "prosper_rating": "N/A",
   "term": 36,
   "age_in_months": 100,
   "origination_date": "2014-02-23",
   "days_past_due": 245,
   "principal_balance_pro_rata_share": 0,
   "service_fees_paid_pro_rata_share": 0.034,
   "principal_paid_pro_rata_share": 1.1119,
   "interest_paid_pro_rata_share": 0.648233,
   "prosper_fees_paid_pro_rata_share": 0,
   "late_fees_paid_pro_rata_share": 0,
   "collection_fees_paid_pro_rata_share": 0,
   "debt_sale_proceeds_received_pro_rata_share": 4.270933,
   "next_payment_due_amount_pro_rata_share": 0,
   "next_payment_due_date": "2015-07-23",
   "loan_note_id": "7772-64",
   "listing_number": 92569,
   "note_ownership_amount": 50,
   "note_sale_gross_amount_received": 0,
   "note_sale_fees_paid": 0,
   "note_status": 3,
   "note_status_description": "DEFAULTED",
   "note_default_reason": 1,
   "note_default_reason_description": "Delinquency",
   "is_sold": false,
   "co_borrower_application": true
}

Example two:

The following example retrieves owned Notes, with a limit of 10 returned notes.

Request

GET <prosper_base_address>/notes/?limit=10
   Authorization: bearer <user_access_token>
   Accept: application/json

Response

(Response has been shortened for space consideration)

{
   "result": [
   {
      "loan_number": 7735,
      "amount_borrowed": 25000,
      "borrower_rate": 0.1749,
      "prosper_rating": "N/A",
      "term": 36,
      "age_in_months": 100,
      "origination_date": "2014-02-22",
      "days_past_due": 252,
      "principal_balance_pro_rata_share": 42.17326,
      "service_fees_paid_pro_rata_share": -0.13544,
      "principal_paid_pro_rata_share": 7.82672,
      "interest_paid_pro_rata_share": 4.7373,
      "prosper_fees_paid_pro_rata_share": 0,
      "late_fees_paid_pro_rata_share": 0,
      "debt_sale_proceeds_received_pro_rata_share": 0,
      "next_payment_due_amount_pro_rata_share": 0,
      "next_payment_due_date": "2015-07-23",
      "loan_note_id": "7735-205",
      "listing_number": 93874,
      "note_ownership_amount": 50,
      "note_sale_gross_amount_received": 0,
      "note_sale_fees_paid": 0,
      "note_status": 3,
      "note_status_description": "DEFAULTED",
      "note_default_reason": 2,
      "note_default_reason_description": "Bankruptcy",
      "is_sold": false,
      "co_borrower_application": true
   },
   {
      "loan_number": 7772,
      "amount_borrowed": 15000,
      "borrower_rate": 0.169,
      "prosper_rating": "N/A",
      "term": 36,
      "age_in_months": 100,
      "origination_date": "2014-02-23",
      "days_past_due": 245,
      "principal_balance_pro_rata_share": 0,
      "service_fees_paid_pro_rata_share": -0.019167,
      "principal_paid_pro_rata_share": 1.1119,
      "interest_paid_pro_rata_share": 0.648233,
      "prosper_fees_paid_pro_rata_share": 0,
      "late_fees_paid_pro_rata_share": 0,
      "collection_fees_paid_pro_rata_share": -1.502647,
      "debt_sale_proceeds_received_pro_rata_share": 4.270933,
      "next_payment_due_amount_pro_rata_share": 0,
      "next_payment_due_date": "2015-07-23",
      "loan_note_id": "7772-64",
      "listing_number": 92569,
      "note_ownership_amount": 50,
      "note_sale_gross_amount_received": 0,
      "note_sale_fees_paid": 0,
      "note_status": 3,
      "note_status_description": "DEFAULTED",
      "note_default_reason": 1,
      "note_default_reason_description": "Delinquency",
      "is_sold": false,
      "co_borrower_application": false
   },
   {
      ...,
      ...
   },
   ...
   ...
   ],
   "result_count": 10,
   "total_count": 112
}

Example three:

The following example retrieves all owned Notes that were purchased between May 23, 2015 and July 11, 2015. The result set will be sorted by Note term in ascending order, then by origination date in descending order.

Request

GET <prosper_base_address>/notes/?origination_date_min=2015-05-23&origination_date_max=2015-07-11&sort_by=term%20asc,origination_date%20desc
   Authorization: bearer <user_access_token>
   Accept: application/json

Example four:

To reflect the availability of co-borrower personal loan applications, all listings will now return the following additional field:

  • co_borrower_application

This is an example of requesting listing content for only a co-borrower loan.

Request

GET <prosper_base_address>/notes/?co_borrower_application=true&offset=25&limit=10
   Authorization: bearer <user_access_token>
   Accept: application/json

Response

{
       "loan_number": 7772,
       "amount_borrowed": 15000,
       "borrower_rate": 0.169,
       "prosper_rating": "N/A",
       "term": 36,
       "age_in_months": 100,
       "origination_date": "2014-02-23",
       "days_past_due": 245,
       "principal_balance_pro_rata_share": 0,
       "service_fees_paid_pro_rata_share": 0.034,
       "principal_paid_pro_rata_share": 1.1119,
       "interest_paid_pro_rata_share": 0.648233,
       "prosper_fees_paid_pro_rata_share": 0,
       "late_fees_paid_pro_rata_share": 0,
       "collection_fees_paid_pro_rata_share": 0,
       "debt_sale_proceeds_received_pro_rata_share": 4.270933,
       "next_payment_due_amount_pro_rata_share": 0,
       "next_payment_due_date": "2015-07-23",
       "loan_note_id": "7772-64",
       "listing_number": 92569,
       "note_ownership_amount": 50,
       "note_sale_gross_amount_received": 0,
       "note_sale_fees_paid": 0,
       "note_status": 3,
       "note_status_description": "DEFAULTED",
       "note_default_reason": 1,
       "note_default_reason_description": "Delinquency",
       "is_sold": false,
       "co_borrower_application": true
}