Personalized - Direct Network API

OpenRank APIs for direct neighbors of a particular profile

Direct Network: Personalized Trust Graph

Discover the nearest neighbors social graph of a profile via Farcaster EOA or FIDs. You can choose direct neighbors based on the 'following' or 'engagement' strategy.

EOA = Externally Owned Account

FIDs = Farcaster Identities

Personalized Engagement by Address

Endpoint: /graph/neighbors/engagement/addresses

Parameters: an array of addresses in the request body and 2 optional parameters (k, limit) where k is the degree (max 5) of separation and limit is the number of rows to be returned (max 1000).

Example below using curl:

curl -X 'POST' \
'https://graph.cast.k3l.io/graph/neighbors/engagement/addresses?k=2&limit=100' \
-H 'accept: application/json' \
-H 'Content-Type: application/json'  \
-d '["0xd7029bdea1c17493893aafe29aad69ef892b8ff2", "0x8fc5d6afe572fefc4ec153587b63ce543f6fa2ea"]' 

Personalized Engagement by Handle

Endpoint: /graph/neighbors/engagement/handles

Parameters: an array of handles and 2 optional parameters (k, limit).

Example below using curl:

curl -X 'POST' \
'https://graph.cast.k3l.io/graph/neighbors/engagement/handles?k=2&limit=100' \
-H 'accept: application/json' \
-H 'Content-Type: application/json'  \
-d '["vitalik.eth", "dwr.eth"]' 

Personalized Engagement Trust Graph by Farcaster ID (fid)

Endpoint: /graph/neighbors/engagement/fids

Parameters: an array of fids and 2 optional parameters (k, limit).

Example below using curl:

curl -X 'POST' \
'https://graph.cast.k3l.io/graph/neighbors/engagement/fids?k=2&limit=100' \
-H 'accept: application/json' \
-H 'Content-Type: application/json'  \
-d '[5650, 3]' 

Personalized Graph (Direct Network) API Documentation

Tryout the APIs here! — https://graph.castk3l.io/docs

Get Neighbors Engagement

Given a list of input addresses, return a list of addresses that the input addresses have engaged with.

We do a BFS traversal of the social engagement graph upto k degrees and terminate traversal when limit is reached.

Example: ["0x4114e33eb831858649ea3702e1c9a2db3f626446", "0x8773442740c17c9d0f0b87022c722f9a136206ed"]

POST/graph/neighbors/engagement/addresses

Query parameters

Body

application/json

itemsstring

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('/graph/neighbors/engagement/addresses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Get Neighbors Following

Given a list of input addresses, return a list of addresses that the input addresses are following.

We do a BFS traversal of the social follower graph upto k degrees and terminate traversal when limit is reached.

Example: ["0x4114e33eb831858649ea3702e1c9a2db3f626446", "0x8773442740c17c9d0f0b87022c722f9a136206ed"]

POST/graph/neighbors/following/addresses

Query parameters

Body

application/json

itemsstring

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('/graph/neighbors/following/addresses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Get Neighbors Engagement For Handles

Given a list of input handles, return a list of handles that the input handles have engaged with.

We do a BFS traversal of the social engagement graph upto k degrees and terminate traversal when limit is reached.

Example: ["farcaster.eth", "varunsrin.eth", "farcaster", "v"]

POST/graph/neighbors/engagement/handles

Query parameters

Body

application/json

itemsstring

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('/graph/neighbors/engagement/handles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Get Neighbors Following For Handles

Given a list of input handles, return a list of handles that the input handles are following.

We do a BFS traversal of the social follower graph upto k degrees and terminate traversal when limit is reached.

Example: ["farcaster.eth", "varunsrin.eth", "farcaster", "v"]

POST/graph/neighbors/following/handles

Query parameters

Body

application/json

itemsstring

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('/graph/neighbors/following/handles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Get Neighbors Engagement For Fids

Given a list of input fids, return a list of fids that the input fids have engaged with.

We do a BFS traversal of the social engagement graph upto k degrees and terminate traversal when limit is reached.

Example: [1, 2]

POST/graph/neighbors/engagement/fids

Query parameters

Body

application/json

itemsinteger

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('/graph/neighbors/engagement/fids', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([]),
});
const data = await response.json();

Get Neighbors Following For Fids

Given a list of input fids, return a list of fids that the input fids are following.

We do a BFS traversal of the social follower graph upto k degrees and terminate traversal when limit is reached.

Example: [1, 2]

POST/graph/neighbors/following/fids

Query parameters

Body

application/json

itemsinteger

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('/graph/neighbors/following/fids', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([]),
});
const data = await response.json();