API Reference
Overview
The CS2Inspect API provides RESTful endpoints for managing user loadouts, weapon customizations, and CS2 item data. All endpoints return JSON responses and require authentication unless otherwise noted.
Auto-Generated Documentation
This API reference includes both manually curated documentation and auto-generated endpoint listings. See Generated API Reference for the complete auto-generated endpoint list.
Base URL
Development: http://localhost:3210/api
Production: https://your-domain.com/apiQuick Links
| Category | Description |
|---|---|
| Authentication | JWT tokens, Steam OpenID login |
| Health Checks | Liveness, readiness, and detailed health probes |
| Data Endpoints | Weapons, skins, stickers, agents, and more |
| Loadouts | User loadout management |
| Items | Weapon, knife, glove, and pin management |
| Inspect System | CS2 inspect URL processing |
| Error Handling | Error codes and responses |
API Categories
🔐 Authentication
Steam OpenID authentication and JWT token management.
- Token-based authentication
- Cookie and header support
- 7-day token expiry
💚 Health Checks
Monitoring endpoints for container orchestration and status dashboards.
- Liveness probe (
/api/health/live) - Readiness probe (
/api/health/ready) - Detailed health information (
/api/health/details) - Historical health data (
/api/health/history)
📦 Data Endpoints
Static data retrieval for weapons, skins, stickers, and more.
- Weapon skins
- Agents
- Stickers
- Keychains
- Music kits
- Collectibles (Pins)
🎒 Loadouts
User loadout management system.
- Create, update, delete loadouts
- Switch active loadout
- Equipped loadout for CS2 plugin
🔫 Items
Weapon, knife, glove, and pin customization.
- Weapon management
- Knife management
- Glove management
- Pin management
🔍 Inspect System
CS2 inspect URL processing and generation.
- Analyze inspect links
- Create custom inspect URLs
- Extract item data
⚠️ Error Handling
Consistent error response format and codes.
- Standard error format
- Common error codes
- HTTP status codes
Request/Response Format
Standard Headers
Request:
Content-Type: application/json
Accept: application/json
Authorization: Bearer {token}Response:
Content-Type: application/json
X-Request-ID: {unique-id}
X-Response-Time: {ms}Related Documentation
- Architecture - System architecture
- How It Works - User flows
- Setup Guide - Development setup