ChartnautDocs

Search the library

GET/library

Searches every script you can use: your own, Chartnaut's built-ins, other people's public scripts and the ones you added to your library. Call it to find a script's ref before you run it.

Scope

Heavy call

Long poll

CLI

scripts:read

No

No

chartnaut library search

Guidance

  • scope picks whose scripts come back. library is what your library in the app shows. all, the default, adds the community on top.

scope

Returns

mine

Your own scripts, whatever their visibility

published

Your own public scripts

chartnaut

Chartnaut's built-ins

community

Other people's public scripts

installed

Other people's public or unlisted scripts you added to your library

library

mine, chartnaut and installed together

all

library and community together

  • Each item's ref goes straight into script on Create a run: my-ema for yours, chartnaut/rsi for a built-in, jane/orb-breakout for someone else's. Add @N to pin a version.

  • Studies are never shared. Only your own and Chartnaut's studies come back, whatever the scope, and adoptions is null on them.

  • Source never comes back, from this call or from Get a library script, whatever the script's author allows in the app. Read your own source with Get a script.

  • Every word of q must appear, in any letter case, in the script's name, slug, description, tags, category or author. Built-ins match chartnaut as their author. Only the first eight words filter.

  • With q, the default order is relevance: an exact slug or name first, then names and slugs that start with q, then ones that contain it, then the rest, each group by adoptions and then most recently updated. Without q it is updated.

  • author narrows to one person: a username, chartnaut for built-ins, or me. It works inside scope, so scope=community&author=me is always empty. An author with nothing you can see returns an empty page.

  • include=interface adds each script's Interface at its latest version, so you can see its settings and outputs without a second call.

  • Page with limit and cursor as on every list. Archived and deleted scripts never appear, and neither do other people's scripts whose owner has no username, since they have no ref to run by.

Query parameters

Name

Type

Required

Default

Description

q

string

No

None

Search words, at most 200 characters

kind

string

No

All kinds

indicator, definition or study

scope

string

No

all

all, library, mine, published, chartnaut, community or installed

author

string

No

Anyone

A username, chartnaut or me

sort

string

No

relevance with q, else updated

relevance, updated (newest change first), created (newest first), adoptions (most first) or name (A to Z)

include

string

No

None

interface adds interface to each item

limit

integer

No

50

Most 200

cursor

string

No

None

From the previous page's next_cursor

Response

200 with a page whose data is an array of Library script in its list form.

Status codes

Status

Code

Meaning

200

-

A page of scripts

400

invalid_request

scope, kind or sort is not one of its values, or q is longer than 200 characters

500

internal

The library could not be read. Retry