Skip to main content
Docs

Heimdall

A comprehensive full-stack platform for managing stream-related data with real-time updates, robust API capabilities, and modern web applications.

REST APIGraphQLWebSocketsOAuth 2.0
Get StartedAPI ReferenceSwagger UI

The Platform

Five integrated services working together

API
High-performance backend with REST, GraphQL, and WebSocket APIs built with Actix-web.
Backend
Admin dashboard for platform management with real-time updates.
ID
Identity service with OAuth, 2FA, and secure session management.
Docs
Comprehensive documentation with interactive API explorer.
Policies
Legal pages with cookie consent and internationalization support.

Key Features

Everything you need to build modern applications

REST API
RESTful endpoints with OpenAPI docs and HATEOAS links.
GraphQL
Flexible queries with GraphiQL IDE and introspection.
WebSockets
Real-time bidirectional communication for live updates.
OAuth & 2FA
Multi-provider OAuth (Twitch, Discord, YouTube, GitHub) with two-factor authentication.
API Keys
Programmatic access with scopes and permissions.
File Storage
S3-compatible storage with presigned URLs and image optimization.
GDPR Compliance
Data export, account deletion, and privacy controls.
Testing
Comprehensive test suite with unit, integration, E2E, and security tests.

Built With

Backend

RustMemory-safe systems language for blazing-fast performanceActix-webHigh-performance async web framework with WebSocket supportasync-graphqlType-safe GraphQL server library for RustSQLSQLxCompile-time checked SQL queries with async supportProtobufBinary serialization for efficient bot communication

Frontend

Next.js 15Full-stack React framework with App Router and server componentsReact 19Modern UI library with concurrent rendering and hooksTypeScriptStatic typing for better DX and fewer runtime errorsTailwindCSSUtility-first CSS framework for rapid UI developmentShaka PlayerAdaptive video player with HLS/DASH support

Infrastructure

PostgreSQLReliable relational database for persistent storageTimescaleDBTime-series extension for audit logs and GPS dataRedisIn-memory store for caching, sessions, and pub/subS3Object storage for files, images, and mediaDockerContainerization for consistent deployments

Testing

Cargo TestRust unit and integration testingVitestFast TypeScript/React unit testingPlaywrightCross-browser E2E testing

Shared Libraries

Reusable packages for rapid development

@elcto/ui
25+ React components: Button, Card, Modal, Avatar, Toast, and more.
@elcto/api
REST, GraphQL, and WebSocket clients with TypeScript types.
@elcto/cookies-consent
GDPR-compliant cookie consent with analytics integrations.
@elcto/player
Video player with HLS/DASH/MP4 support and resume playback.
heimdall-audit
Rust crate for audit event types, constants, and logging helpers.
heimdall-storage
S3-compatible storage operations with presigned URLs and sanitization.
heimdall-proto
Protobuf definitions for WebSocket and bot communication.

Service URLs

Access our services in production or development

DevelopmentProduction

REST API

RESTful endpoints & OpenAPI docs

Endpoint
https://api.elcto.com/v1

WebSocket

Real-time connections & live updates

Endpoint
wss://api.elcto.com/v1/ws

GraphQL

Flexible queries & mutations

Endpoint
https://api.elcto.com/v1/gql
GraphiQL
https://api.elcto.com/v1/graphiql
Schema
https://api.elcto.com/v1/schema

Backend

Admin dashboard for platform management

Endpoint
https://console.elcto.com

ID

Authentication & identity service

Endpoint
https://id.elcto.com

Docs

Documentation & API reference

Endpoint
https://docs.elcto.com

Policies

Legal pages & cookie consent

Endpoint
https://policies.elcto.com

Ready to get started?

Check out the documentation to learn how to integrate with Heimdall.

Quick Start GuideCode Examples