app.bsky.graph.getSuggestedFollowsByActor
GET/xrpc/app.bsky.graph.getSuggestedFollowsByActor
This endpoint is part of the Bluesky application Lexicon APIs (app.bsky.*
). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.
To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.
Enumerates follows similar to a given account (actor). Expected use is to recommend additional accounts immediately after following one account.
Request
Query Parameters
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
- app.bsky.graph.defs.modlist
- app.bsky.graph.defs.curatelist
- app.bsky.graph.defs.referencelist
Array [
]
- app.bsky.graph.defs.modlist
- app.bsky.graph.defs.curatelist
- app.bsky.graph.defs.referencelist
Array [
]
Array [
Array [
]
]
Array [
]
]
suggestions
object[]
required
Possible values: <= 640 characters
Possible values: <= 2560 characters
associated
object
chat
object
Possible values: [all
, none
, following
]
viewer
object
Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.
mutedByList
object
Possible values: non-empty
and <= 64 characters
purpose
object
required
oneOf
string
string
string
labels
object[]
DID of the actor who created this label.
AT URI of the record, repository (account), or other resource that this label applies to.
Optionally, CID specifying the specific version of 'uri' resource this label applies to.
Possible values: <= 128 characters
The short string name of the value or type of this label.
If true, this is a negation label, overwriting a previous label.
Timestamp when this label was created.
Timestamp at which this label expires (no longer applies).
Signature of dag-cbor encoded label.
viewer
object
blockingByList
object
Possible values: non-empty
and <= 64 characters
purpose
object
required
oneOf
string
string
string
labels
object[]
DID of the actor who created this label.
AT URI of the record, repository (account), or other resource that this label applies to.
Optionally, CID specifying the specific version of 'uri' resource this label applies to.
Possible values: <= 128 characters
The short string name of the value or type of this label.
If true, this is a negation label, overwriting a previous label.
Timestamp when this label was created.
Timestamp at which this label expires (no longer applies).
Signature of dag-cbor encoded label.
viewer
object
knownFollowers
object
The subject's followers whom you also follow
followers
object[]
required
Possible values: < 5
Possible values: <= 640 characters
associated
object
chat
object
Possible values: [all
, none
, following
]
labels
object[]
DID of the actor who created this label.
AT URI of the record, repository (account), or other resource that this label applies to.
Optionally, CID specifying the specific version of 'uri' resource this label applies to.
Possible values: <= 128 characters
The short string name of the value or type of this label.
If true, this is a negation label, overwriting a previous label.
Timestamp when this label was created.
Timestamp at which this label expires (no longer applies).
Signature of dag-cbor encoded label.
labels
object[]
DID of the actor who created this label.
AT URI of the record, repository (account), or other resource that this label applies to.
Optionally, CID specifying the specific version of 'uri' resource this label applies to.
Possible values: <= 128 characters
The short string name of the value or type of this label.
If true, this is a negation label, overwriting a previous label.
Timestamp when this label was created.
Timestamp at which this label expires (no longer applies).
Signature of dag-cbor encoded label.
If true, response has fallen-back to generic results, and is not scoped using relativeToDid
{
"suggestions": [
{
"did": "string",
"handle": "string",
"displayName": "string",
"description": "string",
"avatar": "string",
"associated": {
"lists": 0,
"feedgens": 0,
"starterPacks": 0,
"labeler": true,
"chat": {
"allowIncoming": "all"
}
},
"indexedAt": "2024-11-07T00:27:30.470Z",
"createdAt": "2024-11-07T00:27:30.470Z",
"viewer": {
"muted": true,
"mutedByList": {
"uri": "string",
"cid": "string",
"name": "string",
"purpose": "string",
"avatar": "string",
"listItemCount": 0,
"labels": [
{
"ver": 0,
"src": "string",
"uri": "string",
"cid": "string",
"val": "string",
"neg": true,
"cts": "2024-11-07T00:27:30.470Z",
"exp": "2024-11-07T00:27:30.470Z",
"sig": "string"
}
],
"viewer": {
"muted": true,
"blocked": "string"
},
"indexedAt": "2024-11-07T00:27:30.470Z"
},
"blockedBy": true,
"blocking": "string",
"blockingByList": {
"uri": "string",
"cid": "string",
"name": "string",
"purpose": "string",
"avatar": "string",
"listItemCount": 0,
"labels": [
{
"ver": 0,
"src": "string",
"uri": "string",
"cid": "string",
"val": "string",
"neg": true,
"cts": "2024-11-07T00:27:30.470Z",
"exp": "2024-11-07T00:27:30.470Z",
"sig": "string"
}
],
"viewer": {
"muted": true,
"blocked": "string"
},
"indexedAt": "2024-11-07T00:27:30.470Z"
},
"following": "string",
"followedBy": "string",
"knownFollowers": {
"count": 0,
"followers": [
{
"did": "string",
"handle": "string",
"displayName": "string",
"avatar": "string",
"associated": {
"lists": 0,
"feedgens": 0,
"starterPacks": 0,
"labeler": true,
"chat": {
"allowIncoming": "all"
}
},
"labels": [
{
"ver": 0,
"src": "string",
"uri": "string",
"cid": "string",
"val": "string",
"neg": true,
"cts": "2024-11-07T00:27:30.470Z",
"exp": "2024-11-07T00:27:30.470Z",
"sig": "string"
}
],
"createdAt": "2024-11-07T00:27:30.470Z"
}
]
}
},
"labels": [
{
"ver": 0,
"src": "string",
"uri": "string",
"cid": "string",
"val": "string",
"neg": true,
"cts": "2024-11-07T00:27:30.471Z",
"exp": "2024-11-07T00:27:30.471Z",
"sig": "string"
}
]
}
],
"isFallback": true
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [InvalidRequest
, ExpiredToken
, InvalidToken
]
{
"error": "InvalidRequest",
"message": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
{
"message": "string"
}