Loans

Volume / units over time

POST
/v1/loans/analytics/time-series

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/time-series" \  -H "Content-Type: application/json" \  -d '{}'
{
  "completeness": {
    "through": "2019-08-24"
  },
  "current": [
    {
      "complete": true,
      "date": "string",
      "excluded": 0,
      "measureValue": 0,
      "segments": [
        {
          "id": "string",
          "label": "string",
          "measureValue": 0,
          "units": 0,
          "volume": 0
        }
      ],
      "units": 0,
      "volume": 0
    }
  ],
  "measure": "string",
  "previous": [
    {
      "complete": true,
      "date": "string",
      "excluded": 0,
      "measureValue": 0,
      "segments": [
        {
          "id": "string",
          "label": "string",
          "measureValue": 0,
          "units": 0,
          "volume": 0
        }
      ],
      "units": 0,
      "volume": 0
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Market summary with previous-period comparison POST

Previous Page

Submit a bulk-delivery job for loans POST

Queues an ECS task that dumps every matching loans document to S3 in the requested format. Returns 202 with a jobId; poll `GET /v1/loans/bulk-delivery/{jobId}` for status + the signed download URL. **Row limit.** Deliveries of up to 5,000 rows need no entitlement. Above that, the org's `bulk-delivery.loans` entitlement is required and its scope (row ceiling, row filters, allowed fields) governs the delivery; without it the request is rejected with 403 `entitlement_missing`. Pass `limit` at or below the ceiling to deliver a capped subset of a broader query. Email support@modelmatch.com to request a limit increase. Delivery is billed at 1 credit per row regardless of entitlement (deliveries submitted from the ModelMatch web app are not billed). **Push-target destination.** Pass `destination: { type: "push-target", targetId }` to have the finished rows sent to a configured push target instead of downloaded. The target is checked before anything is queued; a refusal returns the push target's status and `code` (`TARGET_NOT_FOUND` 404, `FORBIDDEN` 403, `PLAN_REQUIRED` 402, `TARGET_DISABLED` 409, `ENTITY_MISMATCH` 400). Limits and billing are the same as a file delivery.