volume

volume ( String priceType);

Default values:

priceType: "<current type>"

Description

Returns the volume value for the specific symbol, aggregation period and price type. You can use both Aggregation Period constants and pre-defined string values (e.g. Day, 2 Days, Week, Month, etc.) as valid parameters for the aggregation period. The full list of the pre-defined string values can be found in the Referencing Secondary Aggregation article.

Valid parameters for the price type are: LAST, ASK, BID, and MARK. Alternatively, you can use the PriceType constants.

Note that for non-Forex symbols, the last three are only supported on intraday charts with time interval not greater than 15 days.

Input parameters

Parameter Default value Description
symbol current symbol Defines symbol for which the volume is returned.
period current aggregation Defines aggregation period for which the volume is returned.
priceType current price type Defines the type of price for which the volume is returned: Last, Ask, Bid, or Mark.

Example

declare lower;

input divider = 1000000;
plot VolumeDivided = volume / divider;
VolumeDivided.SetPaintingStrategy(PaintingStrategy.HISTOGRAM);

This example script plots the histogram of volume value divided by a specified number. By default, the divider is equal to 1000000.