Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ceramic Streams API

The Streams API from Ceramic — 1 operation(s) for streams.

Ceramic Streams API is one of 10 APIs that Ceramic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Streams. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 0.58.0.

Requests are made against a single base URL, /ceramic.

2 operations 1 paths 3 schemas 1 GET1 OPTIONS

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.58.0
Base URL
http://localhost:5101/ceramic
License
Resource Areas
1

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 OPTIONS. Each is listed below with its method, path, parameters, and response codes.

Streams 2
OPTIONS
/streams/{stream_id}
cors
1 param → 200
GET
/streams/{stream_id}
Get stream state
1 param → 200400404500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are StreamState (5 properties), BadRequestResponse (1 property), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error response
1 property 1 required
BadRequestResponse
object
Bad request (input error)
1 property 1 required
StreamState
object
The state of a Ceramic stream as defined by the stream type aggregation and conflict resolution rules.
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ceramic-streams-api-openapi.yml Raw ↑

Other APIs Ceramic publishes across the network.

Ceramic Config API
Ceramic Debug API
Ceramic Events API
Ceramic Experimental API
Ceramic Feed API
Ceramic Interests API
Ceramic Liveness API
Ceramic Peers API
Ceramic Version API