OrbNET API Overview
Core VPN platform backend API with REST, gRPC, and WebSocket protocols.
OrbNET API
The core backend powering the entire OrbVPN platform. Manage authentication, users, devices, subscriptions, VPN connectivity, mesh networking, token economy, and more through REST, gRPC, and WebSocket protocols.
Base URLs
| Protocol | Base URL | Description |
|---|---|---|
| REST | https://api.orbai.world | All REST API endpoints |
| gRPC | grpc://api.orbai.world:50051 | gRPC services with TLS |
| WebSocket | wss://api.orbai.world/ws | Real-time notifications and chat |
Authentication
All protected endpoints require a JWT Bearer token in the Authorization header. Obtain tokens via the login endpoint.
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...Multiple Auth Methods
OrbNET supports JWT email/password login, OAuth 2.0 (Google, Apple, GitHub), passkey (WebAuthn/FIDO2) authentication, magic link (passwordless email), and QR code login from desktop. See the Authentication section for all methods.
API Categories
Explore all 26 categories of the OrbNET API. Each section contains full endpoint documentation with request/response examples.
Authentication
JWT login, OAuth, passkeys, magic links, QR code auth, token refresh, and session management.
Users
User profiles, preferences, avatar management, account settings, and admin user operations.
Devices
Register, activate, and manage up to 10 devices per subscription. Device sessions and remote logout.
Subscriptions
Plan selection, purchases, upgrades, downgrades, renewals, cancellations, and subscription lifecycle.
Billing
Payment processing via Stripe, PayPal, Apple IAP, crypto payments, invoices, and refunds.
VPN
WireGuard, VLESS, and OrbConnect configurations. Connection profiles, quick-connect, and protocol switching.
Smart DNS
Smart DNS service configuration, domain routing rules, streaming region selection, and DNS-over-HTTPS.
Servers
Server listing, location search, load balancing, latency-based recommendations, and server health status.
OrbMesh
Mesh networking management. Create mesh networks, add peers, configure routing, and manage mesh topologies.
Tokens
ORB token economy. Token balances, staking, rewards claiming, transfer history, and on-chain operations.
Referral
Referral program management. Generate referral codes, track invitations, view earnings, and payout history.
Reseller
Reseller portal API. Create sub-users, manage credits, custom branding, bulk operations, and commission tracking.
Support
Support ticket creation, replies, AI-powered chat assistant, knowledge base, and ticket status tracking.
Notifications
Push notifications, in-app messages, notification preferences, read status, and delivery management.
Security
Two-factor authentication (TOTP), passkey management, active sessions, login history, and security alerts.
Mining
Bandwidth sharing and mining. Start/stop mining sessions, earnings dashboard, and payout management.
Bridges
Bridge and obfuscation protocol management. CDN fronting, WebSocket tunnels, and protocol disguise configuration.
Static IP
Dedicated static IP provisioning, assignment, renewal, and port forwarding configuration.
Bandwidth
Bandwidth usage monitoring, data transfer statistics, speed test history, and usage alerts.
Wallets
Blockchain wallet management. Wallet creation, balance queries, transaction history, and on-chain rewards.
Rewards
Reward programs, daily check-ins, achievement milestones, streak tracking, and reward redemption.
Network Scanner
Network scanning tools. Port scanning, device discovery, vulnerability detection, and network mapping.
WebSocket
Real-time WebSocket endpoints for live notifications, chat messages, and connection status updates.
gRPC Services
490+ high-performance gRPC RPCs with Protocol Buffers. Streaming support for real-time operations.
Admin Dashboard
Administrative API for platform management. User oversight, server provisioning, analytics, and system configuration.
Quick Start
Authenticate and make your first API request in under a minute.
/api/v1/auth/loginAuthenticate and receive JWT access and refresh tokens
# Step 1: Login to get your JWT token
curl -X POST https://api.orbai.world/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{
"email": "user@example.com",
"password": "your_password"
}'
# Step 2: Use the token to list VPN servers
curl https://api.orbai.world/api/v1/servers \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"{
"success": true,
"data": {
"token": "eyJhbGciOiJIUzI1NiIs...",
"refreshToken": "dGhpcyBpcyBhIHJlZnJlc2...",
"expiresAt": "2026-02-09T12:00:00Z",
"user": {
"id": "usr_abc123",
"email": "user@example.com",
"role": "user",
"subscription": {
"plan": "premium",
"status": "active"
}
}
}
}Key Endpoints
The most commonly used OrbNET API endpoints to get you started.
Authenticate with email/password, OAuth, or passkeys
Create a new user account with email verification
Retrieve the authenticated user's full profile
Get all available VPN server locations with load info
Generate WireGuard or VLESS configuration for a server
Register a new device for VPN connectivity
View current subscription plan, status, and expiry
Check ORB token balance, staking status, and rewards
Protocol Support
REST API
300+ endpoints organized across 26 categories. Standard HTTPS with JSON request/response bodies. Ideal for web apps, mobile clients, and third-party integrations.
gRPC Services
490+ high-performance RPCs using Protocol Buffers. Server streaming for real-time updates. Used by OrbVPN native clients for low-latency server communication.
WebSocket Streams
Two persistent WebSocket endpoints: one for real-time push notifications and connection events, another for live AI-powered support chat.
Which Protocol Should I Use?
For most integrations, the REST API is the best starting point. Use gRPC when you need high throughput or streaming capabilities. Use WebSocket when you need real-time event delivery without polling.
Start Building with OrbNET
Explore 300+ REST endpoints, 490+ gRPC RPCs, and real-time WebSocket streams. The full power of the OrbVPN platform at your fingertips.