GoCharting

https://gocharting.com/docs
Admin
GoCharting is an advanced charting and trading platform offering 15+ chart types, orderflow...
Tokens:384,946
Snippets:3,878
Trust Score:9.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### str.startswith usage example

Source: https://gocharting.com/docs/scripting/reference/functions/str/startswith

Example indicator that plots a shape when the ticker symbol starts with 'BTC'. Uses syminfo.ticker as the source and 'BTC' as the prefix.

```pine
indicator("Ticker starts with BTC")
plotshape(str.startswith(syminfo.ticker, "BTC"), title = "Starts with BTC")
```

--------------------------------

### input.time usage example

Source: https://gocharting.com/docs/scripting/reference/functions/input/time

Example script that uses input.time to create a time input and plots a shape when the current time is after the chosen start time.

```pine
indicator("After a chosen time")
plotshape(time >= input.time(0, "Start time"), title = "After the start time")
```

--------------------------------

### Example: Plot close at session start using talib.valuewhen

Source: https://gocharting.com/docs/scripting/reference/functions/talib/valuewhen

Example usage that plots the close value from the first bar of the session using talib.valuewhen with session.isfirst as the condition and occurrence 1.

```pine
indicator("Close at the start of the session")
plot(talib.valuewhen(session.isfirst, close, 1))
```

--------------------------------

### Example: using input.source in an indicator

Source: https://gocharting.com/docs/scripting/reference/functions/input/source

Example usage of input.source in an indicator, plotting the selected series. The source starts on the close series.

```pine
indicator("Source input")
plot(input.source(close, "Source"))
```

--------------------------------

### bgcolor usage example

Source: https://gocharting.com/docs/scripting/reference/functions/global/bgcolor

Example script that shades the background with a semi-transparent blue color.

```pine
indicator("Shade the background")
plot(close)
bgcolor(color.new(color.blue, 0.1), title = "Background")
```

--------------------------------

### alert usage example

Source: https://gocharting.com/docs/scripting/automation/alerts

Example of using `alert` inside an `if` block to raise an alert when a new session starts. `alert` can be called inside a branch and fires only on realtime bars in alert mode.

```pinescript
indicator("Session open alert")
if session.isfirst {
    alert("A new session has started")
}
plot(close)
```

--------------------------------

### talib.crossover usage example

Source: https://gocharting.com/docs/scripting/reference/functions/talib/crossover

Example showing how to use talib.crossover to plot a shape when close crosses above open.

```pine
indicator("Close crosses above the open")
plotshape(talib.crossover(close, open), title = "Cross up")
```

--------------------------------

### Example: Cumulative volume indicator

Source: https://gocharting.com/docs/scripting/reference/functions/talib/cum

Example script that plots the cumulative volume using talib.cum(volume).

```pine
indicator("Cumulative volume")
plot(talib.cum(volume))
```

--------------------------------

### Example usage of talib.macd

Source: https://gocharting.com/docs/scripting/reference/functions/talib/macd

Example script that calculates the MACD indicator and plots the line, signal, and histogram.

```pine
indicator("MACD")
[line, signal, histogram] = talib.macd(close, 12, 26, 9)
plot(line, title = "Line")
plot(signal, title = "Signal")
plot(histogram, title = "Histogram")
```

--------------------------------

### input.float usage example

Source: https://gocharting.com/docs/scripting/reference/functions/input/float

Creates a bounded level input with a default of 100.0, a minimum of 0.0, a maximum of 100000.0, and a step of 0.5, and plots it.

```pine
indicator("Bounded level")
plot(input.float(100.0, "Level", 0.0, 100000.0, 0.5))
```

--------------------------------

### Group and inline inputs with named group and inline arguments

Source: https://gocharting.com/docs/scripting/how-to/group-and-lay-out-your-inputs

Shows how to group and inline inputs by passing `group` and `inline` arguments. Demonstrates that `input.int` requires positional arguments up to `step` because `step` cannot be named. Also shows `input.color` and `input.source` with named group and inline arguments.

```pine
indicator("Grouped inputs", "grp", true)

src = input.source(close, "Source", inline = "calc", group = "Calculation")
length = input.int(20, "Length", 1, 200, 1, "Bars in the average", "calc", "Calculation")

up = input.color(color.green, "Rising", group = "Appearance")
down = input.color(color.red, "Falling", group = "Appearance")

float average = talib.sma(src, length)

plot(average, title = "Average", color = close > close[1] ? up : down)
```

--------------------------------

### str.startswith

Source: https://gocharting.com/docs/scripting/reference/functions/str/startswith

Checks if the source string starts with the specified prefix. Both arguments are required. Returns a boolean value indicating the result.

