Search Entities
search_entitiesSearch global sanctions, watchlists, and PEP (politically exposed persons) databases. Returns matched entities with names, countries, datasets, and sanctions details. Example: search_entities("Vladimir Putin") or search_entities("Huawei", schema="Company"). Requires your own OpenSanctions API key, passed as _apiKey.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Name or keyword to search (e.g., "Gazprom", "Kim Jong") | |
| schema | No | Entity type: "Person", "Company", "Organization", "Vessel", "Aircraft" | |
| _apiKey | Yes | Your own OpenSanctions API key (BYO — Pipeworx does not supply one; OpenSanctions is a commercial service). Get one at opensanctions.org/api — free for non-commercial use, paid for commercial. For a keyless US sanctions/export-control screen, use the sanctions-screening pack (sanctions_screen) instead. | |
| countries | No | Comma-separated country codes (e.g., "ru,cn,ir") |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The search query string provided | |
| total | Yes | Total number of matching entities | |
| entities | Yes | Formatted entity objects | |
| returned | Yes | Number of entities in this response |