Unit Locations

Update unit locations for the live map.

Rate Limits

• Maximum of one request every 250ms
• Maximum of 25 unit update objects per request

Use this websocket method for high-frequency live map streaming when possible. The HTTP v2 alternative is PATCH /v2/emergency/servers/{serverId}/unit-locations, but that route is limited to 12 requests per minute.

Websocket API

Authentication Method

Method:

unitLocation

Parameters:

Parameter	Type
data	Array of unitLocationObject

Structure unitLocationObject

  {
    communityUserId: "player-1234", // Optional alternative to apiId or identId
    roblox: 123456789, // Optional alternative to communityUserId, apiId, or identId
    apiId: "SOME_API_ID", // Optional
    identId: 42, // Optional
    location: "US-101 / Exit 15",
    coordinates: { x: 123.45, y: 678.9, z: 21.0, w: 180.0 },
    peerId: "bodycam-1-123", // Used only for P2P bodycam streams
    vehicle: {
      model: 'https://example.com/model.obj', // S3 URL to a 3D map object
      zOffset: 0, // Offset model Z (height) on map
      lightZOffset: 0, // Offset light effect Z (height) on map
      sizeOffset: 0, // Increase/Decrease Size
      headingOffset: 0, // Offset heading direction for 3D model
      lights: false // Show emergency lights flashing on model
    }
  }

Each update must include location plus one target identifier: communityUserId, roblox, apiId, or identId. Authenticate the SignalR connection first with authenticatev2.

Response

Success

{ success: boolean, error: string, count: number }

Error

- Unauthenticated: "Unauthenticated. Call authenticate first."
- Missing/empty array: "Missing unit location updates."
- Batch too large: "Too many unit updates in one call. Max is 25."
- Too fast: "UNIT_LOCATION updates are limited to every 200ms."
- Invalid target: "Each unit update requires identId, apiId, communityUserId, or roblox, and location."

Unit Location JS example (Node.js):

setInterval(async () => {
  const updates = [
    {
      communityUserId: "player-1234",
      location: "Interstate 4 / Mile 228",
      position: { x: 8.5, y: 2.1, z: 0.0, w: 90.0 },
    },
  ];

  try {
    await connection.invoke("unitLocation", updates);
  } catch (err) {
    console.error("send failed:", err.message);
  }
}, 250);