/offshoreleaks/nodes/connections

POST /api/offshoreleaks/nodes/connections

Price: 5 credits

Page through all graph connections of an Offshore Leaks node, filtered by connected node category

How to use it

List the graph connections (edges) of an Offshore Leaks node, filtered by the category of the connected node (Entity, Officer, Intermediary or Address). Each connection includes the related node id and name, the relationship role (e.g. Shareholder, Beneficiary, Intermediary of, Registered address), validity dates, and for entity connections the incorporation date, jurisdiction and status. Use this to retrieve the full connection list of a high-degree node whose offshoreleaks/nodes response only includes the first page inline.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• node string required — Node id whose connections to page through (examples: "11010643"; minLength: 1)
• category string required — Category of the connected nodes to return (one of: "Entity", "Officer", "Intermediary", "Address")
• count integer required — Number of connections to return (min: 1)

Response

• @type string (default: "OffshoreLeaksConnection")
• id integer nullable
• name string required
• category string nullable
• role string nullable
• start_date string nullable
• end_date string nullable
• incorporation_date string nullable
• jurisdiction string nullable
• status string nullable
• data_source 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 — Node not found for the given id 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.