Entities Structure

Search Multiple Entities

Searches for entity candidates using a name, alias, or identifiers.

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

Request

Parameters

  • max_candidatesinteger

    Max number of candidates to return for each entity

    Default: 10Range: [1, 10]
  • fields(string (enum))[]

    Fields to include in the response

    Default: ["id", "description", "figi", "isin", "ticker", "alias", "website", "country", "lei", "name"]Values: "id", "description", "figi", "isin", "ticker", "alias", "website", "country", "lei", "name"

Request Body

  • entities*object[]
    Array length: [1, 500]
Request
{
  "entities": [
    {
      "name": "eq:fujitsu",
      "alias": "ilike:fujitsu",
      "duns": "eq:000000000",
      "figi": "eq:BBG000BGJWM6",
      "isin": "eq:JP3818000006",
      "ticker": "eq:6702.T",
      "lei": "eq:123400ABCDEFGH56789",
      "entity_id": "eq:7457a013-9c65-451f-b82d-96d7a22b5cfa",
      "website": "eq:https://www.official-website.com"
    }
  ]
}

Response

Response - 200

Properties of the candidates

  • data*object[]

    Search result

Response
{
  "data": [
    {
      "total_candidates": 27,
      "matches": [
        {
          "id": "753c48d6-23c8-5fb0-9230-b099898452b5",
          "description": "Fujitsu is a information & communications technology equipment and services firm providing IT & IT infrastructure and other services.",
          "figi": "BBG000BLNXT1",
          "isin": [
            "US0378331005"
          ],
          "ticker": [
            "AAPL"
          ],
          "alias": [
            "Apple Inc."
          ],
          "website": "https://www.fujitsu.com/",
          "country": "japan",
          "lei": "123400ABCDEFGH56789",
          "name": "Fujitsu"
        }
      ]
    }
  ]
}

Error

Error - 400

Bad request

  • message*string

    Error message.

    Example: "The server returned an unexpected response"
  • code*integer

    Error code.

    Example: 400
  • reason*string (enum)

    Error reason.

    Values: "invalid", "timeout", "offline", "unknown", "not_found", "unauthorized", "forbidden", "internal"
  • errorsobject[]

    Possible error causes, like query params, headers or body.

Response
{
  "message": "The server returned an unexpected response",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "Expected number, received string",
      "field": "size",
      "reason": "invalid_type"
    }
  ]
}

Error - 403

Not authorized

  • message*string
    Example: "Not authorized to access this resource"
  • code*number (enum)

    Error code.

    Values: 403
  • reason*string (enum)
    Values: "forbidden"
Response
{
  "message": "Not authorized to access this resource",
  "code": 403,
  "reason": "forbidden"
}

Error - 404

Not found

  • message*string
    Example: "[record] not found."
  • code*number (enum)

    Error code.

    Values: 404
  • reason*string (enum)
    Values: "not_found"
Response
{
  "message": "[record] not found.",
  "code": 404,
  "reason": "not_found"
}