```APIDOC
## str.startswith

### Description
Checks if the source string starts with the specified prefix. Both arguments are required. Returns a boolean value indicating the result.

### Function Signature
```
str.startswith(const string source, const string prefix) → const bool
str.startswith(input string source, input string prefix) → input bool
str.startswith(series string source, series string prefix) → series bool
str.startswith(simple string source, simple string prefix) → simple bool
```

### Parameters
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source` | `const string` | yes | the string being examined |
| `prefix` | `const string` | yes | the opening to test for |

### Returns
`const bool` or `input bool` or `series bool` or `simple bool` — A bool in the form of the arguments you pass.

### Example
```
indicator("Ticker starts with BTC")
plotshape(str.startswith(syminfo.ticker, "BTC"), title = "Starts with BTC")
```

### See Also
`str.contains` · `str.endswith` · `str.format_time`
```

--------------------------------

### Get hour in the instrument's timezone with `hour()`

Source: https://gocharting.com/docs/scripting/how-to/plot-only-during-part-of-the-session

Shows the signature of the `hour()` function, which takes a time and a timezone, and an example call using `syminfo.timezone` to get the hour in the instrument's own timezone.

```pinescript
hour(series int time, series string timezone) → series int
```

```pinescript
hour(time, syminfo.timezone)
```

--------------------------------

### Create a source input and plot it

Source: https://gocharting.com/docs/scripting/configuration/inputs

Creates a source input that starts at the close price, labeled "Source", and plots the reader's chosen series.

```pine
indicator("Source input")
src = input.source(close, "Source")
plot(src)
```

--------------------------------

### str.substring(const string source, const int start) → const string

Source: https://gocharting.com/docs/scripting/reference/functions/str/substring

Returns a substring of the source string starting at the given start position to the end of the string.

```APIDOC
## str.substring(const string source, const int start) → const string

### Description
Cuts a piece out of a string, starting at the given start position and running to the end of the string.

### Method
Function

### Endpoint
str.substring

### Parameters
#### Parameters
- **source** (`const string`) - Required - the string to cut from
- **start** (`const int`) - Required - the position the returned piece starts at

### Returns
`const string` — The selected text. Positions are counted from zero, and they count characters.

### Example
```
indicator("A piece of a string")
alert(str.substring("breakout", 1))
plot(close)
```
```

--------------------------------

### str.substring(simple string source, simple int start) → simple string

Source: https://gocharting.com/docs/scripting/reference/functions/str/substring

Returns a substring of the simple source string starting at the given start position to the end of the string.

```APIDOC
## str.substring(simple string source, simple int start) → simple string

### Description
Cuts a piece out of a simple string, starting at the given start position and running to the end of the string.

### Method
Function

### Endpoint
str.substring

### Parameters
#### Parameters
- **source** (`simple string`) - Required - the string to cut from
- **start** (`simple int`) - Required - the position the returned piece starts at

### Returns
`simple string` — The selected text. Positions are counted from zero, and they count characters.

### Example
```
indicator("A piece of a string")
alert(str.substring("breakout", 1))
plot(close)
```
```

--------------------------------

### Example: barcolor and bgcolor usage

Source: https://gocharting.com/docs/scripting/chart-output/bars-and-background

Example script that plots close, colours bars orange, and shades the background with translucent blue. Both functions are called at the top level.

```pine
indicator("Bar and background colour")
plot(close, title = "Close")
barcolor(color.orange, title = "Bars")
bgcolor(color.new(color.blue, 0.1), title = "Background")
```

--------------------------------

### str.substring(series string source, series int start) → series string

Source: https://gocharting.com/docs/scripting/reference/functions/str/substring

Returns a substring of the series source string starting at the given start position to the end of the string.

```APIDOC
## str.substring(series string source, series int start) → series string

### Description
Cuts a piece out of a series string, starting at the given start position and running to the end of the string.

### Method
Function

### Endpoint
str.substring

### Parameters
#### Parameters
- **source** (`series string`) - Required - the string to cut from
- **start** (`series int`) - Required - the position the returned piece starts at

### Returns
`series string` — The selected text. Positions are counted from zero, and they count characters.

### Example
```
indicator("A piece of a string")
alert(str.substring("breakout", 1))
plot(close)
```
```

--------------------------------

### str.substring(input string source, input int start) → input string

Source: https://gocharting.com/docs/scripting/reference/functions/str/substring

Returns a substring of the input source string starting at the given start position to the end of the string.

```APIDOC
## str.substring(input string source, input int start) → input string

### Description
Cuts a piece out of an input string, starting at the given start position and running to the end of the string.

### Method
Function

### Endpoint
str.substring

### Parameters
#### Parameters
- **source** (`input string`) - Required - the string to cut from
- **start** (`input int`) - Required - the position the returned piece starts at

### Returns
`input string` — The selected text. Positions are counted from zero, and they count characters.

