GhJSON Specification

GhJSON is a JSON-based format for representing Grasshopper definitions. It provides a human-readable, portable way to serialize and deserialize Grasshopper documents.

GhPatch

GhJSON also defines a sibling GhPatch format for representing diffs and partial edits on GhJSON documents.

File Extensions

• GhJSON documents use the .ghjson extension.
• GhPatch documents (diffs and partial edits) use the .ghpatch extension.

Quick Links

• Format Specification
• GhPatch Specification
• JSON Schema v1.0
• GhPatch JSON Schema v1.0
• Examples
• GitHub Repository

Schema URLs

https://architects-toolkit.github.io/ghjson-spec/schema/v1.0/ghjson.schema.json
https://architects-toolkit.github.io/ghjson-spec/schema/v1.0/ghpatch.schema.json

Example

{
  "schema": "1.0",
  "components": [
    {
      "name": "Number Slider",
      "instanceGuid": "11111111-1111-1111-1111-111111111111",
      "id": 1,
      "pivot": "100,100",
      "componentState": {
        "extensions": {
          "gh.numberslider": {
            "value": "5<0~10>"
          }
        }
      }
    }
  ]
}