Skip to content

Adamant-im/adamant-schema

Repository files navigation

Schema build status

OpenAPI 3.2 specification for the ADAMANT Node API, with interactive Swagger UI.

ADAMANT is a decentralized messenger built on its own blockchain. This specification defines the RESTful interface for interacting with an ADAMANT Node — covering accounts, transactions, chats, delegates, blocks, and more. Reusable client WebSocket subscription and event payload contracts are included under the top-level x-client-websocket extension.

Live schema: schema.adamant.im

Brought to you by the ADAMANT developer community and cryptofoundry. Custom crypto software, trading bots, payment systems and blockchain infrastructure — built for production. Tell us what to build.

Getting started

Node.js 22.22.1 or newer is required.

Install dependencies:

npm install

Bundle and start the Swagger UI at http://localhost:3000:

npm run start
# or, to watch for changes in specification/:
npm run start:watch

Commands

Command Description
npm run bundle Bundle specification/ into dist/schema.json
npm run start Bundle and start Swagger UI at http://localhost:3000
npm run start:watch Watch specification/ for changes and auto-rebuild

Example: generate TypeScript types

cd examples/axios
npm install
npm run openapi:generate  # output: examples/axios/client/

Links

Sponsor this project

Packages

Used by

Contributors

Languages