Branches

Loans written by this branch

POST
/v1/branches/{nmlsId}/loans

Returns the individual loans attributed to this branch office — the branch's own book, not its parent company's. Accepts the same filters, sorts and pagination as the main loan search. Attribution comes from public record, so this is the branch's recorded footprint and can be smaller than the production totals on GET /v1/branches/{nmlsId}.

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/loans" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cursor": "string",
  "data": [
    {
      "apn": "string",
      "borrowerName": "string",
      "borrowerStatus": "Current",
      "brokerNmlsId": "string",
      "city": "string",
      "companyName": "string",
      "companyNmlsId": "string",
      "conforming": true,
      "coordinates": {
        "lat": 0,
        "lon": 0
      },
      "fips": "string",
      "id": "string",
      "interestRate": 0,
      "lenderName": "string",
      "listPrice": 0,
      "loanType": "string",
      "mmPropertyId": "string",
      "mortgageAmount": 0,
      "mortgageDate": "string",
      "originatorEmail": "string",
      "originatorName": "string",
      "originatorNmlsId": "string",
      "salePrice": 0,
      "sellerName": "string",
      "state": "string",
      "streetAddress": "string",
      "transactionDate": "string",
      "transactionType": "string",
      "zipCode": "string"
    }
  ],
  "lenderNormalizations": [
    {
      "aliasCount": 0,
      "displayName": "string",
      "id": "string",
      "matchedVia": "id",
      "original": "string",
      "totalDocuments": 0
    }
  ],
  "locationNormalizations": [
    {
      "candidates": [
        "string"
      ],
      "confidence": "normalized",
      "displayName": "Saint Louis, MO",
      "field": "city",
      "id": "city_mo_saint-louis",
      "normalized": "Saint Louis",
      "original": "St. Louis",
      "variants": [
        "string"
      ]
    }
  ],
  "total": 0
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Lenders this branch originated through POST

Ranks the lenders this branch's loans funded through, by volume. Pass an item's `id` — not its `label` — back as a `lender` filter value; `label` is the display name.

Loan officers who wrote this branch's loans POST

Ranks the loan officers whose loans public record attributes to this branch, by volume. Each label is the LO's NMLS ID, so it chains straight into `GET /v1/originators/{nmlsId}`. This is the branch's RECORDED roster, not its licensing roster: it answers who actually wrote loans here in the period, which is narrower than everyone registered to the branch and can include someone who has since moved. For the licensed managers on file, read `managers` on `GET /v1/branches/{nmlsId}`.