Snaptrude Documentation

Appearance

Overview ​

Welcome to the Snaptrude Public API and Data Format documentation. This resource is designed to help developers understand the internal data structures and API capabilities of the Snaptrude platform.

Documentation Structure ​

The documentation is organized into two main sections:

1. Structure Collection ​

This section details the JSON schema used for the Snaptrude structure collection. It explains how building data is serialized and organized.

  • Structures: Deep dive into building definitions.
    • Storeys: Information on storeys, layers, sketches, and floorplans.
    • Level: Details on data partitions containing architectural elements like walls, masses, and more.
  • Materials & Rendering: Specifications for materials, lights, and cameras.
  • Metadata & Settings: Project metadata, user settings, and versioning info.

2. API Reference ​

This section provides technical documentation for the Snaptrude Public API (snaptrude), organized by namespace.

  • Entity: Find and access BIM entities.
  • Tools: Tools to modify and interact with the model.
  • Project: Project level methods.
  • Query: Data extraction.
  • Core: Core data structures.

Use the links above to navigate through the different sections.