Entities Structure

Get Entities

List the available entities

GET

https://api.textreveal.com/v3/entities

Each entity has a hidden _score field that is a relevance score. The relevancy of an entity is computed based on the following factors:

Does the entity have a lei, ticker, ... same for other identifiers
Does the entity have a valid description, website ...

And then based on the query, if the entity is a match or not. When using fuzzy, the score is higher if the entity is close to the query.

Parameters

sizeinteger
Number of records per page
Default: 10Range: [1, 1000]
search_afterstring
search_after field value from the previous page
name(string (operator))[]
Name of the entity.
Example: "eq:fujitsu"
alias(string (operator))[]
Alternative name, abbreviation, or local brand used to refer to a company or entity.
Example: "ilike:fujitsu"
duns(string (operator))[]
Duns number of the entity.
Example: "eq:000000000"
figi(string (operator))[]
FIGI (Financial Instrument Global Identifier) of the entity.
Example: "eq:BBG000BGJWM6"
isin(string (operator))[]
International Securities Identification Number used to uniquely identify a financial security.
Example: "eq:JP3818000006"
ticker(string (operator))[]
Stock market ticker symbol used to identify a publicly traded company on an exchange.
Example: "eq:6702.T"
lei(string (operator))[]
Legal Entity Identifier (LEI) is a 20-character alphanumeric code.
Example: "eq:123400ABCDEFGH56789"
entity_id(string (operator))[]
SESAMm Unique Entity ID.
Example: "eq:7457a013-9c65-451f-b82d-96d7a22b5cfa"
website(string (operator))[]
Website of the entity. Protocol is not always present.
Example: "eq:https://www.official-website.com"
orderfield:direction
Order to apply to the result.

Possible fields are: name, _score.

Possible directions are: asc and desc.
Default: _score:descExample: "_score:desc"
pageinteger
Page number, 1-based
fields(string (enum))[]
Fields to include in the response
Default: ["id", "description", "name", "figi", "isin", "ticker", "alias", "website", "country", "lei"]Values: "id", "description", "name", "figi", "isin", "ticker", "alias", "website", "country", "lei"

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
total*integer
Total number of records.
Example: 1
search_afterstring | 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": [
        "US0378331005"
      ],
      "ticker": [
        "AAPL"
      ],
      "alias": [
        "Apple Inc."
      ],
      "website": "https://www.fujitsu.com/",
      "country": "japan",
      "lei": "123400ABCDEFGH56789"
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "total": 1,
  "search_after": "string"
}

{
  "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": [
        "US0378331005"
      ],
      "ticker": [
        "AAPL"
      ],
      "alias": [
        "Apple Inc."
      ],
      "website": "https://www.fujitsu.com/",
      "country": "japan",
      "lei": "123400ABCDEFGH56789"
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "total": 1,
  "search_after": "string"
}

Request

Parameters

Response

Response - 200