# Specials change feed

Ascending `history_id`. `page.next_cursor` is always set: keep polling with it. Within a site the
order is commit order (one writer per site at a time), so a cursor never skips a change.

## Endpoint

```
GET https://api.motorsdynamic.com/api/v2/specials/history
```

## Plan and price

| Plan | Access | Price |
| --- | --- | --- |
| Free | No | not included |
| Growth | No | not included |
| Scale | No | not included |
| Enterprise | Yes | contract |

A call is billed when it answers 2xx. See [pricing](https://developers.motorsdynamic.com/pricing.md).

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `domain_id` | query | integer | yes |  |
| `source` | query | `published` or `shadow` | no |  |
| `types` | query | string | no | Comma list of change types. |
| `limit` | query | integer | no |  |
| `cursor` | query | string | no | `page.next_cursor` from the previous page, unchanged. |

## Example request

curl:

```bash
curl "https://api.motorsdynamic.com/api/v2/specials/history?domain_id=201" \
  -H "x-api-key: $MD_API_KEY"
```

JavaScript:

```javascript
const res = await fetch("https://api.motorsdynamic.com/api/v2/specials/history?domain_id=201", {
  headers: { "x-api-key": process.env.MD_API_KEY },
});
if (!res.ok) throw new Error(`${res.status} ${(await res.json()).error}`);
const data = await res.json();
console.log(data);
```

Python:

```python
import os, requests

res = requests.get(
    "https://api.motorsdynamic.com/api/v2/specials/history?domain_id=201",
    headers={"x-api-key": os.environ["MD_API_KEY"]},
    timeout=10,
)
res.raise_for_status()
print(res.json())
```

## Example response

```json
{
  "data": [
    {
      "history_id": 501,
      "special_id": 9001,
      "domain_id": 201,
      "change_type": "changed",
      "changed_cols": [
        "monthly_payment",
        "offer_amount"
      ],
      "prev": {
        "monthly_payment": 519
      },
      "next": {
        "monthly_payment": 499
      },
      "observed_at": "2026-09-24T10:00:00.000000Z",
      "provenance": {
        "source": "v2_specials",
        "mode": "publish",
        "run_id": 77
      }
    }
  ],
  "page": {
    "limit": 500,
    "has_more": false,
    "next_cursor": "eyJ2IjoxfQ"
  },
  "meta": {
    "domain_id": 201,
    "source": "published"
  }
}
```

## Response fields

| Field | Type | Description |
| --- | --- | --- |
| `data[]` | array of object |  |
| `data[].history_id` | integer |  |
| `data[].special_id` | integer |  |
| `data[].domain_id` | integer |  |
| `data[].change_type` | `listed` or `changed` or `relisted` or `removed` or `adopted` |  |
| `data[].changed_cols[]` | array of string |  |
| `data[].prev` | object or null |  |
| `data[].next` | object or null |  |
| `data[].observed_at` | string or null | RFC 3339 UTC with microseconds. |
| `data[].provenance` | object |  |
| `data[].provenance.source` | `v2_specials` |  |
| `data[].provenance.mode` | `shadow` or `publish` |  |
| `data[].provenance.run_id` | integer or null |  |
| `page` | object |  |
| `page.limit` | integer |  |
| `page.has_more` | boolean |  |
| `page.next_cursor` | string or null |  |
| `meta` | object |  |

## Errors

| Status | Code | When |
| --- | --- | --- |
| 400 | `invalid_parameter` | A parameter is missing or malformed. The message names it. |
| 401 | `invalid_api_key` | The key is missing, revoked or mistyped. |
| 402 | `plan_required` | The endpoint is on a higher plan. The body names the plan and links to the upgrade. |
| 403 | `not_entitled` | The key may not read this dealer or source. |
| 429 | `rate_limited or quota_exceeded` | Slow down (see `Retry-After`), or the Free monthly calls are used up. |
| 504 | `query_timeout` | The query passed its 4 second budget. Narrow the filters. Not billed. |

Every error has the same body: `{ "error": "<code>", "message": "..." }`. Full list: [errors](https://developers.motorsdynamic.com/docs/errors.md).