FOS LogoFOS Documentation
Technical Docs

APIs & Data Models

API endpoints and data schemas

APIs & Data Models

Endpoints

EndpointMethodDescription
/statusGETSystem health and current phases
/allowlist/proofPOSTReturns Merkle proof for a wallet
/allocation/:walletGETAllocation eligibility and claim status

Application APIs

  • Transactions: Saved post-mint via transaction handler API (wallet, tx hash, NFT details, amount).
  • Leaderboard: /api/leaderboard_handler.php for podium/list and diagnostics (test/debug endpoints).
  • Profile: /api/profile_handler.php for user profile data and referral info.
  • Explorer Sync: Periodically read and cross-check user transactions and events from BaseScan for transparency.

Schemas

  • User: wallet, roles, preferences.
  • Mint: tx hash, phase, amount, timestamp.
  • Allocation: tier, allocation, claimedAt, tx hash.

Glossary & References

TermDefinition
Merkle ProofCompact proof of inclusion in a set using Merkle trees.
AllowlistCurated list of eligible wallets for restricted phases.
VRFVerifiable Random Function, for auditable randomness.
AllocationProtocol distribution of funds to selected participants based on predefined rules and selection mechanics.
BaseScanThe primary block explorer for the Base network, used to inspect transactions, events, and contract state for transparency and audits.
L2 SecuritySecurity model whereby the Base network inherits Ethereum's consensus and settlement guarantees while providing higher throughput and lower fees off-layer.
Chainlink LINK SubscriptionA funded subscription on Chainlink's network that pays for VRF requests and oracles; the protocol relies on this subscription to obtain verifiable randomness on Base.

References: OpenZeppelin Contracts, EIPs (ERC-20/721/1155), Chainlink VRF docs, The Graph.

On this page