Universe API
Retrieve investment identifiers in your entitled universe.
API Inputs
Request Inputs
These inputs apply to the GET /direct-web-services/v1/investments request: the Authorization header, and the query parameters that choose the investment type, the filters and the page.
Authorization
| Attribute | Value |
|---|---|
| Type | Header |
| Data Type | string |
| Possible Values | Bearer {token}, where the token is a JSON Web Token |
| Example | Bearer eyJhbGciOi... |
Specifies the token that authorizes the request. Required. For more information about getting a token, see the Authentication page.
countryAvailableForSaleCode
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | 3-character ISO 3166-1 country codes |
| Example | USA |
Primary filter for managed investments. Filters results by country available for sale. Use either this or domicileCode, not both.
domicileCode
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | 3-character ISO 3166-1 country codes |
| Example | USA |
Primary filter for managed investments. Filters results by domicile. Use either this or countryAvailableForSaleCode, not both.
exchange
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | An exchange ID. See Filter Values |
| Example | EX$$$$AMXO |
Secondary filter for managed investments. Filters results by exchange.
exchangeCode
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | An exchange code from your entitlements |
| Example | XPAR |
Primary filter for equities. Filters results by exchange code.
fundLegalStructureName
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | See Filter Values |
| Example | 40 |
Secondary filter for managed investments. Filters results by fund legal structure.
investmentType
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | See Filter Values |
| Example | BD |
Secondary filter for managed investments. Filters results by investment type.
pageSize
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | integer |
| Possible Values | 1 to 50. Default: 50 |
| Example | 25 |
Specifies the number of records per page.
paginationTokenNext
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | The paginationTokenNext value from the previous response |
| Example | CJjVEBoTOhE... |
Specifies the token used to retrieve the next page of results. Use the same filters as the request that returned the token.
paginationTokenPrevious
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | The paginationTokenPrevious value from the previous response |
| Example | CLf5DxoROg9... |
Specifies the token used to retrieve the previous page of results.
securityType
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | See Filter Values |
| Example | ST00000001 |
Secondary filter for equities. Filters results by security type.
shareClassInformationInvestmentType
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | EQ, DR, PE, UE |
| Example | EQ |
Secondary filter for equities. Filters results by investment type.
source
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | equities, managedInvestments. Default: equities |
| Example | managedInvestments |
Specifies the investment type to query.
universe
| Attribute | Value |
|---|---|
| Type | Query Parameter |
| Data Type | string |
| Possible Values | The name of a custom universe set up for your account |
| Example | MY_EQUITIES_ABC |
Filters results to a custom universe. A custom universe can be retrieved in full, or narrowed with filters.