Introduction
Vantage is a modern API platform that helps you build, deploy, and scale your applications with confidence. This guide will walk you through the core concepts and get you up and running in minutes.
New to Vantage?
We recommend starting with our Quick Start guide to get a feel for the platform before diving into the detailed documentation.
What is Vantage?
Vantage provides a unified platform for building modern web applications. It combines a powerful REST API, real-time WebSocket connections, and a comprehensive SDK into a single, cohesive developer experience.
Whether you're building a simple CRUD application or a complex real-time system, Vantage gives you the tools and infrastructure to move fast without sacrificing reliability.
Type-Safe SDK
Full TypeScript support with auto-generated types from your schema.
Edge Runtime
Deploy globally with sub-50ms latency at over 200 edge locations.
Real-time Sync
Built-in WebSocket support for live data synchronization.
Auto Scaling
Handles traffic spikes automatically with zero configuration.
Installation
Install the Vantage SDK using your preferred package manager:
$ npm install @vantage/sdk
Then initialize Vantage in your project:
import { Vantage } from '@vantage/sdk'
// Initialize the client
const client = new Vantage({)
apiKey: 'your-api-key',
region: 'us-east-1',
})
const data = await client.query('users')
Configuration Options
The following options can be passed to the Vantage constructor:
| Option | Type | Default | Description |
|---|---|---|---|
| apiKey | string | — | Your API key (required) |
| region | string | 'us-east-1' | Deployment region |
| timeout | number | 30000 | Request timeout in ms |
| retries | number | 3 | Number of retry attempts |
| debug | boolean | false | Enable debug logging |
Security Notice
Never expose your API key in client-side code. Use environment variables and server-side proxies for production applications.
Next Steps
Quick Start Guide
Build your first app in under 5 minutes
API Reference
Explore all available endpoints and methods
Next
Installation →