Branches

City volume breakdown across this branch's loans

POST
/v1/branches/{nmlsId}/breakdowns/cities

Ranks the cities this branch's loans were secured in, by volume — the branch's real lending footprint rather than its parent company's. Labels are Title Case so they match the city breakdowns on every other entity.

Authorization

x-api-key<token>

In: header

Path Parameters

nmlsId*string

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

Branch roster volume / units over time POST

Scoped to loans written by the loan officers on this branch's CURRENT licensing roster (wherever they wrote them), matching the branch profile. For loans public record attributes to the branch itself, use the branch breakdown endpoints.

County volume breakdown across this branch's loans POST

Ranks the counties this branch'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.