### Example
```
indicator("A piece of a string")
alert(str.substring("breakout", 1))
plot(close)
```
```

--------------------------------

### input.price usage example

Source: https://gocharting.com/docs/scripting/reference/functions/input/price

Example of using input.price to create a price input with a default value of 100.0 and a title 'Price'.

```pine
indicator("Price input")
plot(input.price(100.0, "Price"))
```

--------------------------------

### Minimal script to start from when debugging compilation

Source: https://gocharting.com/docs/scripting/reference/faq

A minimal script that compiles, useful as a starting point when debugging a script that fails to compile. The FAQ suggests adding to it piece by piece.

```gocharting
indicator("Close")
plot(close)
```

--------------------------------

### Example: Plot talib.vwma(close, 20)

Source: https://gocharting.com/docs/scripting/reference/functions/talib/vwma

Example usage of talib.vwma in a Pine Script indicator. It plots the volume-weighted moving average of close over 20 bars. This example is from the documentation page for talib.vwma.

```pine
indicator("Volume-weighted moving average")
plot(talib.vwma(close, 20))
```

--------------------------------

### Example: Plot pivot lows

Source: https://gocharting.com/docs/scripting/reference/functions/talib/pivotlow

A minimal example that plots the pivot low values using the talib.pivotlow function with a window of 5 bars on each side.

```pine
indicator("Pivot lows")
plot(talib.pivotlow(low, 5, 5))
```

--------------------------------

### input.int() usage example

Source: https://gocharting.com/docs/scripting/reference/functions/input/int

Example of using input.int() to create a length input for a moving average.

```pine
indicator("Length input")
plot(talib.sma(close, input.int(20, "Length")))
```

--------------------------------

### Shade background by condition with bgcolor

Source: https://gocharting.com/docs/scripting/how-to/colour-bars-by-a-condition

Example that shades the background red with 0.1 opacity when close is below open, and uses 0.0 opacity otherwise. Set the opacity with color.new for a background; a low value shades, 1 is solid.

```pine
indicator("Shaded down bars", "shade", true)
bgcolor(close < open ? color.new(color.red, 0.1) : color.new(color.red, 0.0), title = "Down bars")
```

--------------------------------

### str.substring(const string source, const int start, const int end) → const string

Source: https://gocharting.com/docs/scripting/reference/functions/str/substring

Returns a substring of the source string starting at the given start position and ending at the given end position.

```APIDOC
## str.substring(const string source, const int start, const int end) → const string

### Description
Cuts a piece out of a string, starting at the given start position and running to the given end position.

### Method
Function

### Endpoint
str.substring

### Parameters
#### Parameters
- **source** (`const string`) - Required - the string to cut from
- **start** (`const int`) - Required - the position the returned piece starts at
- **end** (`const int`) - Required - the position the returned piece runs to

### Returns
`const string` — The selected text. Positions are counted from zero, and they count characters.

### Example
```
indicator("A piece of a string")
alert(str.substring("breakout", 1, 4))
plot(close)
```
```

--------------------------------

### Example: extract first run of digits from ticker with str.match

Source: https://gocharting.com/docs/scripting/reference/functions/str/match

This example creates an indicator named 'First run of digits' and uses str.match(syminfo.ticker, "[0-9]+") to find the first sequence of digits in the ticker symbol. The result is passed to alert() and the close price is plotted. If the pattern does not compile, str.match returns empty text.

```pine
indicator("First run of digits")
alert(str.match(syminfo.ticker, "[0-9]+"))
plot(close)
```

--------------------------------

### Usage example: plot(minute(time, syminfo.timezone))

Source: https://gocharting.com/docs/scripting/reference/functions/global/minute

Example of using the `minute` function within an indicator to plot the minute of the bar.

```pine
indicator("Bar minute")
plot(minute(time, syminfo.timezone))
```

--------------------------------

### Example usage of talib.crossunder

Source: https://gocharting.com/docs/scripting/reference/functions/talib/crossunder

Example Pine Script indicator that plots a shape when the close crosses below the open.

```pine
indicator("Close crosses below the open")
plotshape(talib.crossunder(close, open), title = "Cross down")
```

--------------------------------

### Example: Plot the sum of high, low, and close

Source: https://gocharting.com/docs/scripting/reference/functions/math/sum

This example creates an indicator that plots the sum of the high, low, and close prices using math.sum. It demonstrates the series float form of the function.

```pine
indicator("High plus low plus close")
plot(math.sum(high, low, close))
```

--------------------------------

### Example: plot color.a(color.blue)

Source: https://gocharting.com/docs/scripting/reference/functions/color/a

Example indicator that plots the opacity of the colour blue using color.a().

```pine
indicator("Opacity of a colour")
plot(color.a(color.blue))
```
Tokens:
Raw