Build on Aetheria OS
Integrate hospitality intelligence into your applications with our RESTful API. Manage bookings, guest experiences, operations, and analytics programmatically.
API Overview
A comprehensive set of APIs covering every aspect of hospitality operations. All endpoints return JSON and follow RESTful conventions.
Bookings
Create, update, and manage reservations across all properties and channels.
Guests
Guest profiles, preferences, loyalty data, and communication history.
Properties
Property details, room types, availability, and inventory management.
Payments
Process payments, refunds, invoices, and financial reconciliation.
Operations
Housekeeping, maintenance, staff scheduling, and task management.
Analytics
Revenue reports, occupancy metrics, guest insights, and performance data.
Getting Started
Go from zero to your first API call in under five minutes.
Get Your API Key
Sign in to your Aetheria OS dashboard, navigate to Settings > API Keys, and generate a new key. Each key is scoped to your organization.
Read the Documentation
Explore our comprehensive API reference with request/response examples, authentication guides, and integration patterns.
Start Building
Use our RESTful API with any language. Start with the interactive API Explorer, then integrate into your application.
Simple, Predictable API
Clean RESTful endpoints with consistent response formats. Use standard HTTP methods and status codes. Every response includes pagination metadata for list endpoints.
// List upcoming bookings
const response = await fetch(
"https://api.aetheria.io/v1/bookings?status=confirmed&limit=10",
{
headers: {
"Authorization": "Bearer ak_live_your_api_key",
"Content-Type": "application/json",
},
}
);
const { data, pagination } = await response.json();
// Each booking includes guest, property, and payment details
console.log(`Found ${pagination.total} bookings`);
data.forEach((booking) => {
console.log(`${booking.guest.name} — ${booking.property.name}`);
console.log(` Check-in: ${booking.checkIn}, Check-out: ${booking.checkOut}`);
});API Explorer
Try every endpoint directly in your browser. Our Swagger-powered API Explorer lets you authenticate, send requests, and inspect responses without writing any code.
Open API ExplorerOfficial SDKs
Native libraries for your preferred language. Handles authentication, retries, pagination, and type safety out of the box.
JavaScript / TypeScript
@aetheria/sdk
Coming SoonPython
aetheria-sdk
Coming SoonPHP
aetheria/sdk
Coming SoonRate Limits
Generous rate limits that scale with your plan. All responses include rate limit headers so you can monitor usage programmatically.
| Plan | Requests | Window | Burst |
|---|---|---|---|
| Starter | 100 | per minute | 20 req/s |
| Professional | 1,000 | per minute | 50 req/s |
| Enterprise | 10,000 | per minute | 200 req/s |
Rate limit headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
Authentication
All API requests are authenticated using Bearer tokens. Generate API keys from your dashboard with granular permission scopes.
Bearer Token
Include your API key in the Authorization header of every request.
Authorization: Bearer ak_live_your_api_keyPermission Scopes
Keys can be scoped to specific resources: bookings:read, bookings:write, guests:read, payments:write, and more.
Environments
Use ak_test_ prefixed keys for sandbox and ak_live_ for production.
Security Best Practices
- Never expose API keys in client-side code
- Rotate keys periodically from your dashboard
- Use the minimum required permission scopes
- Monitor usage via the API Keys dashboard
- Use test keys during development
- Set up webhook signatures for payload verification
Ready to integrate?
Get your API key and start building integrations with Aetheria OS today. Our team is here to help if you need support.