Entity relationships

List an entity's relationships, strongest first.

GET/api/v2.0-preview/atlas/entities/relationships

Authorizations

Bearer

Authorizationstringrequiredheader

Required Bearer API key: your NOSIBLE API key from the API Dashboard.

Example: Bearer nos_sk_...

Parameters

query & path

typeenumrequiredquery

Entity type: ORG, PERSON, GPE, LOC or PRODUCT. For a ticker, send its company as an ORG.

Example: ORG

namestringrequiredquery

Entity name, matched case-insensitively. An alias resolves to the entity it names.

Example: Nvidia

limitintegerquery

Page size. Defaults to 50, maximum 500.

Example: 4

cursorstringquery

next_cursor from the previous page.

directionenumquery

in (the entity is the object), out (the entity is the subject) or both. Defaults to both.

Example: in

predicatesstringquery

Keep only these relationship types (comma-separated string). List them with Relationship types.

Example: supplier_to

exclude_predicatesstringquery

Drop these relationship types (comma-separated string).

Example: located_in

other_typesstringquery

Keep only relationships whose other end has one of these entity types.

Example: ORG

exclude_typesstringquery

Drop relationships where either end has one of these entity types.

Example: GPE,LOC

min_supportintegerquery

Minimum number of distinct supporting events inside the window. Defaults to 1.

Example: 5

aliasesenumquery

hide (default), include or only. Alias relationships are normalized_to (spelling variants) and alias_of (short names).

Example: hide

as_ofdatequery

Point in time (YYYY-MM-DD). Only events dated on or before it count. Defaults to the latest date in the release. `to` is accepted as the same parameter, as in the World API.

Example: 2024-12-31

fromdatequery

Optional start of the evidence window (YYYY-MM-DD, inclusive).

Example: 2020-01-01

How to use this endpoint

guidance

Use Entity relationships to page through everything known about one entity at a point in time, strongest first (support, then most recent). The example lists Nvidia's suppliers as of the end of 2024. Pages are stable: the same request and cursor return the same page.

Response body

application/json

These are the fields you can build against. Nested names use dot notation; optional sections are called out in their descriptions.

entityobject

The entity with its events, relationships, first_seen and last_seen inside the window.

relationshipsobject[]

Relationships in this page: {subject, predicate, object, support, first_seen, last_seen}.

totalinteger

Relationships matching the filters.

countinteger

Relationships in this page.

orderstring

Always support_desc.

next_cursorstring | null

Cursor for the next page, null on the last.

schemastring

Response schema name.

as_ofdate

The point in time the answer is computed for.

date_windowobject

The evidence window: from, to, archive_cutoff and include_live (always false).

releasestring

Immutable id of the graph release that answered. The same request against the same release returns identical bytes.

took_msinteger

Server time in milliseconds.

Responses and errors

HTTP

200Request succeeded. The response body is shown in the panel on the right.

400invalid_request — A parameter is missing, malformed or out of range; the message names it.

400invalid_entity_type — The entity type is not one Atlas holds. TICKER is refused: send the company as an ORG.

400unknown_predicate — A relationship type is not in the graph; list them with Relationship types.

401api_key_required — No API key was sent. Send it as Authorization: Bearer <key> or the api-key header.

401invalid_api_key — The API key is invalid or has been revoked.

404unknown_entity — No entity of that type has that name in this release. When the name exists under another type, the message says which.

404not_found — No endpoint matches this method and path.

410cursor_expired — The cursor belongs to another release or request; restart from the first page.

422unprocessable_request — Each value is valid but not together, such as from after as_of.

422request_too_broad — The request ran out of its work budget before it could answer; narrow it.

429rate_limited — Too many requests for this key; wait for Retry-After.

501backend_not_configured — The Atlas backend is not configured for this deployment.

502backend_error — The Atlas backend could not be reached; retry shortly.

503unavailable — The service is busy or starting; retry after Retry-After.

503api_key_auth_unavailable — API key authentication is temporarily unavailable; retry shortly.

504request_timeout — The request took longer than 25 seconds; narrow it.

504backend_timeout — The Atlas backend did not answer before the deadline; retry.