Generate a JSON Web Token (JWT)
Exchanges your Client ID and Client Secret for a signed JWT bearer token.
Send your credentials as a Base64-encoded clientId:clientSecret string in the Authorization header. Use the returned access_token as a Bearer token on all other endpoints in this API.
post
Response
application/json
Response
application/json
200: OK
OutputToken
A successful authentication response containing a JWT bearer token.
access_tokenstringrequired
The signed JWT to use as a Bearer token in subsequent authenticated requests.
Example:eyJhbGciOiJ example
expires_inintegerrequired
The number of seconds until the token expires. After expiry, request a new token.
Example:3599
token_typestringrequired
The token type. Always Bearer.
Example:Bearer
post/token/oauth
Authentication
application/json
Investment Details
Request investment details
post
Headers
Preferstringrequired
Must be set to respond-async to indicate the client requires that
the request is processed asynchronously. If omitted or set to another value, the server responds with an error message.
Allowed values:respond-async
Body
application/json
Body
application/json
RequestInvestmentDetails
Request 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
Response
application/json
Response
application/json
Accepted
ResponseAccepted
Defines the HTTP 202 Accepted response returned when a request is
accepted for asynchronous processing. Includes the job identifier,
metadata, and links to retrieve the job status or results.
jobIdstring
A unique identifier for the asynchronous job. This ID is used to
track processing progress or retrieve completed results.
Example:16bf1a7a-c883-4424-8810-2f4e9d244d40
_linksobject
A set of hypermedia links providing URLs for polling job status or
accessing results when available.
* Additional properties are NOT allowed.
Show Child Parameters
metadataobject
* Additional properties are NOT allowed.
Show Child Parameters
post/direct-web-services/v1/investments
Authentication
Headers
Body
{
"investments": [
{
"id": "id"
}
],
"views": [
{
"viewId": "viewId"
}
]
}
application/json
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