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 Events API

The Events API from Ceramic — 2 operation(s) for events.

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

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

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

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

4 operations 2 paths 4 schemas 1 GET2 OPTIONS1 POST

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 4

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

Events 4
OPTIONS
/events
cors
→ 200
POST
/events
Creates a new event
body → 204400500
OPTIONS
/events/{event_id}
cors
1 param → 200
GET
/events/{event_id}
Get event data
1 param → 200400404500

Schemas 4

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

EventData
object
The data for a Ceramic event that is part of a Ceramic Stream
1 property 1 required
BadRequestResponse
object
Bad request (input error)
1 property 1 required
ErrorResponse
object
Error response
1 property 1 required
Event
object
A Ceramic event as part of a Ceramic Stream. Contains both the root CID used to identify the Event as well as the Event payload data.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ceramic-events-api-openapi.yml Raw ↑

Other APIs Ceramic publishes across the network.

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