Skip to main content

Clutch Hub API Overview

Clutch Hub API bridges applications to the Clutch Node blockchain. It builds unsigned transactions, submits signed transactions, exposes chain state via GraphQL, and provides a testnet faucet.

HTTP endpoints

EndpointMethodDescription
/healthGETLiveness check
/faucetPOSTTestnet CLT drip (when enabled)
/graphqlPOSTGraphQL queries and mutations
/graphql/wsGETGraphQL subscriptions (WebSocket)

There is no REST user registration or login. Authentication is wallet-based JWT via GraphQL generateToken. See Authentication.

Features

  • Wallet JWT authentication
  • Unsigned transaction generation for the full ride lifecycle
  • Signed transaction submission to the node
  • GraphQL queries for ride lists and account balance
  • GraphQL subscriptions (poll-based snapshots from the node)
  • Testnet faucet (Transfer signed server-side)
  • Seq integration for structured logging
  • Prometheus metrics sidecar (configurable)

Architecture role

Your App / SDK  ──►  Hub API (GraphQL)  ──►  Clutch Node (WebSocket JSON-RPC)

The API never receives private keys. Apps sign transactions client-side and submit raw RLP hex via sendRawTransaction.

Docker

Pull from GHCR or Docker Hub. See Docker images for all packages.

docker pull ghcr.io/clutchprotocol/clutch-hub-api:latest
docker run -p 3000:3000 -v $(pwd)/config:/app/config:ro ghcr.io/clutchprotocol/clutch-hub-api:latest

Or use clutch-deploy for the full stack.

Documentation