What this documents

The REOP protocol surface of the reference implementation (the REOP marketplace): the documents (ProjectDocument, InventoryUpdate, RealEstateCatalog), every object definition of REOP 1.4.0 and the four reference endpoints. It is rendered from the canonical OpenAPI document generated in the protocol repository; nothing here is written by hand.

The marketplace's own endpoints (search, listings, dictionary, accounts) are product features, not part of the protocol, and are not documented here.

Before you start

Base URL https://api.reop.io/v1. Reads are public. Producers send Authorization: Bearer <API key> on PUT and POST.

Rate limits: 20 requests per second and 100 per minute per client. Errors use one envelope: { "error": { "code", "message", "details" } }, for example REOP_VALIDATION_FAILED with JSON-pointer errors[].

Every served document carries X-REOP-Version. Supported versions: GET /v1/meta/reop-manifest.

Files and versions

Canonical schema: reop.io/schema/1.4.0/reop.schema.json. Release index: versions.json. Vocabularies: reop.io/vocab/*.json.

Changelog, examples and the migration guide from the previous minor are on the 1.4.0 release.