ƒxyz Network Docs

There are three good ways into ƒxyz: use the application, integrate with the API, or run the stack locally.

Use the Platform

Open the member app, sign in, and work through onboarding, wallets, and membership.

Integrate the API

Use GraphQL for canonical application data and REST for task-oriented surfaces.

Run It Locally

Start the monorepo, Neo4j, the API, and the docs site with pnpm.

1. API Integration Minimum

Production GraphQL endpoint: https://api.fxyz.network/api/graphql

Production REST base: https://api.fxyz.network/api

All authenticated calls use a Privy bearer token. Persona-aware requests may also send x-persona-id.

Authorization: Bearer <privy-jwt>
x-persona-id: <persona-id>

Example GraphQL Query

query IdentitySnapshot($did: String!) {
  memberIdentity(did: $did) {
    standing
    contributionLevel
    ring
    score
    expertiseTitle
  }
  membershipStats {
    totalMembers
    activeMemberships
    revokedMemberships
  }
}

Example Onboarding Mutation

mutation EnsureOnboarding($inviteCode: String) {
  ensureOnboarding(inviteCode: $inviteCode) {
    success
    isNewMember
    message
    member {
      did
      privyUserId
    }
  }
}

2. Local Development Minimum

Install dependencies with pnpm install.

Start Neo4j with docker compose -f docker/neo4j/docker-compose.yml up -d.

Start the workspace with pnpm dev.

Open the relevant surface:

http://localhost:3000 for the member app
http://localhost:3002/api/graphql for the API
http://localhost:3004/docs for the docs site

Need orientation: Docs Map
Need developer setup: Local Development
Need architecture truth: Technical Overview
Need hidden source material: Research Atlas

Quickstart