leg.*

Will declare a leg on a contract named outright, by the symbol your host knows it by, with its exchange, product, default quantity and default side. Use it when the contract is known in advance and does not roll over to a new expiry, such as one particular future or a stock.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.fixed(
    name: string,
    symbol: string,
    exchange?: string = chart.exchange,
    product?: string,
    qty?: number,
    side?: string = "buy"
) -> nothing

Returns

nothing

First value

bar 0

Will declare a leg on a contract described relative to an underlying, such as "the nearest NIFTY weekly expiry, two strikes above the money, the call", which the host turns into one real contract before the first bar. A description the host cannot resolve is OS6007, and the strategy does not start.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.relative(
    name: string,
    underlying: string,
    kind: string,
    expiryRank?: number = 0,
    expiryCycle?: string = none,
    strikeOffset?: number = 0,
    right?: string = none,
    reference?: number = none,
    exchange?: string = chart.exchange,
    product?: string,
    qty?: number,
    side?: string = "buy"
) -> nothing

Returns

nothing

First value

bar 0

Remarks. The fields of a description:

name, exchange, product, qty and side are the leg's own bookkeeping, not part of the description. Giving right or strikeOffset with kind = "future" is OS3010.

A relative contract resolves once. Say a leg describes "nearest expiry, at the money, call" and enters on a quiet morning at one strike. If the description were evaluated again at the exit, after the index has moved a hundred points, "at the money" would name a different strike, and the strategy would send a closing order for a contract it never held while the one it does hold stays open. So the description is resolved once, before the first bar, and every order for the rest of the run carries that one contract. leg.symbol() reads it back.

Will return the contract the leg resolved to, as the symbol its orders carried. It is the name to reconcile against a broker statement.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.symbol(name: string) -> string

Returns

string

First value

bar 0

Will return the exchange the leg's orders were sent to.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.exchange(name: string) -> string

Returns

string

First value

bar 0

Will return the product the leg's orders were actually sent with, after any translation the destination applies, which is what a statement can be matched against.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.product(name: string) -> string

Returns

string

First value

bar 0

Will return the resolved contract's expiry, and absent for a contract with no expiry, such as a stock.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.expiry(name: string) -> number

Returns

number

First value

bar 0

Will return the resolved option's strike, and absent for a contract with none.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.strike(name: string) -> number

Returns

number

First value

bar 0

Will return the signed number of units this strategy holds in the leg: positive long, negative short, 0 when flat.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.size(name: string) -> series number

Returns

series number

First value

bar 0, 0 when flat

Will return the average price of the leg's open position, and absent while the leg is flat, for the same reason pos.avgPrice is.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.avgPrice(name: string) -> series number

Returns

series number

First value

absent while the leg is flat

Will return the time the leg's current position was opened, and absent while the leg is flat.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.entryTime(name: string) -> series number

Returns

series number

First value

absent while the leg is flat

Will return the leg's open profit in money, valued at this bar's close, and 0 while the leg is flat.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.profit(name: string) -> series number

Returns

series number

First value

bar 0, 0 when flat

Will be true while the leg holds a position. It is the per-leg entry guard, in place of pos.isFlat.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.isOpen(name: string) -> series bool

Returns

series bool

First value

bar 0

Will send one order that enters one leg on its own signal, on the leg's declared side and quantity unless you give others, as a market, limit or stop order by the same rules as buy(). An entry that the book's direction filter or entry window refuses is recorded rather than sent.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.enter(
    name: string,
    side?: string,
    qty?: number,
    limit?: number = none,
    stop?: number = none,
    tag?: string = ""
) -> nothing

Returns

nothing

First value

bar 0

Will send one order that exits one leg, all of it or qty of it, at the market or resting at limit or stop.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.exit(
    name: string,
    qty?: number = none,
    limit?: number = none,
    stop?: number = none,
    tag?: string = ""
) -> nothing

Returns

nothing

First value

bar 0

Will set a standing stop that closes the leg when its price reaches price against the position, replacing any stop in force.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.stop(name: string, price: number) -> nothing

Returns

nothing

First value

bar 0

Will set a standing target that closes the leg when its price reaches price in favour of the position, replacing any target in force.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.target(name: string, price: number) -> nothing

Returns

nothing

First value

bar 0

Will set a trailing stop that follows the best price the leg has seen, distance behind it, and only ever moves in the leg's favour. It is the language's one trailing stop: there is no trail argument on exit() or order.bracket().

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.trail(name: string, distance: number, activateAt?: number = none) -> nothing

Returns

nothing

First value

bar 0

Remarks. How the trail will behave, exactly:

• distance is in the leg's own price units and is positive.
• The trail activates when the leg's profit per unit first reaches activateAt: the last price minus the average entry price for a long leg, the reverse for a short. With activateAt left out it activates on the leg's first fill.
• Once active it keeps the best price since activation: the highest for a long leg and the lowest for a short, from the bar's high or low on a confirmed bar, and from the last price on a bar still forming.
• Its level is the best price minus distance for a long leg, plus distance for a short. It never moves back.
• Where a leg has both a stop and an active trail, the more protective of the two is in force: the higher for a long, the lower for a short.

Until it lands, a trail is a few lines of var; Trailing stops has one.

Will return the stop level actually in force on the leg, whichever call set it, and absent when there is none. While a trail is active and tighter than the stop, it returns the trail's level, so plot this rather than your own variable to see what is really protecting the position.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.stopPrice(name: string) -> series number

Returns

series number

First value

absent when no stop is in force

Will return the target level actually in force on the leg, and absent when there is none.

Named in the language and not available in version 0.5.0. Calling it is error OS2020.

leg.targetPrice(name: string) -> series number

Returns

series number

First value

absent when no target is in force