CEceramicnetwork

Get events matching the interest stored on the node

Changed on
get/experimental/events/{sep}/{sepValue}

Request

  • Base URL
    /ceramic (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Path parameters

sepstring required

Name of the field in the Events header that holds the separator value e.g. 'model'

sepValuestring required

The value of the field in the Events header indicated by the separator key e.g. multibase encoded model ID

Query parameters

controllerstring

the controller to filter (DID string)

streamIdstring

the stream to filter (multibase encoded stream ID)

offsetinteger

token that designates the point to resume from, that is find keys added after this point

limitinteger

the maximum number of events to return, default is 10000.

Response

success

resumeOffsetinteger required

An integer specifying where to resume the request. Only works correctly for the same input parameters.

isCompleteboolean required

A boolean specifying if there are more events to be fetched. Repeat with the resumeOffset to get next set.

Example response

{
  "resumeOffset": 0,
  "events": [
    {
      "data": "data",
      "id": "id"
    },
    {
      "data": "data",
      "id": "id"
    }
  ],
  "isComplete": true
}

Changes