This sub-resource allows the user to retrieve Scale Auction BUY order history information.
Operation: GET
URL: https://api.lendingclub.com/api/lcx/v1/investors/{investor-id}/orders/history
Path Parameters:
Name | Type | Required | Description |
---|---|---|---|
Investor-id | Integer | Yes | Investor’s Actor ID |
Query Parameters:
Name | Type | Required | Description |
---|---|---|---|
Offset | Integer | No | Retrieve a subset of loans starting with the offset value |
limit | Integer | No | Limit the number of results returned |
startDate | String | No | Earliest date to retrieve order history for, in UTC format. Filter can be passed through up to the minute. Eg. 2020-05 03T22:45:56.348Z |
endDate | String | No | Latest date to retrieve order history for, in UTC format. Filter can be passed through up to the minute. Eg. 2020-10 03T22:45:56.348Z |
marketTypes | String | No | Accepted inputs are “PRIMARY” or “SECONDARY” and will return only orders from that market. No input will return orders from both markets |
Supported formats: JSON
Request Payload: JSON request for submit order
For the parameters where the Type is a List, the different values must be separated by commas,whereas for non-list parameter types, the values must be separated by an `&`. For example:
https://api.lendingclub.com/api/lcx/v1/investors/14212716/orders/history?orderTypes=BUY&o rderItemStatuses=REJECTED,CONFIRMED&startDate=2019-10-31T10:05:45-08:00
Response Parameters:
Name | Type | Description |
---|---|---|
investorId | Integer | Investor’s Actor ID |
startDate | String | Start date of the order history |
endDate | String | End date of the order history |
offset | BigDecimal | Offset to only return orders beginning from this value. For example, a value of 6 would only return orders from the 6th order onwards |
limit | Integer | Limit of the number of orders returned |
orders | An array of orders (see details below) |
orders:
Name | Type | Description |
---|---|---|
orderExecutionType | String | Order Type |
orderCreatedDate | String | Date the order was created |
totalOutstandingPrincipal | BigDecimal | Sum of outstanding principal on all loans in the order |
totalAccruedInterest | BigDecimal | Sum of Interest accrued on all loans in the order |
passiveOrderItems | String | The items and details related to the order (see details below) |
auctionType | String | Describes the auction type for the trade – “PASSIVE” |
passiveOrderItems:
Name | Type | Description |
---|---|---|
id | Integer | Unique id for the order |
status | String | Status of the order being retrieved. Possible values: RECEIVED FILLED NOT_FILLED REJECTED |
statusDate | String | Date of the status |
itemStatusReason | String | Reason for the rejection, only used when status is "Rejected" Possible Values: ACTIVE_BID_EXISTS BID_PRICE_TOO_HIGH BID_PRICE_TOO_LOW BUYER_NOT_ACTIVE_IN_ROOM ROOM_NOT_FOUND INVALID_ORDER_AMOUNT |
grade | String | grade of loans |
bidPricePercent | Big Decimal | Price bid for the order. 1.0 is 100% or par |
askPricePercent | Big Decimal | Minimum price requested for the order |
orderAmount | Big Decimal | Order volume in dollars |
filledAmount | Big Decimal | Sum of outstanding principal of loans allocated to fill this order |
roomName | String | Room that the order was placed in |
passiveBuyOrderItemDetails | Array of items for this order when the order is filled – details below |
passiveBuyOrderItemDetails:
Name | Type | Description |
---|---|---|
id | Integer | Unique id for the orde |
status | String | Status of the order being retrieved: Listed,Executed, Rejected, Execution_Failed |
statusDate | String | Date of the status |
loanId | String | Unique LendingClub ID number for the loan. |
bidPricePercent | Big Decimal | 1.0 is 100% or par |
askPricePercent | Big Decimal | askPricePercentage * PrincipalOutstanding + accruedInterest * 100% = askPrice |
askPriceEffectiveDate | Big Decimal | Date the ask price became effective |
outstandingPrincipal | Big Decimal | Principal outstanding on the loan |
accruedInterest | BigDecimal | Interest accrued |
Sample Request:
https://api.lendingclub.com/api/lcx/v1/investors/123123123/orders/history?marketTypes=PRIMARY
Sample Response:
{
"investorId":123123123,
"startDate":"2022-03-21T07:38:07.278Z",
"endDate":"2022-04-05T07:38:07.278Z",
"limit":10,
"orders":[
{
"id":831025,
"orderExecutionType":"BUY",
"orderCreatedDate":"2022-04-04T18:57:35.759Z",
"totalOutstandingPrincipal":"USD 40000.000000000000",
"totalAccruedInterest":"USD 0.000000000000",
"totalFees":"USD 0.000000000000",
"passiveOrderItems":[
{
"id":42034,
"status":"FILLED",
"statusDate":"2022-04-04T18:57:42.159Z",
"grade":"P4",
"bidPricePercent":1.200000000000,
"roomName":"TEST_ROOM",
"orderAmount":"60000.000000000000",
"filledAmount":"40000.000000000000",
"passiveBuyOrderItemDetails":[
{
"id":917047,
"status":"EXECUTED",
"statusDate":"2022-04-04T18:58:51.157Z",
"loanId":197776788,
"bidPricePercent":1.200000000000,
"askPricePercent":0.800000000000,
"askPriceEffectiveDate":"2022-04-04T18:57:33.878Z",
{
"id":831025,
"orderExecutionType":"BUY",
"orderCreatedDate":"2022-04-04T18:57:35.759Z",
"totalOutstandingPrincipal":"USD 40000.000000000000",
"totalAccruedInterest":"USD 0.000000000000",
"totalFees":"USD 0.000000000000",
"passiveOrderItems":[
{
"id":42034,
"status":"FILLED",
"statusDate":"2022-04-04T18:57:42.159Z",
"grade":"P4",
"bidPricePercent":1.200000000000,
"roomName":"TEST_ROOM",
"orderAmount":"60000.000000000000",
"filledAmount":"40000.000000000000",
"passiveBuyOrderItemDetails":[
{
"id":917047,
"status":"EXECUTED",
"statusDate":"2022-04-04T18:58:51.157Z",
"loanId":197776788,
"bidPricePercent":1.200000000000,
"askPricePercent":0.800000000000,
"askPriceEffectiveDate":"2022-04-04T18:57:33.878Z",
"outstandingPrincipal":"20000.000000000000",
"accruedInterest":"0.000000000000"
},
{
"id":917048,
"status":"EXECUTED",
"statusDate":"2022-04-04T18:58:51.157Z",
"loanId":197776789,
"bidPricePercent":1.200000000000,
"askPricePercent":1.000000000000,
"askPriceEffectiveDate":"2022-04-04T18:57:34.228Z",
"outstandingPrincipal":"20000.000000000000",
"accruedInterest":"0.000000000000"
}
]
},
{
"id":42035,
"status":"NOT_FILLED",
"statusDate":"2022-04-04T18:57:42.170Z",
"grade":"P1",
"bidPricePercent":1.000000000000,
"roomName":"TEST_ROOM",
"orderAmount":"60000.000000000000",
"filledAmount":"0",
"passiveBuyOrderItemDetails":[
{
}
]
}
],
"marketType":"PRIMARY",
"auctionType":"PASSIVE"
}
]
}
"id":42035,
"status":"NOT_FILLED",
"statusDate":"2022-04-04T18:57:42.170Z",
"grade":"P1",
"bidPricePercent":1.000000000000,
"roomName":"TEST_ROOM",
"orderAmount":"60000.000000000000",
"filledAmount":"0",
"passiveBuyOrderItemDetails":[
{
}
]
}
],
"marketType":"PRIMARY",
"auctionType":"PASSIVE"
}
]
}
HTTP Status Summary:
Code Description
200 Success
400 Validation or business error
401 Unauthorized
403 Forbidden
404 Not Found
500 Unexpected failure