Agents

Title companies on the agent's financed deals, over time

POST
/v1/agents/{id}/breakdowns/title-companies/time-series

Scoped to the agent's FINANCED deals: recorded loans on which the agent is the buyer's agent or the listing / co-listing agent, matched through the agent's ids. Cash deals carry no loan and are not counted. The date window is the loan's recording date. One bucket per interval (default monthly), each segmented by title company with spellings merged per bucket: segments[].label is the company's most-used spelling across the whole response and segments[].id the normalized name — match a company across buckets on id. previous is the same series for the prior window. side defaults to any.

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

Agent document 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/agents/string/breakdowns/title-companies/time-series" \  -H "Content-Type: application/json" \  -d '{}'
{
  "completeness": {
    "through": "2019-08-24"
  },
  "current": [
    {
      "complete": true,
      "date": "string",
      "excluded": 0,
      "measureValue": 0,
      "segments": [
        {
          "id": "string",
          "label": "string",
          "measureValue": 0,
          "units": 0,
          "volume": 0
        }
      ],
      "units": 0,
      "volume": 0
    }
  ],
  "measure": "string",
  "previous": [
    {
      "complete": true,
      "date": "string",
      "excluded": 0,
      "measureValue": 0,
      "segments": [
        {
          "id": "string",
          "label": "string",
          "measureValue": 0,
          "units": 0,
          "volume": 0
        }
      ],
      "units": 0,
      "volume": 0
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Title companies on the agent's financed deals (spellings merged) POST

Scoped to the agent's FINANCED deals: recorded loans on which the agent is the buyer's agent or the listing / co-listing agent, matched through the agent's ids. Cash deals carry no loan and are not counted. The date window is the loan's recording date. Ranks the title companies named on those loans. Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under. "None available"-style placeholders and names shorter than 3 characters are excluded. `pctUnits` / `pctVolume` are shares of ALL the side's financed deals in the window, including those with no title company, so they do not sum to 1. `side` defaults to `any`; title company is usually picked on the buyer side, so `buyer` is the view that reads as "who this agent's buyers close with".

Zip-code volume breakdown POST

Ranks the agent's CLOSED sales (status sold, a real sale price — rentals and lease listings excluded, duplicate records of one sale counted once) by this dimension. The same population `POST /v1/agents/{id}/sales` returns with `flatFilters.mlsStatus: "SLD"` and the agent analytics routes count. `side` narrows to the deals the agent was on that side of (`buyer` includes deals on both sides; `buyer` + `listing` = `any`).