ResponseListViews
objectResponse containing entitled view packages and their associated dataset viewIds.
* Additional properties are NOT allowed.
viewsarray[object]required
A view package and the dataset viewIds it contains.
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example
InputInvestment
objectInvestment to query. Investment look up is supported.
* Additional properties are NOT allowed.
idstringrequired
Specifies the investment identifier to query. Accepts performance
IDs, ISINs, security IDs, CUSIPs, trading symbols, and Morningstar
IDs.
idTypestring
Allowed values:performanceIdisinfundCodesecurityIdcusipmsidtradingSymbolindustryCode
Default:performanceId
Example:performanceId
exchangeCountrystring
Specifies exchange country used to look up investment. Accepts
3-character ISO 3166-1 country codes.
>= 3 characters<= 3 characters
Example:USA
domicilestring
Specifies domicile used to look up investment. Accepts 3-character
ISO 3166-1 country codes.
>= 3 characters<= 3 characters
Example:USA
baseCurrencystring
Specifies base currency used to look up investment. Accepts
3-character ISO 4217 currency codes.
Example:USD
exchangeIdstring
Specifies exchange identifier used to look up investment. See the data dictionary for full list of accepted values.
Example:EX$$$$XNAS
Example
InputView
objectviewIdstringrequired
The view identifier. Standard view ids are package names; a view defined for your organisation uses the identifier issued to you.
viewTypestring
Allowed values:packageDDADataset
Default:package
Example
OutputViewDataset
objectIdentifies a dataset viewId associated with a package.
* Additional properties are NOT allowed.
viewIdstringrequired
Identifier of an entitled view or dataset. Use this value as viewId in investment detail requests.
>= 1 characters
Example:equity-short-interest
Example
OutputViewDefinition
objectDefinition of a view, including the datapoints it contains.
* Additional properties are NOT allowed.
idstringrequired
Identifier of an entitled view or dataset. Use this value as viewId in investment detail requests.
>= 1 characters
Example:equity-short-interest
dataPointsarray[object]required
Datapoint included in the view and its dependency flags
* Additional properties are NOT allowed.
Show Child Parameters
Example