/offshoreleaks/nodes

POST /api/offshoreleaks/nodes

Price: 1 credit

Retrieve a single Offshore Leaks node (entity, officer, intermediary or address) by its id

How to use it

Get a single node from the ICIJ Offshore Leaks database by id. A node is one of four types (node_type): an offshore Entity, an Officer (person or company linked to an entity), an Intermediary (law firm / agent), or an Address. Returns the node's name, registered jurisdiction, linked countries, agent, incorporation / inactivation / struck-off dates, status, originating data source (leak), and its first page of graph connections to other nodes. Use offshoreleaks/nodes/connections to page through all connections of a high-degree node.

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 from the database (examples: "10131839", "13003807"; minLength: 1)

Response

• @type string (default: "OffshoreLeaksNode")
• id integer required
• node_type string required
• name string required
• jurisdiction string nullable
• countries array (default: [])
• agent string nullable
• incorporation_date string nullable
• inactivation_date string nullable
• struck_off_date string nullable
• status string nullable
• data_source string nullable
• map_url string nullable
• source_url string required
• connections array (default: [])
  • @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.