Interface GetAssetsByNameArgs

The argument object for AssetApi.getAssetsByName

interface GetAssetsByNameArgs {
    firstIndex?: number;
    heightEnd?: number;
    heightStart?: number;
    lastIndex?: number;
    name: string;
    skipZeroVolume?: boolean;
}

Hierarchy

  • GetAllAssetsArgs
    • GetAssetsByNameArgs

Properties

firstIndex? heightEnd? heightStart? lastIndex? name skipZeroVolume?

Properties

OptionalfirstIndex

firstIndex?: number

The first index to be returned. Use this for pagination. Starts at 0

OptionalheightEnd

heightEnd?: number

Define the end height for trading information over a given period - if not given the current block is taken as end height

OptionalheightStart

heightStart?: number

Define the start height for trading information over a given period - if not given the last 360 blocks (around 24hrs) are taken as trading period

OptionallastIndex

lastIndex?: number

The last index to be returned. Use this for pagination. If not set, at maximum 500 items beginning at firstIndex will be returned

name

name: string

OptionalskipZeroVolume

skipZeroVolume?: boolean

If set true all zero volumes are excluded

Settings

Member Visibility

On This Page

Properties