Fluentum API Reference

Complete REST and WebSocket API reference for the Fluentum Network. This covers all core endpoints, their parameters, and response types, and explains both HTTP and WebSocket usage.

Overview

REST (HTTP) API:

All endpoints are available as HTTP POST requests at /rpc/<method>, and some as GET with query parameters.

WebSocket API:

All endpoints are available via JSON-RPC 2.0 over WebSocket at /websocket.

Special methods: subscribe, unsubscribe, unsubscribe_all for event streaming.

Core Endpoints

WebSocket-Only

MethodParamsDescription
subscribequerySubscribe to event stream (see below)
unsubscribequeryUnsubscribe from event stream
unsubscribe_allUnsubscribe from all event streams

Info API

MethodParamsDescription
healthNode health check
statusNode status (sync, validator, etc.)
net_infoNetwork info (peers, listeners, etc.)
blockchainminHeight, maxHeightBlock metadata for a range
genesisGenesis file
genesis_chunkedchunkGenesis file in chunks
blockheightBlock at given height
block_by_hashhashBlock by hash
block_resultsheightBlock results (txs, events, etc.)
commitheightBlock commit info
check_txtxCheck a transaction (not broadcast)
txhash, proveGet a transaction by hash
tx_searchquery, prove, page, per_page, order_bySearch transactions
block_searchquery, page, per_page, order_bySearch blocks
validatorsheight, page, per_pageValidators at a given height
dump_consensus_stateDump full consensus state (UNSTABLE)
consensus_stateCurrent consensus state (UNSTABLE)
consensus_paramsheightConsensus params at height
unconfirmed_txslimitUnconfirmed transactions
num_unconfirmed_txsNumber of unconfirmed transactions

Transaction Broadcast

MethodParamsDescription
broadcast_tx_committxBroadcast tx and wait for commit
broadcast_tx_synctxBroadcast tx and wait for CheckTx
broadcast_tx_asynctxBroadcast tx asynchronously

ABCI

MethodParamsDescription
abci_querypath, data, height, proveQuery the application state
abci_infoInfo about the application

Evidence

MethodParamsDescription
broadcast_evidenceevidenceSubmit evidence of misbehavior

Quantum API

MethodParamsDescription
quantum_reloadReload quantum signer plugin
quantum_statusGet quantum signing status

Unsafe (Node Control, for admin/debug only)

MethodParamsDescription
dial_seedsseedsDial seeds (unsafe)
dial_peerspeers, persistent, unconditional, privateDial peers (unsafe)
unsafe_flush_mempoolFlush mempool (unsafe)
WebSocket Event Subscriptions

- subscribe:

  • query param (string): Event query, e.g. tm.event='NewBlock' or tm.event='Tx' AND tx.hash='...'
  • Returns a stream of matching events.

- unsubscribe:

  • query param (string): Unsubscribe from a specific query.

- unsubscribe_all:

  • No params. Unsubscribe from all.
Example Request/Response

HTTP POST

POST /rpc/status
Content-Type: application/json

{}

WebSocket

{
  "jsonrpc": "2.0",
  "method": "status",
  "id": 1,
  "params": {}
}

Example Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "node_info": { ... },
    "sync_info": { ... },
    "validator_info": { ... }
  }
}
Response Types

See rpc/core/types/responses.go for all result schemas, e.g.:

  • ResultStatus
  • ResultBlock
  • ResultValidators
  • ResultBroadcastTxCommit
  • ResultQuantumStatus
  • etc.
Notes
  • All endpoints support both HTTP and WebSocket, except for subscribe, unsubscribe, and unsubscribe_all (WebSocket only).
  • Parameters are passed as JSON objects (POST) or query strings (GET).
  • WebSocket endpoint is typically /websocket.
  • For full event query syntax, see Tendermint event documentation.
Fluentum-Specific Extensions

Quantum API:

  • quantum_reload and quantum_status for quantum cryptography plugin management.

Other custom modules may expose additional endpoints via gRPC Gateway or REST, see fluentum/x/fluentum/module.go for extension points.

Where to Find More
  • Routes definition: rpc/core/routes.go
  • Quantum API: rpc/core/quantum.go
  • Response types: rpc/core/types/responses.go
  • WebSocket handler: rpc/jsonrpc/server/ws_handler.go
  • REST handler: rpc/jsonrpc/server/http_server.go
Built with v0