ƒxyzƒxyz Docs
Developer

REST API Reference

Current route-family map for Bridge, Fixie, Solana, data, documents, and platform endpoints.

The REST surface in apps/api is broad, but it is no longer documented here as a single random list. This page groups the route families that exist in the current codebase and flags which ones are public-facing versus internal.

Base URL: https://api.fxyz.network/api

GraphQL remains the canonical application API. REST is best for service contracts, uploads, streams, third-party integrations, and operational surfaces.

Authentication

Most protected routes use:

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

Some operational or webhook routes use secrets or service-specific verification instead of user JWTs.

Public Route Families

Bridge

/api/bridge/kyc-links
/api/bridge/virtual-accounts
/api/bridge/external-accounts
/api/bridge/transfers
/api/bridge/transfers/[transferId]
/api/bridge/liquidation
/api/bridge/liquidations
/api/bridge/rates
/api/bridge/customers/[customerId]/capabilities
/api/bridge/customers/[customerId]/kyc-link

Use these routes for KYC, linked bank accounts, pay-ins, off-ramps, and quote/rate flows.

Fixie

/api/fixie
/api/fixie/[agentId]
/api/fixie/[agentId]/chat
/api/fixie/[agentId]/stream
/api/fixie/[agentId]/memory
/api/fixie/[agentId]/blocks
/api/fixie/[agentId]/tools
/api/fixie/templates
/api/fixie/tools
/api/fixie/tools/neo4j-query

These routes cover agent lifecycle, chat, streaming, memory blocks, and tool execution.

Solana

/api/solana/balance
/api/solana/assets
/api/solana/portfolio
/api/solana/rpc
/api/solana/token-account
/api/solana/transactions
/api/solana/nft-metadata

Use these routes for wallet balances, portfolio views, asset inventory, transaction history, and selected RPC passthroughs.

Data And Market Surfaces

/api/prices
/api/prices/[asset]
/api/fx/rates
/api/fx/bis
/api/market-data
/api/cbdc
/api/neo4j/stats
/api/health

These routes expose price, FX, market, CBDC, graph stats, and health information.

Documents

/api/documents
/api/documents/[id]
/api/documents/upload

These support document inventory and upload flows. seed-bibliography exists in the repo but is operational rather than end-user facing.

Platform Flows

/api/invest
/api/invest/request
/api/invest/graph
/api/invest/rage-quit
/api/membership/proof/[did]
/api/membership/proof/internal/[did]
/api/membership/[mint]/metadata
/api/stars
/api/stars/available
/api/stars/[starId]
/api/stars/[starId]/metadata
/api/stars/mint-nft
/api/notifications
/api/whoami

These routes cover investment workflows, proofs, stars, notifications, and session/user inspection.

Internal Or Operational Routes

The following route families exist, but they are not public integration entry points:

  • /api/admin/*
  • /api/cron/*
  • /api/governance/seed
  • /api/documents/seed-bibliography
  • /api/telegram/*
  • webhook handlers under apps/api/app/webhooks/*

Choosing REST vs GraphQL

  • Use REST when the action is tightly bound to a service boundary or transport pattern.
  • Use GraphQL when you want typed application models or multi-resource queries.

Related docs:

On this page