Knowledge Graph

KG browse

Get aliases and keywords for a given entity and properties.

POST
https://api.textreveal.com/api/2.0/kg/browse

Request

Request Body

  • entity_of_interest*string

    The identifier of an Entity.

    Example: "apple"
  • properties_liststring[]

    The properties to look for in the KG.

    If source is corporate_kg, defaults to [ "chief_executive_officer", "domain", "founders", "legal_name", "subsidiaries", "ticker" ]

    If source is general_kg, defaults to the full list of properties corresponding to the entity provided.

    Example: ["chief_executive_officer"]
  • sourcestring (enum)

    The knowledge graph source.

    Default: "corporate_kg"Values: "general_kg", "corporate_kg"
  • uuiduuid

    The uuid identifier of an Entity. Available only with corporate_kg source.

Request
{
  "entity_of_interest": "apple",
  "properties_list": [
    "chief_executive_officer",
    "domain",
    "founders",
    "legal_name",
    "subsidiaries",
    "ticker"
  ],
  "source": "corporate_kg"
}

Response

Response - 200

Browse Response

  • FIGIstring[]

    Financial Instrument Global Identifier of the entity.

    Example: ["BBG000B9XRY4"]
  • ISINstring[]

    International Securities Identification Numbers of the entity.

    Example: ["US0378331005"]
  • aliasesobject

    The entity aliases.

  • descriptionobject

    A short description of the entity.

    Example: {"en":"Apple is a technology company that designs, manufactures, and markets consumer electronics, personal computers, and software."}
  • labelsobject

    The entity labels.

    Example: {"en":"Apple"}
  • propertiesobject

    The entity properties.

  • websitesobject

    The websites of the company.

    Example: {"en":["apple.com.cn", "apple.com"]}
Response
{
  "FIGI": [
    "BBG000B9XRY4"
  ],
  "ISIN": [
    "US0378331005"
  ],
  "aliases": {
    "en": [
      "Apple Computer"
    ]
  },
  "description": {
    "en": "Apple is a technology company that designs, manufactures, and markets consumer electronics, personal computers, and software."
  },
  "labels": {
    "en": "apple"
  },
  "properties": {
    "chief_executive_officer": {
      "labels": [
        {
          "en": "Tim Cook"
        }
      ]
    },
    "domain": {
      "labels": [
        {
          "en": "apple.com"
        }
      ]
    },
    "founders": {
      "labels": [
        {
          "en": "David Pakman"
        },
        {
          "en": "Ron Wayne"
        },
        {
          "en": "Steve Jobs"
        },
        {
          "en": "Steve Wozniak"
        }
      ]
    },
    "legal_name": {
      "labels": [
        {
          "en": "Apple Inc."
        }
      ]
    },
    "subsidiaries": {
      "labels": [
        {
          "en": "AC Wellness"
        },
        {
          "en": "FileMaker"
        },
        {
          "en": "Braeburn Capital"
        }
      ]
    },
    "ticker": {
      "labels": [
        {
          "en": "AAPL"
        }
      ]
    }
  },
  "websites": {
    "en": [
      "https://www.apple.com/at"
    ]
  }
}