Loans

Market summary with previous-period comparison

POST
/v1/loans/analytics/summary

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/loans/analytics/summary" \  -H "Content-Type: application/json" \  -d '{}'
{
  "completeness": {
    "through": "2019-08-24"
  },
  "current": {
    "avgListPrice": 0,
    "avgPrice": 0,
    "excluded": {
      "avgListPrice": 0,
      "avgPrice": 0,
      "volume": 0
    },
    "units": 0,
    "volume": 0
  },
  "previous": {
    "avgListPrice": 0,
    "avgPrice": 0,
    "excluded": {
      "avgListPrice": 0,
      "avgPrice": 0,
      "volume": 0
    },
    "units": 0,
    "volume": 0
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Configurable chart data (measure × slice) POST

Buckets the filtered loans by `slice` and ranks them by `measure`, descending. Party slices (`originator`, `broker`, `loanCompany`) are pageable: send `size` (1–1000) and follow `nextCursor` via `after` to walk the whole ranking, with `total` giving the (approximate) number of distinct parties. Other slices return their fixed top-N. `period` accepts rolling windows (`last30Days`, `last60Days`, `last90Days`, `previousMonth`, `currentMonth`) resolved in UTC; `/loans/analytics/summary` with the same filters and period returns the matching population totals.

Volume / units over time POST

Next Page