Lenders

Loan officers who send business to this lender

POST
/v1/lenders/{id}/breakdowns/originators

Ranks the loan officers whose loans funded through this lender, by volume. Each label is the loan officer's NMLS ID, so it chains straight into GET /originators/{nmlsId}. Loans with no identified loan officer are excluded rather than collapsed into one unnavigable bucket.

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

Lender canonical-name ID

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/lenders/string/breakdowns/originators" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cursor": "string",
  "data": [
    {
      "excluded": 0,
      "id": "string",
      "label": "string",
      "name": "string",
      "pctUnits": 0,
      "pctVolume": 0,
      "units": 0,
      "volume": 0
    }
  ],
  "total": 0,
  "totals": {
    "excluded": 0,
    "units": 0,
    "volume": 0
  },
  "truncated": true
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

County volume breakdown across this lender's loans POST

Ranks the counties this lender's loans were secured in, by volume. Labels are county codes on this surface — the same axis every other county breakdown uses, so the two are directly comparable.

State volume breakdown across this lender's loans POST

Ranks the states this lender's loans were secured in, by volume. Labels are two-letter state abbreviations.