Entity Changes API

Overview

Users can retrieve a chronologically sorted history of changes to WorldCat Entity data.

Note: Included with OCLC Meridian Subscription.

To learn about OCLC APIs and get started with the Entity Changes API, see:

If you're ready to start using the Entity Changes API, the OCLC Developer Network can help you learn more. The OCLC Developer Network allows you to learn about OCLC APIs, view OCLC API documentation, and participate in the OCLC APIs community.

About Entity Changes API

Types of changes

The following types of changes can be retrieved by the Entity Changes API:

History Table	Changes API
Create entity value	Create
Add, remove, or replace entity value	Update

Context and standard URLs

Paths

v1/changes

v1/changes/pages/1

v1/changes/pages/2...

Authorization scope

entity-changes

Examples

Main code - Example

GET v1/changes

{
    "context": [
        "https://www.w3.org/ns/activitystreams",
        "https://id.oclc.org/api/context.json",
        "https://emm-spec.org/0.1/context.json"
    ],
    "summary": "Worldcat Entity - Changes",
    "type": "OrderedCollection",
    "id": "https://entities.api.oclc.org/changes",
    "first": {
        "type": "OrderedCollectionPage",
        "id": "https://entities.api.oclc.org/changes/pages/1"
    },
    "last": {
        "type": "OrderedCollectionPage",
        "id": "https://entities.api.oclc.org/changes/pages/433"
    },
    "totalItems": (total number of changed items)
}

Pages code - Example

Page1 is first page of changes in Wordcat Entities
Last page is most recent changes

GET v1/changes/pages/{pageNumber}

    "type": "Add, Remove, Create, Replace",
            "published": "2024-04-12T08:31:31.514Z",
            "object": {
                "id": "E39QJKdVFFTCvc69T8GmRRt4gJ",
                "type": "ENTITY_PROPERTY",
                "updated": "2024-04-12T08:31:31.514Z"