Get Entity
get_entityGet full details for a sanctioned entity by its OpenSanctions ID. Returns all properties including names, addresses, identifiers, sanctions programs, and related entities. Requires your own OpenSanctions API key, passed as _apiKey.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | OpenSanctions entity ID (e.g., "Q7747") | |
| _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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | OpenSanctions entity ID | |
| names | Yes | Known names for this entity | |
| notes | Yes | Additional notes about entity | |
| score | Yes | Search relevance score | |
| schema | Yes | Entity type (Person, Company, Organization, Vessel, Aircraft) | |
| target | Yes | Whether entity is a sanctions target | |
| topics | Yes | Associated topics/categories | |
| caption | Yes | Entity display name | |
| datasets | Yes | Datasets this entity appears in | |
| position | Yes | Position held if applicable | |
| countries | Yes | Associated country codes | |
| last_seen | Yes | Date entity last appeared | |
| birth_date | Yes | Birth date if Person | |
| first_seen | Yes | Date entity first appeared | |
| last_change | Yes | Date of last data change | |
| nationality | Yes | Nationalities |