Region selection

Automatic region selection

By default, actors will choose the optimal region based on the client’s location.

Under the hood, Rivet uses Anycast routing to automatically find the best location for the client to connect to without relying on slow & expensive manual pinging process.

Manual region selection

The region a actor is created in can be overridden using region options:

client.ts
import { createClient } from "rivetkit/client";
import type { App } from "./src/index";

const client = createClient<App>("http://localhost:8080");

// Create actor in a specific region
const actor = await client.example.get({
  options: {
    create: {
      region: "atl"
    }
  }
});

See Create & Manage Actors for more information.

Available regions

See available regions here.

Fetching region list

It’s common to need to display a list of available regions in your application.

When deployed to Rivet, you can fetch a full list of regions with the GET https://api.rivet.gg/regions HTTP endpoint. See API documentation here.

We don’t recommend hard-coding the region list. This allows you to develop your application with a local development cluster.