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

The Interests API from Ceramic — 2 operation(s) for interests.

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

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

This API exposes 4 operations across 2 paths, 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.

4 operations 2 paths 3 schemas 2 OPTIONS2 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 — 2 OPTIONS, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Interests 4
OPTIONS
/interests/{sort_key}/{sort_value}
cors
2 params → 200
POST
/interests/{sort_key}/{sort_value}
Register interest for a sort key
4 params → 204400500
OPTIONS
/interests
cors
→ 200
POST
/interests
Register interest for a sort key
body → 204400500

Schemas 3

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

Interest
object
Describes a recon interest range to store and synchronize
4 properties 2 required
BadRequestResponse
object
Bad request (input error)
1 property 1 required
ErrorResponse
object
Error response
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ceramic-interests-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 Liveness API
Ceramic Peers API
Ceramic Streams API
Ceramic Version API