OASIS API Documentation

Overview

Welcome to the OASIS API documentation. The OASIS platform provides two comprehensive API layers:

• WEB4 OASIS API - The foundational layer bridging Web2 and Web3

• WEB5 STAR API - Advanced metaverse and application development layer

API Documentation

WEB4 OASIS API

The WEB4 OASIS API provides the core infrastructure for the OASIS ecosystem, including:

• Identity & Authentication - Avatar, Keys, Karma management

• Data & Storage - Universal data management across Web2/Web3

• Blockchain Integration - Multi-chain wallet, NFT, and transaction support

• Network Operations - ONET protocol and HyperDrive functionality

• Core Services - Search, Stats, Settings, Messaging, and more

View WEB4 OASIS API Documentation →

WEB5 STAR API

The WEB5 STAR API provides advanced functionality for building immersive metaverse experiences, including:

• Game Mechanics - Missions, Quests, Competition, Eggs

• Celestial Systems - Planets, Stars, Moons, Space Regions

• Location Services - GeoNFTs, GeoHotSpots, AR Integration

• Development Tools - OAPPs, Zomes, Templates, Runtimes

• Data Structures - Holons, Chapters, Inventory

• Communication - Chat, Messaging, Social Features

View WEB5 STAR API Documentation →

Getting Started

Authentication

All APIs require authentication using Bearer tokens:

Authorization: Bearer YOUR_TOKEN

Response Format

All API responses follow the standard OASIS response format:

{
  "result": {
    "success": true,
    "data": { ... },
    "message": "Operation successful"
  },
  "isError": false,
  "message": "Success"
}

Error Handling

Error responses include detailed information:

{
  "result": null,
  "isError": true,
  "message": "Error message",
  "exception": "Detailed error information"
}

API Features

Multi-Chain Support

• Ethereum, Solana, Cardano, NEAR, and 40+ blockchains

• Unified interface across all chains

• Automatic provider failover and load balancing

Real-Time Operations

• WebSocket support for live updates

• Event-driven architecture

• Push notifications

Security

• AES-256 encryption

• JWT authentication

• RBAC authorization

• GDPR/CCPA compliance

Performance

• Auto-scaling infrastructure

• CDN integration

• Response caching

• Rate limiting

Support & Resources

• Developer Documentation: DEVELOPER_DOCUMENTATION_INDEX.md

• Implementation Status: CURRENT_IMPLEMENTATION_STATUS.md

• Investor Guide: INVESTOR_EVALUATION_GUIDE.md

• Main README: README.md

Quick Links

• WEB4 OASIS API →

• WEB5 STAR API →

• Developer Documentation →

---

Back to Developer Documentation