---
title: Overview
description: >-
  How OpenMarket Data API documentation is versioned, what each release note
  covers, and how to stay aligned when you integrate REST or WebSocket.
---

Release notes explain **what the published docs cover** for the **OpenMarket Data API**: REST (`/v1/points`), WebSockets (book and nonbook), authentication, limits, errors, and the per–data-type reference pages. They are written for **developers integrating** the API—not for internal release engineering detail.

## What we publish

| Artifact | Purpose |
| --- | --- |
| [Release Notes](/docs/releases/changelog) | Version-by-version documentation history: scope of the documented API, operational behavior, and any contract or docs-only callouts. |

New entries appear **newest first**. Each major section uses short **Added** / **Documented** style bullets so you can see what became officially described in that release.

## Versioning

Documentation releases use **semantic-style versions** (`MAJOR.MINOR.PATCH`) as *documentation product* versions:

- **MAJOR** — Baseline or reset of the documented public contract narrative (for example first documented alignment with REST **`/v1`**). A future **HTTP breaking** change would correspond to a new API path or version line and would be reflected here together with migration guidance.
- **MINOR** — New documented endpoints, parameters, data types, or materially expanded guides without redefining the baseline contract story.
- **PATCH** — Clarifications, corrections, and small additive documentation fixes.

The **REST URL prefix `v1`** (`https://api.openmarket.xyz/v1/...`) is the implementation anchor that **v1.0.0** docs describe. WebSocket subscription payloads may carry their own version fields where documented (for example in subscribe examples).

{% hint style="info" %}
**Docs vs rollout:** Dates on release notes reflect the documentation snapshot. Platform behavior may roll out slightly before or after a docs publish; when in doubt, validate against the live API and [Errors](/docs/errors) responses.
{% endhint %}

## Integration checklist

When you adopt or refresh an integration against the Data API:

1. Read the **Latest release** callout on [Release Notes](/docs/releases/changelog).
2. Confirm **authentication** ([Authentication](/docs/authentication)) and **tier limits** ([Rate limits](/docs/rate-limits)) match your plan.
3. For REST, standardize on **`GET /v1/points`** and the **`series` / `points`** shape ([Introduction](/docs/)).
4. For WebSocket, split **book** vs **nonbook** connections as needed and pick a **region** ([WebSocket overview](/docs/ws/overview)).
5. Handle **errors** and backoff consistently ([Errors](/docs/errors)).