/api/entities

This route can be used to find entities.
This is primarily useful to find the UUID of a specific entity, to be used in other routes.
It can also be used to find what entity type something is, and the relative frequency of its types.

Usage

Examples:

GET Basic Name Search:
http://96.241.186.201:5173/api/entities?api_key=your-api-key&ent_name=Facebook
		
GET ORGs, GPEs, and PRODUCTs:
http://96.241.186.201:5173/api/entities?api_key=your-api-key&ent_type=ORG,GPE,PRODUCT

Query Parameters:

ParamRequired?Example ValueDescription
api_keyRequiredGp41Z-GgyZQ9fyIa3uWy0N-HRKD1b9ouui2qhAs26QkYour API Key, found on your account page. This can also be provided under the X-API-KEY header.
limitOptional100
(Defaults to 10)		Number of entities to return.
ent_nameOptionalRaytheonA name to search for. The results will be ordered by similarity to the search term.
ent_typeOptionalORG, PRODUCT, GPE, PERSON, TITLE, FAC, TECHNOLOGY, LAW, LOC, NORP, THREAT, EVENTEntity types filter. Only entities of the specified types will be returned.
Multiple values can be comma-delimited or entered as separate query params.

Result Format

Below is an example output of this route.

  • "sml" is similarity with the specified ent_name, and will only be returned if ent_name is specified.
  • "rows_returned" is how many rows were billed in the completion of the request.
{
    "rows_returned": 5,
    "entities": [
        {
            "ent_uuid": "ab33916f-395d-4e36-b7d6-3a773f39bfc5",
            "ent_name": "Facebook",
            "ent_type": "PRODUCT",
            "ent_aliases": [],
            "occurrence_count": "151",
            "sml": 1
        },
        {
            "ent_uuid": "314e3b58-0283-483b-b996-1441aa63bfca",
            "ent_name": "Facebook",
            "ent_type": "ORG",
            "ent_aliases": [],
            "occurrence_count": "82",
            "sml": 1
        },
        {
            "ent_uuid": "01167343-b974-4652-8a06-7cadf0f9f041",
            "ent_name": "Facebook Inc",
            "ent_type": "ORG",
            "ent_aliases": [],
            "occurrence_count": "2",
            "sml": 0.6923077
        },
        {
            "ent_uuid": "c11071ba-9535-47c5-aafb-beabfc6c949a",
            "ent_name": "Facebook SDK",
            "ent_type": "PRODUCT",
            "ent_aliases": [],
            "occurrence_count": "1",
            "sml": 0.6923077
        },
        {
            "ent_uuid": "b759fb91-6e39-46d0-8f51-80841ef2d47d",
            "ent_name": "Facebook Live",
            "ent_type": "PRODUCT",
            "ent_aliases": [],
            "occurrence_count": "1",
            "sml": 0.64285713
        }
    ]
}