@ceed/economy-sdk

Add a complete economy to any platform in minutes — tips, payments, subscriptions, streaming, exchange, and AI agents.

Install

npm install @ceed/economy-sdk

Quick Start

import { CeedEconomy } from '@ceed/economy-sdk';

const ceed = new CeedEconomy({
  apiKey: 'ceed_pk_your_key_here',
  sandbox: true, // Use sandbox mode for testing
});

// Launch a coin
const coin = await ceed.launchCoin({
  name: 'ArtistCoin',
  symbol: 'ART',
  totalSupply: 1_000_000,
  creatorAllocationPct: 20,
  vestingMonths: 12,
  backingCeed: 1000,
});

// Accept tips
const tip = await ceed.tip({
  toUserId: 'creator-uuid',
  coinSymbol: 'ART',
  amount: 5,
  message: 'Great work!',
});

// Subscriptions
const sub = await ceed.subscribe({
  providerId: 'creator-uuid',
  coinSymbol: 'ART',
  amount: 10,
  interval: 'monthly',
});

// Pay-per-stream
const session = await ceed.startStream({
  streamerId: 'creator-uuid',
  coinSymbol: 'ART',
  ratePerMinute: 0.01,
});
const result = await ceed.endStream(session.data.session_id);

Authentication

| Method | Header | Use Case | |--------|--------|----------| | Platform Key | X-Platform-Key | Server-to-server | | Agent Key | X-Agent-Key | AI agent operations | | User Token | Authorization: Bearer <jwt> | Client-side (SSO) |

// Server-to-server
const ceed = new CeedEconomy({ apiKey: 'ceed_pk_...' });

// AI agent
const ceed = new CeedEconomy({ agentKey: 'ceed_ak_...' });

// Client-side (after SSO login)
const ceed = new CeedEconomy({ userToken: jwt });

Sandbox Mode

Test with fake CEED — no real money, same API surface:

const ceed = new CeedEconomy({
  apiKey: 'ceed_pk_...',
  sandbox: true,
});

await ceed.resetSandbox(); // Re-seeds 10,000 fake CEED
const bal = await ceed.sandboxBalance();

API Reference

Economy

• tip(params) — Tip any user in any coin
• pay(params) — One-time payment
• subscribe(params) — Create recurring subscription
• cancelSubscription(id) — Cancel a subscription
• balance() — Get user balances
• earnings(userId) — Get earnings breakdown
• launchCoin(params) — Launch a new coin
• airdrop(params) — Airdrop coins to multiple users
• coinStats(symbol) — Get coin statistics

Streaming

• startStream(params) — Start pay-per-stream session
• endStream(sessionId) — End stream and settle payment

Exchange

• market() — Get all tradeable pairs
• ticker(pair) — Get ticker for a pair
• orderbook(pair) — Get order book
• placeOrder(params) — Place a limit or market order
• cancelOrder(orderId) — Cancel an order
• exchangeBalances() — Get exchange balances

Trading Bot

• spybotStatus() — Get SPYBOT status
• signals() — Get recent trade signals

Auth

• signup(email, password, name?) — Sign up
• login(email, password) — Login and get JWT
• refresh(refreshToken) — Refresh JWT
• me() — Get current user profile

Webhooks

• registerWebhook({ url, events }) — Register a webhook

API Keys

• createApiKey(name, keyType?, scopes?) — Create API key
• listApiKeys() — List API keys (prefix only)
• revokeApiKey(keyId) — Revoke an API key

Sandbox

• resetSandbox() — Reset sandbox (re-seeds 10K CEED)
• sandboxBalance() — Get sandbox balances

Analytics

• apiUsage(days?) — Get API usage stats
• apiHealth() — Get global API health

Health

• health() — Check API status

Response Format

All methods return CeedResponse<T>:

interface CeedResponse<T> {
  ok: boolean;     // true if HTTP 2xx
  status: number;  // HTTP status code
  data: T;         // Response payload
}

Links

• Developer Docs
• API Reference
• Discord

License

MIT