Alerts API: Universes

Universe Management Data Dictionary

The TextReveal® Alerts API exposes an endpoint named v2/clients-universe that gives the possibility to retrieve universe IDs.


GET /v2/clients-universe

Endpoint Details

Endpoint: v2/clients-universe

Method: GET

Description: Access Universe ID and Name

Parameters

size

  • Description: Number of rows to retrieve.
  • Defaults: 10

page

  • Description: Page if the number of total rows exceeds size parameter.
  • Defaults: 0

filter

  • Description: Select a filter to apply during article search. All filters provided are used with an 'AND' condition.
  • Supported fields: name, permanent_id, universe_id, is_active, updated_at
  • Supported operators: $eq, $cont, $lte, $lt, $gte, $gt, $in, $notin, $ne, $starts, $ends, $excl, $fmatch.
  • Suggestion: To get the last occurrence of your universes you should use is_active||$eq||true

Output response example

{
  "count": 0,
  "data": [
    {
      "clients_universe_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "company_id_tr": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "universe_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "universe_name": "string"
    }
  ],
  "page": 0,
  "page_count": 0,
  "total": 0
}

Output fields description

Field Description
count Number of universes returned by the request
data List of universes returned by the request
page_count Number of pages needed to get all the universes
total Total number of universes
Field of each universe Description
clients_universe_id Universe Instance ID
company_id_tr Client Permanent ID
universe_id Permanent ID of the universe (used by routes articles)
universe_name Name of the universe

Entities Data Dictionary

The TextReveal® Alerts API exposes an endpoint named v2/clients-universe/entities that gives the possibility to retrieve entities within one or multiple universes.

GET /v2/clients-universe/entities

Endpoint Details

Endpoint: v2/clients-universe/entities

Method: GET

Description: Access entities within a universe. If the universe client_universe_id is not specified, you will get entities from all the universes you are allowed to access including the SESAMm standard universe.

Parameters

id

  • Description: client_universe_id from output of GET /v2/clients-universe. This field can be a list of client universes ID

size

  • Description: Number of rows to retrieve
  • Defaults: 10

page

  • Description: Page if the number of total rows exceeds size parameter
  • Defaults: 0

key

  • Description: key to be retrieved in database using following rules (These rules are applied with a OR condition):
    • key is contained in any Alias of Entity (case insensitive)
    • key is contained in Name of Entity (case insensitive)
    • key is equal to any Isin
    • key is equal to any Figi
    • key is contained in Ticker of Entity (case insensitive)

sort

  • Description: Sort by relevancy (default) or alphabetically by entity_name. Suffix with :asc or :desc to order.
  • Supported fields: rank:asc, rank:desc, entity_name:asc, entity_name:desc

Output response example

{
  "count": 0,
  "data": [
    {
      "description": "string",
      "entity_name": "string",
      "figi": "string",
      "isin": [
        "string"
      ],
      "permanent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "query": "string",
      "ticker": [
        "string"
      ]
    }
  ],
  "page": 0,
  "page_count": 0,
  "total": 0
}

Output fields description

Field Description
count Number of entities returned by the request
data List of entities returned by the request
page_count Number of pages needed to get all the entities
total Total number of entities

Field of each entity Description of each entity
description A brief summary or explanation of the entity
entity_name The official name of the company, organization, or asset in SESAMm
figi The Financial Instrument Global Identifier, a unique identifier for financial instruments
isin The International Securities Identification Number, a 12-character code used to uniquely identify securities
permanent_id A unique and persistent identifier assigned to an entity for consistent reference
query The search term or request used to retrieve specific information or data in Open Search
ticker The abbreviated symbol or code used to represent a publicly traded company on a stock exchange