Universes

Get Universe Entities

Get entities for one universe

GET
https://api.textreveal.com/v3/universes/{universe_id}/entities

Request

Parameters

  • universe_id*uuid

    Unique identifier of the universe

  • sizeinteger

    Number of records per page

    Default: 10Range: [1, 1000]
  • search_afteruuid

    The last ID on the page you're currently on when you want to fetch the next page.

  • name(string (operator))[]

    Entity name.

    Example: "eq:fujitsu"
  • alias(string (operator))[]

    Entity alias.

    Example: "ilike:fujitsu"
  • duns(string (operator))[]

    Entity DUNS number.

    Example: "eq:000000000"
  • figi(string (operator))[]

    FIGI (Financial Instrument Global Identifier) of the entity.

    Example: "eq:BBG000BGJWM6"
  • isin(string (operator))[]

    Entity ISIN.

    Example: "eq:JP3818000006"
  • ticker(string (operator))[]

    Entity stock ticker.

    Example: "eq:6702.T"

Response

Response - 200

Properties of the entities

  • data*object[]

    Properties of the entities.

  • size*integer

    Number of records per page requested.

    Example: 1
  • has_next*boolean

    True if there are more records available.

    Example: true
  • count*integer

    Number of records returned in the current page.

    Example: 1
  • search_after*string | null

    Cursor for next page.

Response
{
  "data": [
    {
      "id": "753c48d6-23c8-5fb0-9230-b099898452b5",
      "description": "Fujitsu is a information & communications technology equipment and services firm providing IT & IT infrastructure and other services.",
      "name": "Fujitsu",
      "figi": "BBG000BLNXT1",
      "isin": [
        "US23381B1061"
      ],
      "ticker": [
        "FJTSF"
      ],
      "alias": [
        "FUJITSU LIMITED (Kawasaki)"
      ],
      "website": "https://www.fujitsu.com/",
      "country": "Japan"
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string"
}