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
Method | Params | Description |
---|---|---|
subscribe | query | Subscribe to event stream (see below) |
unsubscribe | query | Unsubscribe from event stream |
unsubscribe_all | Unsubscribe from all event streams |
Info API
Method | Params | Description |
---|---|---|
health | Node health check | |
status | Node status (sync, validator, etc.) | |
net_info | Network info (peers, listeners, etc.) | |
blockchain | minHeight, maxHeight | Block metadata for a range |
genesis | Genesis file | |
genesis_chunked | chunk | Genesis file in chunks |
block | height | Block at given height |
block_by_hash | hash | Block by hash |
block_results | height | Block results (txs, events, etc.) |
commit | height | Block commit info |
check_tx | tx | Check a transaction (not broadcast) |
tx | hash, prove | Get a transaction by hash |
tx_search | query, prove, page, per_page, order_by | Search transactions |
block_search | query, page, per_page, order_by | Search blocks |
validators | height, page, per_page | Validators at a given height |
dump_consensus_state | Dump full consensus state (UNSTABLE) | |
consensus_state | Current consensus state (UNSTABLE) | |
consensus_params | height | Consensus params at height |
unconfirmed_txs | limit | Unconfirmed transactions |
num_unconfirmed_txs | Number of unconfirmed transactions |
Transaction Broadcast
Method | Params | Description |
---|---|---|
broadcast_tx_commit | tx | Broadcast tx and wait for commit |
broadcast_tx_sync | tx | Broadcast tx and wait for CheckTx |
broadcast_tx_async | tx | Broadcast tx asynchronously |
ABCI
Method | Params | Description |
---|---|---|
abci_query | path, data, height, prove | Query the application state |
abci_info | Info about the application |
Evidence
Method | Params | Description |
---|---|---|
broadcast_evidence | evidence | Submit evidence of misbehavior |
Quantum API
Method | Params | Description |
---|---|---|
quantum_reload | Reload quantum signer plugin | |
quantum_status | Get quantum signing status |
Unsafe (Node Control, for admin/debug only)
Method | Params | Description |
---|---|---|
dial_seeds | seeds | Dial seeds (unsafe) |
dial_peers | peers, persistent, unconditional, private | Dial peers (unsafe) |
unsafe_flush_mempool | Flush mempool (unsafe) |
WebSocket Event Subscriptions
- subscribe
:
query
param (string): Event query, e.g.tm.event='NewBlock'
ortm.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
, andunsubscribe_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
andquantum_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