Knowledge Graph

KG candidates

Get candidate entities following an initial user request.

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

Request

Request Body

  • keyword_of_interest*string

    The fuzzy keyword to look-up in the the KG.

    Example: "Apple"
  • max_resultsnumber

    The maximum results number to retrieve.

    Default: 5Range: [0, 10000]
  • modestring (enum)
    (deprecated)

    The sorting mode.

    Default: "pagerank"Values: "pagerank", "no_ranking"
  • search_aliasesboolean
    (deprecated)

    Get aliases if set to True.

    Default: trueExample: true
  • sourcestring (enum)

    The knowledge graph source.

    Default: "corporate_kg"Values: "general_kg", "corporate_kg"
Request
{
  "keyword_of_interest": "Apple",
  "max_results": 5,
  "source": "corporate_kg"
}

Response

Response - 200

Candidates Response

  • []array
Response
[
  {
    "FIGI": [
      "BBG000B9XRY4"
    ],
    "ISIN": [
      "US0378331005"
    ],
    "itemDescription": "Apple is a technology company that designs, manufactures, and markets consumer electronics, personal computers, and software.",
    "item_id": "apple",
    "label": "Apple",
    "ticker": "AAPL",
    "uuid": "a62caf56-5961-4fff-ba2e-6d4dcf98960f"
  }
]