Agents

Zip-code volume breakdown

POST
/v1/agents/{id}/breakdowns/zip-codes

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).

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/zip-codes" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cursor": "string",
  "data": [
    {
      "company": {
        "name": "string",
        "nmlsId": "string"
      },
      "excluded": 0,
      "id": "string",
      "label": "string",
      "name": "string",
      "office": {
        "id": "string",
        "name": "string"
      },
      "pctUnits": 0,
      "pctVolume": 0,
      "units": 0,
      "volume": 0
    }
  ],
  "total": 0,
  "totals": {
    "excluded": 0,
    "units": 0,
    "volume": 0,
    "volumePlausible": true
  },
  "truncated": true
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Title companies on the agent's financed deals, over time 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. 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`.

Cancel a bulk-delivery job for agents DELETE

Cancels a queued or running agents delivery job. The job is marked `cancelled` immediately; the container running it notices on its next page boundary and stops. Because a delivery is billed once, at the end, **a cancelled job is never charged** — no credits are debited and there is nothing to refund. No partial file is written. Idempotent-ish: cancelling a job that has already finished (or was already cancelled) returns 409 and changes nothing. Poll `GET /v1/agents/bulk-delivery/{jobId}` for the settled state.