Skip to main content

​
Description

Returns property values for a specific instance. This tool attempts to read a set of common properties that exist across many Roblox classes. Only properties that exist and are readable on the instance will be returned.

​
HTTP Endpoint

POST /tool/get_instance_properties

​
Request Parameters

​
path
string
required
Path to the instance. Examples: "Workspace.Part", "ReplicatedStorage.Config"

​
Response Format

​
path
string
The resolved path to the instance
​
className
string
The class name of the instance
​
properties
object
Dictionary of property names to serialized values. Common properties checked include:
  • Basic: Name, Parent, ClassName, Archivable
  • Spatial: Position, Size, CFrame, Rotation
  • Visual: Color, BrickColor, Material, Transparency
  • Physical: Anchored, CanCollide
  • UI: BackgroundColor3, TextColor3, Text, Font, TextSize, Visible, ZIndex, BorderSizePixel
  • Scripts: Source, Disabled, RunContext
Only properties that exist on the instance will be included.
​
error
string
Error message if path resolution failed

​
Example

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

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

// Example output:
// {
//   "path": "Workspace.Baseplate",
//   "className": "Part",
//   "properties": {
//     "Name": "Baseplate",
//     "ClassName": "Part",
//     "Position": { "x": 0, "y": -10, "z": 0 },
//     "Size": { "x": 512, "y": 20, "z": 512 },
//     "Material": "Plastic",
//     "BrickColor": "Medium stone grey",
//     "Transparency": 0,
//     "Anchored": true,
//     "CanCollide": true
//   }
// }

​
Implementation Details

From InstanceTools.lua:170-192:
  • Uses PathResolver.resolve() to find the instance
  • Attempts to read common properties using pcall
  • Only includes properties that successfully read
  • Uses ValueSerializer.toJSON() to convert Roblox types to JSON-friendly format

Build docs developers (and LLMs) love

Get started for freeTalk to us