​

Welcome to ƒ(xyz) Network API

The ƒ(xyz) Network API provides a unified GraphQL interface for accessing all blockchain, governance, and financial data within the ƒ(xyz) ecosystem. Our API includes real-time subscriptions, Neo4j graph database integration, and comprehensive support for confidential transactions and DeFi operations.

​

🚀 GraphQL Endpoint

All API operations are performed through a single GraphQL endpoint:

POST https://api.fxyz.network/graphql

Local Development:

POST http://localhost:3002/graphql

​

Key Features

• Unified Interface: All data operations through one endpoint
• Real-time Subscriptions: Live updates for network changes
• Type Safety: Strong typing with GraphQL schema
• Efficient Queries: Request exactly the data you need
• Neo4j Integration: Direct graph database queries
• Confidential Transactions: Privacy-preserving financial operations

​

Authentication

API operations requiring authentication use Bearer tokens:

Authorization: Bearer <your-token>

Admin-level operations require elevated permissions and are restricted to authenticated administrators.

​

Core Operations

​

🔍 Query Operations

​

✏️ Mutation Operations

​

🔄 Subscription Operations

Real-time updates for live network monitoring:

​

Example Queries

​

Get Network Graph Data

query NetworkGraph {
  networkGraph(limit: 100) {
    nodes {
      id
      labels
      type
      properties
    }
    links {
      id
      source
      target
      type
      properties
    }
    metadata {
      nodeCount
      linkCount
      lastUpdated
    }
  }
}

​

Get User Portfolio

query GetUserPortfolio($userId: String) {
  getUserPortfolio(userId: $userId) {
    success
    data {
      totalBalance
      tokens {
        symbol
        amount
        value
      }
      vouchers {
        id
        amount
        status
      }
      invites {
        id
        status
        expiresAt
      }
    }
    error
  }
}

​

Create and Issue Voucher

mutation IssueVoucher($amount: Float!, $recipientEmail: String, $expiresAt: String) {
  issueVoucher(amount: $amount, recipientEmail: $recipientEmail, expiresAt: $expiresAt) {
    id
    code
    amount
    status
    createdAt
    expiresAt
  }
}

​

Real-time Network Updates

subscription NetworkUpdates {
  networkUpdated {
    nodes {
      id
      labels
      type
    }
    links {
      id
      source
      target
      type
    }
    metadata {
      nodeCount
      linkCount
      lastUpdated
    }
  }
}

​

System Endpoints

These endpoints remain as REST for system functionality:

​

Error Handling

GraphQL errors follow the standard GraphQL error format:

{
  "errors": [
    {
      "message": "Error description",
      "locations": [{"line": 2, "column": 3}],
      "path": ["fieldName"]
    }
  ],
  "data": null
}

​

Rate Limiting

API requests are subject to rate limiting based on authentication status:

• Unauthenticated: 100 requests per hour
• Authenticated: 1000 requests per hour
• Admin: 5000 requests per hour

​

Real-time Features

The API supports GraphQL subscriptions for real-time updates:

• WebSocket Connection: Automatic upgrade from HTTP
• Event-driven Updates: Publish/Subscribe pattern
• Efficient Updates: Only changed data is transmitted
• Connection Management: Automatic reconnection and error handling

​

Confidential Transactions

The API supports privacy-preserving financial operations:

• ElGamal Encryption: Zero-knowledge balance proofs
• Confidential Transfers: Private transaction amounts
• Compliance Integration: Selective disclosure capabilities
• Multi-sig Support: Complex approval workflows

​

Support

For API support and questions:

• Documentation: docs.fxyz.network
• GraphQL Playground: api.fxyz.network/graphql
• Support: [email protected]