This sub-resource allows the user to see a summary of the current Scale Auction listings on the market. The API currently returns a summary of the data for loans listed in a specific room if that query parameter is included in the payload.
Operation: GET
URL: https://api.lendingclub.com/api/lcx/v1/primary/listings/passive/summary
Query Parameters:
Name | Type | Required | Description |
---|---|---|---|
roomName | String | Yes | Including the name of the room will limit the response from the listing summary endpoint to loans available in that specific room. If the parameter is excluded, the endpoint will return 400 error with invalid-auction type-in-request code |
Supported formats: json
For the Listings GET call, users must include the Accept: application/json header and exclude the Content-Type header.
Response Parameters:
Parameter Name | Type | Description |
---|---|---|
roomName | String | Name of the room for which the summary applies to |
totalOutstandingPrincipal | Number | Total Outstanding Principal in current listing, in dollars |
passiveAuctionsSummaryItems | An array of summary itmes (see details below) |
passiveAuctionsSummaryItems:
Name | Type | Description |
---|---|---|
grade | String | Grade for loans |
totalOutstandingPrincipal | BigDecimal | Principal outstanding for the grade |
askPricePercentage | BigDecimal | Minimum price sought for the grade in auction |
Sample Request:
https://api.lendingclub.com/api/lcx/v1/primary/listings/passive/summary?roomName=TEST-BFD3E388
Sample Response:
{
"roomName": "TEST-BFD3E388",
"totalOutstandingPrincipal": 74000,
"passiveAuctionsSummaryItems": [
{
"grade": "P1",
"totalOutstandingPrincipal": 50000,
"askPricePercentage": 1.01
},
{
"grade": "P2",
"totalOutstandingPrincipal": 24000,
"askPricePercentage": 0.98
}
]
}