v1

latestOpenAPI 3.1.02026-07-2652038.3 KB
API v1
Entities

Entities

Get typed entity data by its numeric UUID — company, person, place, law, financial instrument, and more (the schema spans many domains, illustrative not exhaustive) — in two modes:

  • Coarse (no body): returns only the default property set. No relationships, no numerical observations. Use only when a rough profile is enough.

  • Projection (body): name exact properties, relationships, and numerical_observations to get back. The only way to get relationships or time-series data, and the most token-efficient read. Available fields vary by entity type and must be queryable for that specific entity — run entity_introspection first to discover them; projecting blind wastes round-trips and may hit empty or non-queryable edges.

Pass the entity UUID in the URL path (e.g. POST /entities/{entity_id}). Optionally send a JSON body to specify which properties and relationships to return; if omitted, default properties are returned.

Examples (path + optional body):

POST /entities/c6772802-bdbc-4778-91e9-cd3d27d008d5

Optional body: {"properties": ["name", "aliases", "registered_address", "employee_count"], "relationships": {"outgoing": {"IS_ULTIMATE_PARENT": {"limit": 5}}, "incoming": {"IS_CEO_OF": {}}}}

Use this when: You already have an entity UUID (from entity_search, knowledge_search, or knowledge_query results) and need entity data. Use entity_search first if you only have a name, and entity_introspection first if you need a projection.

post/v1/entities/{entity_id}

Path parameters

entity_idstring uuid required

Request body

propertiesstring[]

List of entity property names to query

numerical_observationsobject

UUIDs of the numerical observations to query

Example request

{
  "numerical_observations": {
    "FinancialMetric": [
      "1d3eae40-0ba8-5baf-9907-6a4823b067bb"
    ]
  },
  "properties": [
    "name",
    "aliases",
    "registered_address",
    "employee_count"
  ],
  "relationships": {
    "incoming": {
      "IS_BOARD_MEMBER_OF": {
        "limit": 2,
        "offset": 2
      }
    },
    "outgoing": {
      "IS_REGISTERED_IN": {
        "limit": 2,
        "offset": 0
      }
    }
  }
}

Response

Successful Response

idstring uuid required

The ID of the entity

namestring required

The name of the entity

entity_type'Entity' | 'Animal' | 'Award' | 'Organization' | 'Company' | 'EducationalInstitution' | 'IntergovernmentalOrganization' | 'Person' | 'Event' | 'GPE' | 'Country' | 'CountrySubdivision' | 'DependentTerritory' | 'Municipality' | 'Continent' | 'Currency' | 'Industry' | 'FinancialMetric' | 'Group' | 'CorporateEvent' | 'PrivateCompanyFundingRound' | 'Facility' | 'Location' | 'Organism' | 'Plant' | 'Product' | 'Sanction' | 'WorkOfArt' | 'Law' | 'Language' | 'Exchange' | 'Future' | 'Commodity' | 'PositioningMetric' | 'MacroIndicatorPublication' | 'MacroIndicator' | 'ForeignExchangeRate' | 'CountryRegion' required

The type of the entity

descriptionstring nullable

A short description of the entity

propertiesobject required

List of property names available for this entity (e.g. id, name, currency).

Example response

