Skip to main content
GET
The Network Graph holds the ties between the people in Orbit. This endpoint returns the chain of people that connects one person to another, with the strength of each link and what ties each pair. Two people are linked when Orbit holds a direct relationship between them (family, a stated connection, a mutual follow on social media) or when they worked, or studied, at the same place in the same years. A path has at most six links.

Modes

Strength

Each link has a strength from 0 to 1. Family and long overlaps at one employer are strong. A mutual follow alone, or a short overlap, is weak. The path’s strength is the strengths of its links multiplied, so a shorter path of strong ties scores higher than a longer path of weak ones.

Credits

A found path is charged at the Network Graph path rate in the pricing catalog. A search that finds no path is free: found is false, reason says why, and billing is null. Send an Idempotency-Key header to retry a request without a second charge. See Credits.

Authorizations

Authorization
string
header
required

Use an Orbit API key from the Developer Dashboard.

Headers

Idempotency-Key
string

A client-generated key for a safe retry. If the body omits request_id, Orbit can use this value as the request ID.

Maximum string length: 200

Path Parameters

profile_id
string<uuid>
required

The Orbit profile ID (UUID) of the person the path starts from.

Query Parameters

to
string<uuid>
required

The Orbit profile ID (UUID) of the person the path ends at.

mode
enum<string>
default:shortest

shortest (the fewest people) or strongest (the strongest ties).

Available options:
shortest,
strongest

Response

The path, or why no path was returned.

from_profile_id
string<uuid>
required

The person the path starts from.

to_profile_id
string<uuid>
required

The person the path ends at.

mode
enum<string>
required

The mode of the search.

Available options:
shortest,
strongest
found
boolean
required

True when Orbit found a path.

degrees
integer | null
required

The number of links between the two people. 1 means they are tied directly. Null when no path was found.

Required range: x >= 1
strength
number | null
required

The strength of the whole path: the strengths of its links multiplied. Null when no path was found.

Required range: 0 <= x <= 1
people
object[]
required

The people on the path, in order, from from_profile_id to to_profile_id. Empty when no path was found.

The links between consecutive people. Empty when no path was found.

reason
enum<string> | null
required

Why no path was returned: no_path (none within six links), search_limit (the search reached its limit first) or not_in_graph (a person is not in Orbit's people graph yet). Null when a path was found.

Available options:
no_path,
search_limit,
not_in_graph,
null
billing
object | null
required

The charge for a found path. Null when no path was found: those searches are free.

contract_version
enum<string>
required
Available options:
network-path.v1