OPopensanctions
Data access

Fetch Adjacent By Property*

Changed on

*Beta: This endpoint is released for wider testing and is not yet recommended for production use. We welcome feedback. Its interface may change without announcement.

Retrieve entities adjacent to a given entity for a specific property.

This endpoint offers the same information as adjacent entities nested in /entities/{entity_id}, but offers pagination for cases where the number of results is potentially very large.

get/entities/{entity_id}/adjacent/{property_name}

Request

  • Base URL
    https://api.opensanctions.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.opensanctions.org/entities/{entity_id}/adjacent/{property_name}
  • Auth
    none declared

Path parameters

entity_idstring required

ID of the entity hose graph context was requested

Example:Q7747
property_namestring required

Name of the property to fetch adjacent entities for

Example:address

Query parameters

sortstring[]
limitinteger
offsetinteger

Response

Successful Response

limitinteger required
offsetinteger

Example response

{
  "limit": 20,
  "total": {
    "value": 42,
    "relation": "eq"
  },
  "results": [
    {
      "id": "ds-abc-own-123",
      "properties": {
        "asset": [
          {
            "caption": "Company 1 Ltd.",
            "id": "NK-1234",
            "properties": {
              "name": [
                "Company 1 Ltd."
              ]
            },
            "schema": "Comany"
          }
        ]
      },
      "schema": "Ownership"
    }
  ]
}

Changes

  • c5a282ece45dRevision changes
    • info

      removed subschema #1 subschema #2 from the /// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property anyOf list for the response status

  • 024572c7ad35Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status