Agents

Agent volume/units over time with buyer/seller/dual split

postapi.modelmatch.com/v1/agents/analytics/time-series

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

idstring

idsstring[]

intervalenum

Options:weeklymonthlyquarterlyyearly

periodenum

Pre-aggregated period block. Rolling windows (last30Days, last60Days, last90Days, previousMonth, currentMonth) are NOT accepted here and return 400; they are supported on the loans, sales and market endpoints (list, count, breakdowns, analytics summary / time-series / chart) (see DatedPeriod).

Options:2017201820192020202120222023202420252026last3Monthslast6Monthslast12Monthslast14Monthslast16Monthslast18Monthslast24MonthsyearToDateallTime

Responses

200objectTime-series with side splits + previous period

Show attributes

currentobject[]required

Show child attributes

buyerobjectrequired

Show child attributes

unitsnumberrequired

volumenumberrequired

datestringrequired

dualobjectrequired

Show child attributes

unitsnumberrequired

volumenumberrequired

sellerobjectrequired

Show child attributes

unitsnumberrequired

volumenumberrequired

totalobjectrequired

Show child attributes

unitsnumberrequired

volumenumberrequired

previousobject[] | nullrequired

Show child attributes

buyerobjectrequired

Show child attributes

unitsnumberrequired

volumenumberrequired

datestringrequired

dualobjectrequired

Show child attributes

unitsnumberrequired

volumenumberrequired

sellerobjectrequired

Show child attributes

unitsnumberrequired

volumenumberrequired

totalobjectrequired

Show child attributes

unitsnumberrequired

volumenumberrequired

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X POST "https://api.modelmatch.com/v1/agents/analytics/time-series" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "interval": "weekly",
    "period": "2017",
    "id": "<string>"
  }'

import { createClient } from "@model-match/api";

const client = createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await client.agents.analyticsTimeSeries({
  body: {
    interval: "weekly",
    period: "2017",
    id: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/agents/analytics/time-series",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "interval": "weekly",
        "period": "2017",
        "id": "<string>"
    },
)
data = res.json()

200 response

{
  "current": [
    {
      "buyer": {
        "units": 123.45,
        "volume": 123.45
      },
      "date": "<string>",
      "dual": {
        "units": 123.45,
        "volume": 123.45
      },
      "seller": {
        "units": 123.45,
        "volume": 123.45
      },
      "total": {
        "units": 123.45,
        "volume": 123.45
      }
    }
  ],
  "previous": [
    {
      "buyer": {
        "units": 123.45,
        "volume": 123.45
      },
      "date": "<string>",
      "dual": {
        "units": 123.45,
        "volume": 123.45
      },
      "seller": {
        "units": 123.45,
        "volume": 123.45
      },
      "total": {
        "units": 123.45,
        "volume": 123.45
      }
    }
  ]
}