Branches

Branch roster production summary with previous-period comparison

POST
/v1/branches/analytics/summary

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.

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/branches/analytics/summary" \  -H "Content-Type: application/json" \  -d '{    "nmlsId": "string"  }'
{
  "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 (measure × slice) over a branch roster's loans 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.

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.