API Reference
Canonical integration overview for GraphQL and task-oriented REST surfaces.
ƒxyz exposes two integration surfaces:
- GraphQL is the canonical application API for members, identities, network data, vouchers, and cross-domain object graphs.
- REST is used for task-oriented or stream-oriented services such as Bridge flows, Fixie agents, Solana lookups, documents, prices, and operational endpoints.
GraphQL
Canonical schema for member identity, onboarding, network graph, wallets, vouchers, and system data.
REST
Route-family overview for Bridge, Fixie, Solana, documents, prices, FX data, stars, and more.
Endpoints
GraphQL (prod): https://api.fxyz.network/api/graphql
REST base : https://api.fxyz.network/api
GraphQL (dev): http://localhost:3002/api/graphqlThe API is served from the apps/api Next.js application. GraphQL runs through GraphQL Yoga, not Apollo
Server, and production introspection is disabled by the route configuration.
Authentication
Most user-facing calls require a Privy JWT.
Authorization: Bearer <privy-jwt-token>
x-persona-id: <persona-id>
Content-Type: application/jsonAuthorizationis required for authenticated GraphQL operations and most protected REST routes.x-persona-idis optional and lets a signed-in member act through a specific persona when the route supports it.
GraphQL Domains
The schema is organized into domain modules under apps/api/app/api/graphql/schema/.
| Domain | What it covers |
|---|---|
member, persona, membership | Identity, onboarding, membership state, proofs, and persona operations |
network, wallet | Network graph queries, wallet-linked data, and connected system views |
voucher, invite, coin-code | Voucher issuance/redeem flows and distribution mechanics |
fibo, rwa, system, other | FIBO-aligned entity data, broader platform surfaces, and system metadata |
Useful GraphQL Operations
query MemberIdentity($did: String!) {
memberIdentity(did: $did) {
standing
contributionLevel
ring
score
starColor
activePersona {
id
label
}
}
}mutation EnsureOnboarding($inviteCode: String) {
ensureOnboarding(inviteCode: $inviteCode) {
success
isNewMember
message
fixieId
inviteIntendedLevel
}
}query NetworkGraph {
networkGraph(limit: 12) {
nodes {
id
type
labels
}
links {
source
target
type
}
metadata {
nodeCount
linkCount
lastUpdated
}
}
}REST Route Families
The REST surface currently groups into these families:
| Family | Route prefix | Notes |
|---|---|---|
| Bridge | /api/bridge/* | KYC links, virtual accounts, external accounts, transfers, liquidations, rates |
| Fixie | /api/fixie/* | Agent lifecycle, chat, blocks, memory, tools, templates |
| Solana | /api/solana/* | Balance, assets, portfolio, RPC proxying, token accounts, transactions |
| Data | /api/prices, /api/fx/*, /api/market-data, /api/cbdc | Price feeds, FX rates, and market summaries |
| Documents | /api/documents/* | List, upload, seed, and fetch document content |
| Platform | /api/membership/*, /api/stars/*, /api/invest/*, /api/whoami, /api/health | Member proofs, stars, investment flows, health, and session identity |
Internal routes such as /api/admin/*, /api/cron/*, and webhook handlers exist but are not part of the public integration surface.
Choose The Right Surface
- Use GraphQL when you want a typed application model or need to compose multiple resources in one request.
- Use REST when the action is transactional, upload-heavy, stream-oriented, or tightly bound to an external service contract.
Next Steps
- Need route-level detail: REST API Reference
- Need local setup: Local Development
- Need system context behind the API: Technical Overview