{
  "description": "Computer company founded in 1977 with headquarters in Cupertino, California",
  "entity_type": "Company",
  "id": "c6772802-bdbc-4778-91e9-cd3d27d008d5",
  "name": "APPLE INC",
  "numerical_observations": [
    {
      "data": [
        {
          "origin": {
            "name": "10-Q",
            "published_time": "2026-01-30T00:00:00Z",
            "source": "SEC",
            "url": "https://www.sec.gov/Archives/edgar/data/0000320193-26-000006/0000320193-26-000006-index.html"
          },
          "time": "2025-12-27T00:00:00Z",
          "value": 45317000000
        },
        {
          "origin": {
            "name": "10-K",
            "published_time": "2025-10-31T00:00:00Z",
            "source": "SEC",
            "url": "https://www.sec.gov/Archives/edgar/data/0000320193-25-000079/0000320193-25-000079-index.html"
          },
          "time": "2025-09-27T00:00:00Z",
          "value": 35934000000
        },
        {
          "origin": {
            "name": "10-Q",
            "published_time": "2026-01-30T00:00:00Z",
            "source": "SEC",
            "url": "https://www.sec.gov/Archives/edgar/data/0000320193-26-000006/0000320193-26-000006-index.html"
          },
          "time": "2025-09-27T00:00:00Z",
          "value": 35934000000
        }
      ],
      "id": "1d3eae40-0ba8-5baf-9907-6a4823b067bb",
      "name": "Cash and Cash Equivalents, at Carrying Value",
      "properties": {
        "unit": "USD",
        "aliases": [],
        "taxonomy": "us-gaap",
        "cadence": "i"
      },
      "type": "FinancialMetric"
    }
  ],
  "properties": {
    "name": {
      "sources": [
        {
          "date": "2026-02-26",
          "document": {
            "endpoint": "https://efts.sec.gov/LATEST/search-index?q=%22APPLE+INC%22",
            "params": {},
            "response_hash": "3f0354a291ad77088d55bd2577294a85d5ba3c1b9ae0aa5a58c53bb24ed49111"
          },
          "name": "SEC"
        }
      ],
      "value": "APPLE INC"
    },
    "aliases": {
      "sources": [],
      "value": [
        "Apple Computer, Inc.",
        "Apple",
        "AAPL",
        "Apple Inc.",
        "Apple (AAPL)",
        "Apple Computer Inc.",
        "Apple Computer Company",
        "NASDAQ: AAPL",
        "Apple — AAPL (NASDAQ: AAPL)",
        "Apple (NASDAQ: AAPL)"
      ]
    },
    "registered_address": {
      "sources": [
        {
          "date": "2026-01-01",
          "document": "https://www.creditsafe.com/business-index/en-gb/company/apple-inc-us22139727",
          "name": "Apple Inc Credit Report"
        },
        {
          "date": "2025-07-25",
          "document": "https://www.bbb.org/us/ca/cupertino/profile/home-electronics/apple-inc-1216-198239",
          "name": "About"
        },
        {
          "date": "2026-04-16",
          "document": "https://labormarketinfo.edd.ca.gov/aspdotnet/databrowsing/empDetails.aspx?menuchoice=emp&geogArea=0604000085&empId=008264145",
          "name": "labormarketinfo.edd.ca.gov"
        }
      ],
      "value": "One Apple Park Way, Cupertino, CA 95014, USA"
    },
    "employee_count": {
      "sources": [
        {
          "date": "2026-04-15",
          "document": "https://www.stockanalysis.com/stocks/aapl/employees/",
          "name": "Apple (AAPL) Number of Employees 1994-2025"
        }
      ],
      "value": 166000
    }
  },
  "relationships": {
    "incoming": {
      "IS_BOARD_MEMBER_OF": [
        {
          "entity_type": "Person",
          "id": "1118056e-3ddc-4856-8855-9f6179924d25",
          "name": "William Campbell",
          "properties": {
            "valid_until": "2015-03-13",
            "sources": [
              {
                "date": "2014-03-05",
                "document": "https://www.sec.gov/Archives/edgar/data/320193/000119312514084697/d684095d8k.htm",
                "name": "SEC"
              },
              {
                "date": "2015-03-13",
                "document": "https://www.sec.gov/Archives/edgar/data/320193/000110465915019336/a15-5624_18k.htm",
                "name": "SEC"
              }
            ],
            "id": "b4ab6a95-9b90-4c70-bcde-343f34df25ca",
            "valid_since": "2014-02-28"
          }
        },
        {
          "entity_type": "Person",
          "id": "39326f52-abf3-44f9-a552-ef183daa68f0",
          "name": "James A. Bell",
          "properties": {
            "valid_until": "2024-02-28",
            "sources": [
              {
                "date": "2015-10-02",
                "document": "https://www.sec.gov/Archives/edgar/data/320193/000119312515336615/d10101d8k.htm",
                "name": "SEC"
              },
              {
                "date": "2016-03-01",
                "document": "https://www.sec.gov/Archives/edgar/data/320193/000119312516488223/d150918d8k.htm",
                "name": "SEC"
              },
              {
                "date": "2017-03-01",
                "document": "https://www.sec.gov/Archives/edgar/data/320193/000119312517064019/d342218d8k.htm",
                "name": "SEC"
              },
              {
                "date": "2018-02-14",
                "document": "https://www.sec.gov/Archives/edgar/data/320193/000119312518045761/d374908d8k.htm",
                "name": "SEC"
              },
              {
                "date": "2019-03-04",
                "document": "https://www.sec.gov/Archives/edgar/data/320193/000032019319000032/copyofreference8-kform8xkq.htm",
                "name": "SEC"
              },
              {
                "date": "2020-02-27",
                "document": "https://www.sec.gov/Archives/edgar/data/320193/000119312520050884/d865740d8k.htm",
                "name": "SEC"
              }
            ],
            "id": "93adb3c1-049f-4dc4-a363-7b368f69d76f",
            "valid_since": "2015-10-01"
          }
        }
      ]
    },
    "outgoing": {
      "IS_REGISTERED_IN": [
        {
          "entity_type": "Country",
          "id": "37a1f0f5-f5ef-4b63-b3d8-14f5636be703",
          "name": "United States",
          "properties": {
            "sources": [
              {
                "date": "2026-04-15",
                "document": "https://indianexpress.com/article/trending/top-10-listing/top-10-tech-companies-in-the-world-by-market-cap-2025-9977264",
                "name": "indianexpress.com"
              }
            ],
            "id": "bb76eabf-d089-5a3a-a4a3-2ab2b38a2cac"
          }
        }
      ]
    }
  }
}
All 5 operations