Skip to main content

Base URL

All API endpoints are available at:
https://zkterm.io/api/

Authentication

Most endpoints require authentication via session cookie. Login first:
POST /api/auth/login
Content-Type: application/json

{
  "username": "your_username",
  "password": "your_password"
}

API Endpoints

Core APIs

RouteDescription
/api/authzkID authentication (register, login, logout)
/api/walletsWallet management (SOL, Starknet)
/api/lightLight Protocol ZK compression
/api/storagezkStorage encrypted file storage
/api/zk-toolkitCryptographic primitives
/api/attestzkAttest privacy attestations

Blockchain APIs

RouteDescription
/api/starknetStarknet wallet and transfers
/api/bridgeCross-chain bridging (ETH/SOL ↔ Starknet)
/api/houdiniHoudiniSwap privacy swaps
/api/transferZK proof-based transfers
/api/proofsZK proof history

Utility APIs

RouteDescription
/api/rewardsTrade-to-Earn rewards
/api/aizkAI chat assistant
/api/bug-reportsBug report submission
/api/initEnvironment initialization

Response Format

Success response:
{
  "success": true,
  "data": { ... }
}
Error response:
{
  "error": "Error message",
  "message": "Human readable description"
}

Rate Limits

Endpoint GroupLimit
Auth20/min
Light Protocol50/min
zkToolkit200/min
zkStorage30/min
zkAttest30/min

Quick Examples

Poseidon Hash

curl -X POST https://zkterm.io/api/zk-toolkit/hash/poseidon \
  -H "Content-Type: application/json" \
  -d '{"input": "hello world"}'

Create Commitment

curl -X POST https://zkterm.io/api/zk-toolkit/commit/create \
  -H "Content-Type: application/json" \
  -d '{"value": "secret_data"}'

Field Arithmetic

curl -X POST https://zkterm.io/api/zk-toolkit/field/add \
  -H "Content-Type: application/json" \
  -d '{"a": "5", "b": "7"}'