Companies

Where a company's hires came from and where its exits went

GET
/v1/companies/{nmlsId}/talent-flow

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}$
limit?integer

Counterparty companies per side (default 50, max 1000).

Range1 <= value <= 1000

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/companies/string/talent-flow"
{
  "arrivals": {
    "companies": [
      {
        "companyName": "string",
        "companyNmlsId": "string",
        "count": 0,
        "units": 0,
        "volume": 0
      }
    ],
    "companiesTruncated": true,
    "total": 0,
    "unattributed": 0,
    "units": 0,
    "volume": 0
  },
  "departures": {
    "companies": [
      {
        "companyName": "string",
        "companyNmlsId": "string",
        "count": 0,
        "units": 0,
        "volume": 0
      }
    ],
    "companiesTruncated": true,
    "total": 0,
    "unattributed": 0,
    "units": 0,
    "volume": 0
  },
  "truncated": true,
  "window": {
    "from": "string",
    "to": "string"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

State volume breakdown across this company's loans POST

Previous Page

Title companies on this company's loans (spellings merged) POST

Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.