Skip to main content

​
Description

Returns metadata about the current Roblox place, including place ID, game ID, version, creator information, and place name.

​
HTTP Endpoint

POST /tool/get_place_info

​
Request Parameters

No parameters required.

​
Response Format

​
placeId
number
The unique place ID
​
gameId
number
The game (universe) ID this place belongs to
​
placeName
string
The name of the place
​
placeVersion
number
The current version number of the place
​
creatorId
number
The user ID or group ID of the creator
​
creatorType
string
Either “User” or “Group”

​
Example

const response = await fetch('http://127.0.0.1:7766/tool/get_place_info', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({})
});

const data = await response.json();
console.log(data.result);

// Example output:
// {
//   "placeId": 123456789,
//   "gameId": 987654321,
//   "placeName": "My Awesome Game",
//   "placeVersion": 142,
//   "creatorId": 555666,
//   "creatorType": "User"
// }

​
Implementation Details

From InstanceTools.lua:52-61:
  • Reads properties directly from the game object
  • Converts CreatorType enum to string
  • Always succeeds (no error cases)

Build docs developers (and LLMs) love

Get started for freeTalk to us