1HOUSE API Documentation

Overview

Complete API reference for the 1HOUSE microservices platform

Enterprise-grade microservices platform for trading, education, and community engagement.

Welcome

Start building with our comprehensive API in minutes. All endpoints require API key authentication and support API versioning.

Quick Start

Get started with the 1House API in minutes:

Platform Overview

Enterprise Architecture

Built on microservices architecture with event-driven communication, horizontal scalability, and comprehensive monitoring.

The 1HOUSE platform provides:

  • 17 Microservices - Fully independent and scalable
  • 120+ API Endpoints - Complete REST API coverage
  • Event-Driven Architecture - Real-time updates via RabbitMQ
  • AI Integration - GPT-4 powered trading assistant
  • Video Processing - HLS/DASH adaptive streaming
  • Real-time Chat - WebSocket-based communication

Authentication

Two-Layer Authentication

Every API request must include:

  1. X-API-Key header (platform level)
  2. Authorization header with JWT token (user level)

All API requests require two layers of authentication:

1. API Key (Platform Level)

X-API-Key: your-api-key-here

2. JWT Token (User Level)

Authorization: Bearer your-jwt-token
# Production
curl https://api-gateway.prod.1houseglobalservices.com/v1/user/profile \
  -H "X-API-Key: your-production-api-key" \
  -H "Authorization: Bearer your-jwt-token"

# Development
curl https://api-gateway.dev.1houseglobalservices.com/v1/user/profile \
  -H "X-API-Key: your-development-api-key" \
  -H "Authorization: Bearer your-jwt-token"

API Environments

Important: Different API Keys

Each environment requires a different API key. Your development API key will not work in production, and vice versa. Make sure you're using the correct API key for the environment you're targeting.

The 1HOUSE API is available in two environments:

Production Environment

Base URL:

https://api-gateway.prod.1houseglobalservices.com

Use for:

  • Live applications
  • Production deployments
  • Real user traffic

API Keys: Contact your administrator for production API keys.

Development Environment

Base URL:

https://api-gateway.dev.1houseglobalservices.com

Use for:

  • Development and testing
  • Integration testing
  • Staging environments

API Keys: Contact your administrator for development API keys.

Local Development

http://localhost:8000

Note: Local development requires running the API Gateway locally.

Response Format

All endpoints return standardized JSON responses:

Success Response

{
  "success": true,
  "status": 200,
  "message": "Operation successful",
  "data": {
    // Your response data
  },
  "meta": {
    "timestamp": "2025-10-21T12:00:00.000Z",
    "version": "v1"
  }
}

Error Response

{
  "success": false,
  "status": 400,
  "message": "Validation error",
  "error": "Invalid email format",
  "meta": {
    "timestamp": "2025-10-21T12:00:00.000Z",
    "version": "v1"
  }
}

Paginated Response

{
  "success": true,
  "status": 200,
  "message": "Results retrieved",
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "pages": 5
  },
  "meta": {
    "timestamp": "2025-10-21T12:00:00.000Z",
    "version": "v1"
  }
}

Core Services

Rate Limiting

API requests are rate-limited per API key:

TierRequests/MinuteRequests/Hour
Mobile601,000
Live Platform1205,000
CRM30015,000
Third Party602,000
AdminUnlimitedUnlimited

SDKs and Tools

Additional Resources

Learn More

Explore our comprehensive guides: