Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hyperx.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Unity SDK is recommended for game clients, but server-side tools and operation automation can call the public HyperX Core REST API directly.

​
Documentation URLs

  • ReDoc: https://core.hyperx.dev/reference
  • Swagger UI: https://core.hyperx.dev/swagger
  • OpenAPI JSON: https://core.hyperx.dev/openapi.json

​
Common Headers

HeaderRequiredDescription
x-project-codeYesProject code from Console. The SDK sends it automatically.
Authorization: Bearer <access_token>Yes for authenticated APIsAccess token returned after login.
x-hyperx-sdk-versionNoSDK version sent by official SDKs.
x-hyperx-runtimeNoRuntime such as Unity or .NET.
x-trace-idNoID used for log tracing.
x-request-idNoID for one request.

​
API Areas

AreaMain Features
ProjectProject lookup, server time
UsersGuest/custom/social login, refresh, logout, current user, characters
DataShared data, user data, user preferences, character data
ContentPublic Storage, game configs, probability tables
LiveOpsRankings, coupons, game logs, operation content, push devices
PurchasesStore purchase validation, purchase history, refund/cancel webhooks
SocialSearch, random lookup, friends, mail, messages, guilds, notifications
RealtimeNotification stream, chat channels, messages, acknowledgements, reports

​
Error Shape

Errors return JSON. The SDK exposes the same values through HyperXServerException. 
{
  "error": "unauthorized",
  "code": "UNAUTHORIZED",
  "message": "unauthorized",
  "service": "core",
  "trace_id": "trace_123",
  "request_id": "request_123",
  "context": {}
}
See Error Handling for client-side handling.