Skip to main content

Overview

The find_entities tool searches for organizations, people, places, and products. Search by name, filters, or both to retrieve matching entity IDs and metadata. Use this tool for entities such as central banks, government bodies, executives, cities, regions, and named products. For companies, ETFs, funds, and other securities, use find_securities instead. Once you have an entity ID, you can use it in entity filters accepted by other Bigdata.com tools.

When to Use

Use find_entities when the user:
  • Names a person, organization, place, or product that needs to be resolved to an entity ID
  • Describes entities by attributes, such as cities in a region or people with a particular position
  • Combines a name with filters to disambiguate similar entities

Parameters

Provide at least one of query or filters.

Filters

Filter values must be complete values; they do not perform partial matching. Country filters use ISO 3166-1 alpha-2 codes such as US, FR, and GB.
Use list_entity_filter_values to retrieve accepted values for a filter when the exact spelling or format is unknown.

Data Returned

Each matching entity includes an id, name, and description when available, plus fields specific to its entity type: