Get stream state

Changed on
get/streams/{stream_id}

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

stream_idstring required

Multibase encoded stream ID

Response

success

idstring required

Multibase encoding of the stream id

event_cidstring required

CID of the event that produced this state

controllerstring required

Controller of the stream

dimensionsobject required

Dimensions of the stream, each value is multibase encoded.

datastring required

Multibase encoding of the data of the stream. Content is stream type specific.

Example response

{
  "controller": "controller",
  "data": "data",
  "id": "id",
  "event_cid": "event_cid",
  "dimensions": "{}"
}

Changes