/opensanctions/entities

POST /api/opensanctions/entities

Price: 5 credits

Get OpenSanctions (opensanctions.org) entity details by id or entity URL

How to use it

Get full OpenSanctions (opensanctions.org) entity details by id (Wikidata Q-id or internal id) or entity URL. Returns caption, schema (Person/Company/Organization/Vessel/...), topics (sanctioned/PEP/etc), names, aliases, descriptions, birth date, nationalities, countries, addresses, positions, identifiers (Wikidata/registration/tax/etc), the datasets the entity appears in, and relationships to other entities (family, associates, ownership, positions).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• entity string required — OpenSanctions entity id (Wikidata Q-id like 'Q7747', or internal id) or full entity URL ('https://www.opensanctions.org/entities/Q7747/'). (examples: "Q7747", "https://www.opensanctions.org/entities/Q7747/"; minLength: 1; pattern: ^(?:https?://[^\s]+|//[^\s]+|(?:www\.)?opensanctions\.org[^\s]*|[A-Za-z0-9][A-Za-z0-9._-]*)$)

Response

• @type string (default: "OpensanctionsEntity")
• id string required
• caption string required
• schema string nullable
• url string required
• topics array (default: [])
• names array (default: [])
• aliases array (default: [])
• descriptions array (default: [])
• birth_date string nullable
• nationalities array (default: [])
• countries array (default: [])
• genders array (default: [])
• addresses array (default: [])
• positions array (default: [])
• properties object (default: {})
  • * array
• identifiers array (default: [])
  • @type string (default: "OpensanctionsIdentifier")
  • type string required
  • value string required
• datasets array (default: [])
  • @type string (default: "OpensanctionsDataset")
  • name string required
  • target_count integer nullable
  • summary string nullable
  • url string nullable
• relationships array (default: [])
  • @type string (default: "OpensanctionsRelationship")
  • id string required
  • caption string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Entity not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.