The Library script object

A Library script is an indicator, definition or study as the library describes it: who wrote it, whether you can reach it, and how to run it, never its source. Search the library returns its list form; Get a library script returns the full form.

Fields

The list form carries every field up to app_url, and interface only with include=interface. The full form always has interface and adds version and dependencies.

Field	Type	Description
`ref`	string	What to send as `script` to Create a run: the bare slug for your own, `chartnaut/slug` for a built-in, `author/slug` for someone else's. Always lowercase
`kind`	string	`indicator`, `definition` or `study`
`slug`	string	The script's slug
`name`	string	Display name
`description`	string	Plain text, or `""`. A formatted description from the app comes back as its text
`author`	string	The author's username in lowercase, or `chartnaut` for a built-in
`official`	boolean	`true` for Chartnaut's built-ins
`owned`	boolean	`true` when you wrote it
`installed`	boolean	`true` when it is someone else's script you added to your library. Always `false` for your own and for built-ins
`visibility`	string	`private`, `unlisted` or `public`. Built-ins are `public`
`latest_version`	integer	The newest saved version's number. `0` when the script has no saved version yet
`adoptions`	integer or null	How many people have added it to their library. `null` for studies
`tags`	array of string	Its tags, `[]` when it has none
`category`	string	Its category, or `""`
`created_at`	string	When the script was created
`updated_at`	string	When the script last changed
`app_url`	string	Opens the script in Chartnaut
`interface`	Interface	Settings, outputs, events or results, read from the version described. Left out of search results unless you ask for it
`version`	integer	Full form only. The version this response describes. `0` when the script has no saved version yet
`dependencies`	array of Dependency	Full form only. The scripts this version reads, `[]` when none

Example

{
  "ref": "jane/orb-breakout",
  "kind": "definition",
  "slug": "orb-breakout",
  "name": "Opening range breakout",
  "description": "Fires when BTC closes outside the first 30-minute range of the UTC day.",
  "author": "jane",
  "official": false,
  "owned": false,
  "installed": true,
  "visibility": "public",
  "latest_version": 7,
  "adoptions": 41,
  "tags": ["breakout", "opening-range"],
  "category": "breakout",
  "created_at": "2026-06-18T11:27:44.105392Z",
  "updated_at": "2026-09-14T07:52:19.663018Z",
  "app_url": "https://terminal.chartnaut.com/morpheus/research?flow_id=2291",
  "interface": {
    "settings": {
      "range_minutes": { "type": "number", "default": 30 }
    },
    "events": [
      { "id": "break_long", "intent": "signal", "payload_keys": ["range_high", "range_low"] },
      { "id": "break_short", "intent": "signal", "payload_keys": ["range_high", "range_low"] }
    ]
  },
  "version": 7,
  "dependencies": [
    { "ref": "atr", "as": "atr", "version": 3 }
  ]
}