CEceramicnetwork

Get all new event keys since resume token

Changed on
get/feed/events

Request

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

Query parameters

resumeAtstring

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 100. The max with data is 10000.

includeData'none' | 'full'

Whether to include the event data (carfile) in the response. In the future, only the payload or other options may be supported:

  • none - Empty, only the event ID is returned
  • full - The entire event carfile (including the envelope and payload)

Response

success

resumeTokenstring required

The token/highwater mark to used as resumeAt on a future request

Example response

{
  "resumeToken": "resumeToken",
  "events": [
    {
      "data": "data",
      "id": "id"
    },
    {
      "data": "data",
      "id": "id"
    }
  ]
}

Changes

  • 3a364da525ceRevision changes
    • breaking

      the response property // became optional for the status

    • info

      added the new optional query request parameter includeData

  • 446f208c818cRevision changes
    • warning

      deleted the query request parameter includeData

    • info

      the response property // became required for the status