Retrieve investment details
Retrieve asynchronous request results.
get
Path Parameters
resultIdstringrequired
Response
application/json
Response
application/json
OK
ResponseGetResults
Response get results.
investmentsarray
All fields are nullable. Empty or null value fields are not returned.
Show Child Parameters
metadataobject
* Additional properties are NOT allowed.
Show Child Parameters
get/direct-web-services/v1/investments/result/{resultId}
Authentication
Path Parameters
application/json
Utility Endpoints
List views
Retrieve the list of data views your account is entitled to access,
along with the corresponding viewId values required to request
investment details.
get
Response
application/json
Response
application/json
OK
ResponseListViews
Response 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
get/direct-web-services/v1/investments/views
Authentication
application/json
Retrieve a view definition
get
Path Parameters
viewIdstringrequired
Response
application/json
Response
application/json
OK
ResponseGetView
Response containing a view definition and the datapoints included in the
view.
* Additional properties are NOT allowed.
viewDefinitionobjectrequired
Definition of a view, including the datapoints it contains.
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
get/direct-web-services/v1/investments/views/{viewId}
Authentication
Path Parameters
application/json
RequestInvestmentDetails
objectRequest investment details for up to 3 views and 250 investments.
* Additional properties are NOT allowed.
investmentsarray[object]required
Investment to query. Investment look up is supported.
>= 1 items<= 250 items
* Additional properties are NOT allowed.
Show Child Parameters
viewsarray[object]required
List of views.
>= 1 items<= 3 items
Show Child Parameters
startDatestring(date)
Specifies the start date of a time series. Accepts yyyy-MM-dd.
Example:2020-01-25
endDatestring(date)
Specifies the start date of a time series. Accepts yyyy-MM-dd.
Example:2024-01-25
languageIdstring
Specifies the language to filter results on. Required for language-dependent data.
Allowed values:ENGSPAFRADEUITAJPNCHIZHOKOR
Default:ENG
countryIdstring
Specifies the country to filter results on. Accepts 3-character ISO 3166-1 country codes. Required for country-dependent data.
Default:USA
Example:CAN
regionIdstring
Specifies the region for style box breakpoints.
Allowed values:1234567
Example:1
Example