API Reference
API Overview
Complete REST API reference for zkTerm backend
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Complete REST API reference for zkTerm backend
https://zkterm.io/api/
POST /api/auth/login
Content-Type: application/json
{
"username": "your_username",
"password": "your_password"
}
| Route | Description |
|---|---|
/api/auth | zkID authentication (register, login, logout) |
/api/wallets | Wallet management (SOL, Starknet) |
/api/light | Light Protocol ZK compression |
/api/storage | zkStorage encrypted file storage |
/api/zk-toolkit | Cryptographic primitives |
/api/attest | zkAttest privacy attestations |
| Route | Description |
|---|---|
/api/starknet | Starknet wallet and transfers |
/api/bridge | Cross-chain bridging (ETH/SOL ↔ Starknet) |
/api/houdini | HoudiniSwap privacy swaps |
/api/transfer | ZK proof-based transfers |
/api/proofs | ZK proof history |
| Route | Description |
|---|---|
/api/rewards | Trade-to-Earn rewards |
/api/ai | zkAI chat assistant |
/api/bug-reports | Bug report submission |
/api/init | Environment initialization |
{
"success": true,
"data": { ... }
}
{
"error": "Error message",
"message": "Human readable description"
}
| Endpoint Group | Limit |
|---|---|
| Auth | 20/min |
| Light Protocol | 50/min |
| zkToolkit | 200/min |
| zkStorage | 30/min |
| zkAttest | 30/min |
curl -X POST https://zkterm.io/api/zk-toolkit/hash/poseidon \
-H "Content-Type: application/json" \
-d '{"input": "hello world"}'
curl -X POST https://zkterm.io/api/zk-toolkit/commit/create \
-H "Content-Type: application/json" \
-d '{"value": "secret_data"}'
curl -X POST https://zkterm.io/api/zk-toolkit/field/add \
-H "Content-Type: application/json" \
-d '{"a": "5", "b": "7"}'