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.

LiveOps features help you operate the game after launch. Most settings are created and published from Console, then read or updated from Unity through the SDK.

​
Rankings

await HyperX.Core.Rankings.SubmitJson(
    "arena",
    session.AccessToken,
    score: 1500,
    metadataJson: "{\"stage\":3}"
);

var top = await HyperX.Core.Rankings.Top("arena", limit: 50);
var me = await HyperX.Core.Rankings.Me("arena", session.AccessToken);
var aroundMe = await HyperX.Core.Rankings.AroundMe("arena", session.AccessToken, limit: 5);
Create ranking keys in Console and keep them consistent with client code.

​
Coupons

var coupons = await HyperX.Core.Coupons.List(limit: 20);

var redemption = await HyperX.Core.Coupons.Redeem(
    "WELCOME",
    session.AccessToken
);

var reward = redemption.RewardPayload;
Coupon rewards are returned as JSON payloads. Apply currency, inventory, or mail rewards according to your game policy.

​
Game Logs

await HyperX.Core.Logs.InsertJson(
    "stage_clear",
    session.AccessToken,
    "{\"stage\":3,\"elapsed\":92}"
);
Use consistent event names and keep payloads limited to values you need for operations or analysis.

​
Operation Content

Notices, events, and policies are created and published from Console. SDK calls return only content that matches publish status, schedule, locale, and country. 
var notices = await HyperX.Core.Operations.Notices(
    session.AccessToken,
    locale: "en",
    country: "US",
    limit: 10
);

var events = await HyperX.Core.Operations.Events(session.AccessToken);
var policies = await HyperX.Core.Operations.Policies(session.AccessToken);

​
Push Device Registration

After your app receives an FCM registration token or APNs device token, register it with HyperX. 
await HyperX.Core.Push.RegisterDevice(
    deviceToken,
    "android",
    session.AccessToken,
    optIn: true,
    locale: "en-US",
    timezone: "America/Los_Angeles"
);
Use "android" or "ios" for platform. If a player opts out, register with optIn: false. See Provider Integrations for credential setup.

​
Groups

var group = await HyperX.Core.Groups.Me(session.AccessToken);
Groups are created in Console and assigned to users. Use them for group rankings, events, and operational segmentation.