⚡ Getting Started with ZkStable API

Welcome to the ZkStable API Documentation — your entry point to integrating privacy-preserving stablecoin minting, redemption, and proof verification directly into your application.

---

🧩 Why this guide?

This section gives developers a quick walkthrough to authenticate, connect to the right environment, and make their first transaction using ZkStable’s REST API or SDKs.

You’ll be set up in minutes — with no manual KYC or complex proof handling required.

---

Enviroment

Environment	Base URL
Production	https://api.zkstablerpc.com/v1
Sandbox / Testnet	https://sandbox.zkstablerpc.com/v1

---

🪄 Getting Started

1️⃣ Create an account

Sign up for a free developer account at dashboard.zkstablerpc.com.

You’ll get access to your personal workspace, sandbox environment, and API analytics.

---

2️⃣ Get your API key

Once logged in, navigate to the API Keys tab and generate a new key.

Copy it securely — you’ll need it for all authenticated calls.

bash

// export ZKS_API_KEY="your_generated_key_here"

---

3️⃣ Make your first request

Let’s mint your first $pUSD on the sandbox.

Example (cURL)

bash

curl -X POST https://sandbox.zkstablerpc.com/v1/mint \
  -H "Authorization: Bearer $ZKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "100.00",
    "collateralType": "ZEC",
    "proofId": "prf_test_abc123",
    "recipient": "0xYourEvmAddress"
  }'

Example (JavaScript SDK)

js

import ZkStable from "zkstable-sdk";

const client = new ZkStable({ apiKey: process.env.ZKS_API_KEY, baseUrl: "sandbox" });

const mint = await client.mint({
  amount: "100.00",
  collateralType: "ZEC",
  proofId: "prf_test_abc123",
  recipient: "0xYourEvmAddress"
});

console.log("Mint status:", mint.status, "Tx:", mint.txHash);

You should receive a response similar to:

Json

{
  "status": "queued",
  "mintId": "mnt_7s2v...",
  "expectedCollateralRatio": "170",
  "pegPrice": "1.0002"
}

---

🔒 Authentication

All requests require an API key via HTTP Header:

http

Authorization: Bearer <YOUR_API_KEY>

Your key identifies your app and enforces rate limits.

Sandbox keys are isolated from production — always test before deploying live.

---

⚙️ Next Steps

After your first mint succeeds, explore advanced endpoints:

• /proofs/submit — submit ZK proofs of collateral

• /redeem — burn $pUSD and unlock ZEC

• /collateral — monitor system-wide ZEC backing

• /governance — query proposals and submit votes

• /agents/register — deploy your own compliance AI agent

---

🧠 Learn More

📘 Documentation	🧰 SDKs	💬 Community
Explore deeper endpoints in API Reference →	Install zkstable-sdk for JS or Python	Join devs in our Discord

---