Hathora Cloud API: Welcome to the Hathora Cloud API documentation! Learn how to use the Hathora Cloud APIs to build and scale your game servers globally.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @hathora/cloud-sdk-typescript
pnpm add @hathora/cloud-sdk-typescript
bun add @hathora/cloud-sdk-typescript
yarn add @hathora/cloud-sdk-typescript zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39"
);
// Handle the result
console.log(result);
}
run();
GetConnectionInfo()
endpoint to get connection details for an active room.roomId
. :warning: Deprecatedregion
. :warning: Deprecatedregion
. :warning: Deprecatedstatus
or region
.status
or region
.status
or region
.status
or region
.orgId
.appId
and processId
.appId
. :warning: DeprecatedappId
and processId
.appId
and deploymentId
. :warning: Deprecatedregion
. Use this endpoint to display all public lobbies that a player can join in the game client. :warning: Deprecatedregion
. Use this endpoint to display all public lobbies that a player can join in the game client.shortCode
, then the most recently created lobby will be returned.wss://<host>:<port>/ws
and send a packet. To calculate ping, measure the time it takes to get an echo packet back. :warning: Deprecatedwss://<host>:<port>/ws
and send a packet. To calculate ping, measure the time it takes to get an echo packet back.buildId
that you must pass to RunBuild()
to build the game server artifact. You can optionally pass in a buildTag
to associate an external version with a build. :warning: DeprecatedbuildId
generated from CreateBuild()
. :warning: DeprecatedbuildId
that you must pass to RunBuild()
to build the game server artifact. You can optionally pass in a buildTag
to associate an external version with a build.uploadUrl
that can be used to upload the build to before calling runBuild
. Responds with a buildId
that you must pass to RunBuild()
to build the game server artifact. You can optionally pass in a buildTag
to associate an external version with a build.multipartUploadUrls
that can be used to upload larger builds in parts before calling runBuild
. Responds with a buildId
that you must pass to RunBuild()
to build the game server artifact. You can optionally pass in a buildTag
to associate an external version with a build.buildId
generated from CreateBuild()
.multipartUploadUrls
that can be used to upload larger builds in parts before calling runBuild
. Responds with a buildId
that you must pass to RunBuild()
to build the game server artifact. You can optionally pass in a buildTag
to associate an external version with a build.buildId
generated from CreateBuild()
.idToken
.appId
.appId
.appId
.appId
. Your organization will lose access to this application.appId
.appId
.appId
.appId
. Your organization will lose access to this application.
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
Error Object | Status Code | Content Type |
---|---|---|
errors.ApiError | 401,404,429 | application/json |
errors.SDKError | 4xx-5xx | / |
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError
that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue
. Additionally, a pretty()
method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import { ApiError, SDKValidationError } from "@hathora/cloud-sdk-typescript/models/errors";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
let result;
try {
result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39"
);
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case err instanceof SDKValidationError: {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case err instanceof ApiError: {
// Handle err.data$: ApiErrorData
console.error(err);
return;
}
default: {
throw err;
}
}
}
}
run();
You can override the default server globally by passing a server index to the serverIdx
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | https://api.hathora.dev |
None |
1 | https:/// |
None |
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
serverIdx: 1,
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39"
);
// Handle the result
console.log(result);
}
run();
The default server can also be overridden globally by passing a URL to the serverURL
optional parameter when initializing the SDK client instance. For example:
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
serverURL: "https://api.hathora.dev",
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39"
);
// Handle the result
console.log(result);
}
run();
The TypeScript SDK makes API calls using an HTTPClient
that wraps the native
Fetch API. This
client is a thin wrapper around fetch
and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient
constructor takes an optional fetcher
argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest"
hook to to add a
custom header and a timeout to requests and how to use the "requestError"
hook
to log errors:
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import { HTTPClient } from "@hathora/cloud-sdk-typescript/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new HathoraCloud({ httpClient });
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
hathoraDevToken |
http | HTTP Bearer |
To authenticate with the API the hathoraDevToken
parameter must be set when initializing the SDK client instance. For example:
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39"
);
// Handle the result
console.log(result);
}
run();
Some operations in this SDK require the security scheme to be specified at the request level. For example:
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.lobbiesV1.createPrivateLobbyDeprecated(
{
playerAuth: "<YOUR_BEARER_TOKEN_HERE>",
},
"app-af469a92-5b45-4565-b3c4-b79878de67d2"
);
// Handle the result
console.log(result);
}
run();
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set appId
to "app-af469a92-5b45-4565-b3c4-b79878de67d2"
at SDK initialization and then you do not have to pass the same value on calls to operations like createRoomDeprecated
. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameter is available.
Name | Type | Required | Description |
---|---|---|---|
appId | string | The appId parameter. |
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.roomsV1.createRoomDeprecated(
{
roomConfig: '{"name":"my-room"}',
region: "Chicago",
},
"app-af469a92-5b45-4565-b3c4-b79878de67d2",
"2swovpy1fnunu"
);
// Handle the result
console.log(result);
}
run();
For supported JavaScript runtimes, please consult RUNTIMES.md.
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
[!TIP]
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
- Node.js v20+: Since v20, Node.js comes with a native
openAsBlob
function innode:fs
.- Bun: The native
Bun.file
function produces a file handle that can be used for streaming file uploads.- Browsers: All supported browsers return an instance to a
File
when reading the value from an<input type="file">
element.- Node.js v18: A file stream can be created using the
fileFrom
helper fromfetch-blob/from.js
.
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
import { openAsBlob } from "node:fs";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.buildsV1.runBuildDeprecated(
1,
{
file: await openAsBlob("./sample-file"),
},
"app-af469a92-5b45-4565-b3c4-b79878de67d2"
);
// Handle the result
console.log(result);
}
run();
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39",
{
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
}
);
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const hathoraCloud = new HathoraCloud({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
hathoraDevToken: "<YOUR_BEARER_TOKEN_HERE>",
appId: "app-af469a92-5b45-4565-b3c4-b79878de67d2",
});
async function run() {
const result = await hathoraCloud.tokensV1.getOrgTokens(
"org-6f706e83-0ec1-437a-9a46-7d4281eb2f39"
);
// Handle the result
console.log(result);
}
run();
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console
's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { HathoraCloud } from "@hathora/cloud-sdk-typescript";
const sdk = new HathoraCloud({ debugLogger: console });
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !