Companies

Roster size by production tier, plus hire and exit production

GET
/v1/companies/{nmlsId}/employee-stats

Authorization

x-api-key<token>

In: header

Path Parameters

nmlsId*string

Company NMLS ID

Query Parameters

period?string

Preset window when from/to are not given (default last12Months). Rolling periods start on the FIRST day of the month N months back and end today; a year is Jan 1 – Dec 31; allTime starts 2017-01-01, the earliest reliable registration data. Also selects the production period for volume/units.

Value in"2017" | "2018" | "2019" | "2020" | "2021" | "2022" | "2023" | "2024" | "2025" | "2026" | "last3Months" | "last6Months" | "last12Months" | "last14Months" | "last16Months" | "last18Months" | "last24Months" | "yearToDate" | "allTime"
from?string

Window start, inclusive (YYYY-MM-DD). Overrides period.

Match^\d{4}-\d{2}-\d{2}$
to?string

Window end, inclusive (YYYY-MM-DD). Overrides period.

Match^\d{4}-\d{2}-\d{2}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/companies/string/employee-stats"
{
  "arrived": {
    "avgVolume": 0,
    "count": 0,
    "shareOfRoster": 0,
    "topName": "string",
    "topNmlsId": "string",
    "topVolume": 0,
    "totalUnits": 0,
    "totalVolume": 0
  },
  "current": {
    "avgUnitsPerLO": 0,
    "avgVolumePerLO": 0,
    "nonProducingCount": 0,
    "producingCount": 0,
    "tiers": [
      {
        "count": 0,
        "label": "string",
        "maxUnits": 0,
        "minUnits": 0,
        "tier": "none",
        "units": 0,
        "volume": 0
      }
    ],
    "topConcentrationPct": 0,
    "totalCount": 0,
    "totalUnits": 0,
    "totalVolume": 0
  },
  "departed": {
    "avgVolume": 0,
    "count": 0,
    "topName": "string",
    "topNmlsId": "string",
    "topVolume": 0,
    "totalUnits": 0,
    "totalVolume": 0
  },
  "truncated": true,
  "window": {
    "from": "string",
    "to": "string"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}