ScorpionAPI

A versioned contract for game observations, native input and owned rendering.

Contract 1.0.0 · JavaScript executor documentation

Private preview, not a community-script global

The 1.0.0 game SDK is implemented internally and remains a private preview. There is currently no public scorpion global in user scripts. An executor entitlement does not make SDK calls available. The reference describes the verified contract, not a promise that it can be used by installed community scripts today.

ScorpionAPI runs inside the extension near the game. The api.getscorpion.online web service handles accounts and licensing; it is not the game SDK. Public documentation is readable without a subscription.

Observations and freshness

Player, entity and camera queries return observations with availability, observedAt, ageMs, source and value. Availability is verified, stale or unavailable. Unavailable values remain null. Times are measured on the game document clock; do not compare them directly with subscription timestamps.

interface Observation<T> {
    availability: "verified" | "stale" | "unavailable";
    observedAt: number | null;
    ageMs: number | null;
    source: "client-observed";
    value: T | null;
}

Capabilities and permission requirements

Observation methods require api.access. Native input, rendering, bounded network frame observation and WASM information require api.advanced. Diagnostic access requires developer.tools. A capability failure must be handled without assuming that the game or another script has failed.

Verified contracts and types

See the API reference for the generated method inventory and download the TypeScript declaration file. These files describe the 1.0.0 contract. They do not implement TypeScript compilation in the editor or expose a constructor for the private SDK.