← Back to Home

API Documentation

Reference for the Zcash.me directory API.

Directory API

The Directory API provides access to Zcash.me user profiles, addresses, and verified social links. For wallet integration documentation, see the Wallet API Guide.

GET /api/lookup/{username}

Public endpoint. Resolve a username to a Zcash address.

Response
{
  "username": "alice",
  "display_name": "Alice",
  "address": "u1...",
  "address_verified": true
}

GET /api/resolve/{username}

Full profile including links and verification status.

Response
{
  "username": "alice",
  "display_name": "Alice",
  "profile_image_url": "https://...",
  "bio": "Zcash enthusiast",
  "nearest_city_name": "New York",
  "address": "u1...",
  "address_verified": true,
  "verified_at": "2025-10-23T10:58:54.721199+00:00",
  "authenticated_links": [
    { "id": 1, "label": "alice", "url": "https://x.com/alice", "platform": "X", "is_verified": true }
  ],
  "unauthenticated_links": []
}

GET /api/directory?q={query}&limit=25

Search and browse profiles. Supports pagination with cursor.

GET /api/social?platform=x&handle={handle}

Find a Zcash address by social media handle.

Supported platforms: x, twitter, github, instagram, reddit, linkedin, discord, tiktok, bluesky, mastodon, snapchat, telegram

Health & Status

GET /api/health

Service health check. Returns status of Supabase directory and ZVS verification service.

Response
{
  "status": "ok",
  "services": {
    "zcashme": { "status": "ok", "latency_ms": 0 },
    "directory": { "status": "ok", "latency_ms": 45 },
    "verifications": { "status": "ok", "latency_ms": 23 }
  }
}

GET /api/openstatus

External status page data from OpenStatus.

For questions or to request an API key, contact: james@zcash.me