Skip to content

Thematic search

Instrument groups

The InvestSuite quant team composes and actively manages a list of themes (instrument groups) such as Healthcare, Clean & Green economy, Social trends each holding an applicable list of financial instruments. The aim of thematic search is to offer in the context of self execution, complementary to other search mechanisms, to your clients a means to filter the instrument universe to their personal preference and view. To retrieve themes and selected instruments within them perform a GET request against the instrument-groups endpoint.

Model

Thematic search is based on a simple CRUD model. The entity InstrumentGroups aggregates 0..* Instrument objects. An InstrumentGroup is the category e.g. Health Care and holds properties to describe the category: name, image, description. The Instrument object is a financial instrument, identified by an ISIN (external_id), and also holds properties to describe the instrument.

Instrument Groups Model

GET /thematic-search/instrument-groups/ 
    ?[limit=100]
    &[count=true]
    &[embed=instrument_ids] HTTP/1.1
Host: api.sandbox.investsuite.com
Authorization: Bearer {string}

{
    "next": null,
    "offset": null,
    "results": [
        {
            "external_id": "unique_external_entity_id",
            "readable_by": [
                "UXXXXXXXXXXXXXXXXXXXXXXXXXX"
            ],
            "modifiable_by": [
                "UXXXXXXXXXXXXXXXXXXXXXXXXXX"
            ],
            "id": "J01F3MQ2DPYXPS7JTHGXX4D09D3",
            "creation_datetime": "2021-04-19T00:00:00+00:00",
            "version": 1,
            "version_datetime": "2021-04-19T09:23:34.238210+00:00",
            "version_authored_by_user_id": "UXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "deleted": false,
            "_embedded": {},
            "name": {
                "en-US": "Cloud Computing"
            },
            "category": {
                "en-US": "Digital Disruption"
            },
            "image_uri": "urn:ietf:rfc:2648",
            "description": {
                "en-US": "Cloud Computing is the on-demand availability of computer system resources, especially data storage (cloud storage) and computing power."
            },
            "instrument_ids": [
                "I01F3MPZ53PNXBQVTKZNKJ88RA3"
            ]
        }
    ],
    "_embedded": {
        "I01F3MPZ53PNXBQVTKZNKJ88RA3": {
            "external_id": "US0378331005",
            "readable_by": [
                "UXXXXXXXXXXXXXXXXXXXXXXXXXX"
            ],
            "modifiable_by": [
                "UXXXXXXXXXXXXXXXXXXXXXXXXXX"
            ],
            "name": "Appel BV. Ordinary Shares",
            "display_name": "Appel BV",
            "tags": [],
            "type": "STOCK",
            "image_uri": null,
            "id": "I01F3MPZ53PNXBQVTKZNKJ88RA3",
            "creation_datetime": "2021-04-19T00:00:00+00:00",
            "version": 1,
            "version_datetime": "2021-04-19T09:21:47.127958+00:00",
            "version_authored_by_user_id": "UXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "deleted": false,
            "_embedded": {}
        }
    }
}

Embedding

You can add details about the Instrument objects to the InstrumentGroup objects collection by providing the ?embed={query} query string parameter. This parameter can be set to one or more field names that are available in the response object (and are references to other entities). The response will be extended with a populated _embedded key at the root level, which contains a full rendition of the referenced entities. Read detailed info about embedding here.

Collections

Collections are paginated lists of entities. To request a collection issue a GET request against the entity root path e.g. GET /users/, GET /portfolios/, GET /instrument-groups/. Collection endpoints accept alongside embed two additional query parameters for pagination: limit and offset. Limit (e.g. limit=50) allows you to pass in the number of items to be returned in the results array of the response. The default collection response size is 20 items. The maximum size is 100. Read detailed info about collections here.