package bsky
Get desktop application:
View/edit binary Protocol Buffers messages
service Service
bsky.proto:1168Read Path
rpc GetBlockRecords (, )
bsky.proto:1174Records
message
bsky.proto:22repeated string uris = 1
message
bsky.proto:26repeated records = 1
message
bsky.proto:30repeated string uris = 1
message
bsky.proto:34repeated records = 1
rpc GetFollowRecords (, )
bsky.proto:1176message
bsky.proto:38repeated string uris = 1
message
bsky.proto:42repeated records = 1
rpc GetLikeRecords (, )
bsky.proto:1177message
bsky.proto:46repeated string uris = 1
message
bsky.proto:50repeated records = 1
rpc GetListBlockRecords (, )
bsky.proto:1178message
bsky.proto:54repeated string uris = 1
message
bsky.proto:58repeated records = 1
rpc GetListItemRecords (, )
bsky.proto:1179message
bsky.proto:62repeated string uris = 1
message
bsky.proto:66repeated records = 1
rpc GetListRecords (, )
bsky.proto:1180message
bsky.proto:70repeated string uris = 1
message
bsky.proto:74repeated records = 1
rpc GetPostRecords (, )
bsky.proto:1181message
bsky.proto:88repeated string uris = 1
message
bsky.proto:92repeated records = 1
repeated meta = 2
rpc GetProfileRecords (, )
bsky.proto:1182message
bsky.proto:97repeated string uris = 1
message
bsky.proto:101repeated records = 1
message
bsky.proto:105repeated string uris = 1
message
bsky.proto:109repeated records = 1
rpc GetStatusRecords (, )
bsky.proto:1184message
bsky.proto:113repeated string uris = 1
message
bsky.proto:117repeated records = 1
rpc GetRepostRecords (, )
bsky.proto:1185message
bsky.proto:121repeated string uris = 1
message
bsky.proto:125repeated records = 1
rpc GetThreadGateRecords (, )
bsky.proto:1186message
bsky.proto:129repeated string uris = 1
message
bsky.proto:133repeated records = 1
rpc GetPostgateRecords (, )
bsky.proto:1187message
bsky.proto:137repeated string uris = 1
message
bsky.proto:141repeated records = 1
rpc GetLabelerRecords (, )
bsky.proto:1188message
bsky.proto:145repeated string uris = 1
message
bsky.proto:149repeated records = 1
rpc GetStarterPackRecords (, )
bsky.proto:1189message
bsky.proto:160repeated string uris = 1
message
bsky.proto:164repeated records = 1
rpc GetActorFollowsActors (, )
bsky.proto:1192Follows
message
bsky.proto:174- Return follow uris where user A follows users B, C, D, … - E.g. for viewer state on `getProfiles`
string actor_did = 1
repeated string target_dids = 2
message
bsky.proto:179repeated string uris = 1
rpc GetFollowers (, )
bsky.proto:1193message
bsky.proto:185- Return follow uris of users who follows user A - For `getFollowers` list
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:197repeated followers = 1
string cursor = 2
rpc GetFollows (, )
bsky.proto:1194message
bsky.proto:204- Return follow uris of users A follows - For `getFollows` list
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:210repeated follows = 1
string cursor = 2
Verifications
message
bsky.proto:226repeated string uris = 1
message
bsky.proto:230repeated records = 1
message
bsky.proto:243string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:249repeated verifications = 1
string cursor = 2
message
bsky.proto:263string subject_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:269repeated verifications = 1
string cursor = 2
rpc GetLikesBySubject (, )
bsky.proto:1202Likes
message
bsky.proto:280- return like uris where subject uri is subject A - `getLikes` list for a post
optional subject = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:286repeated string uris = 1
string cursor = 2
message
bsky.proto:291optional subject = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:297repeated string uris = 1
string cursor = 2
message
bsky.proto:315- return like uris for user A on subject B, C, D... - viewer state on posts
string actor_did = 1
repeated refs = 2
message
bsky.proto:320repeated string uris = 1
rpc GetActorLikes (, )
bsky.proto:1205message
bsky.proto:326- return recent like uris for user A - `getActorLikes` list for a user
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:337repeated likes = 1
string cursor = 2
rpc GetRepostsBySubject (, )
bsky.proto:1208Reposts
message
bsky.proto:403- return repost uris where subject uri is subject A - `getReposts` list for a post
optional subject = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:409repeated string uris = 1
string cursor = 2
message
bsky.proto:416- return repost uris for user A on subject B, C, D... - viewer state on posts
string actor_did = 1
repeated refs = 2
message
bsky.proto:426repeated string uris = 1
rpc GetActorReposts (, )
bsky.proto:1210message
bsky.proto:432- return recent repost uris for user A - `getActorReposts` list for a user
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:438repeated string uris = 1
string cursor = 2
Quotes
message
bsky.proto:302optional subject = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:308repeated string uris = 1
string cursor = 2
rpc GetInteractionCounts (, )
bsky.proto:1216Interaction Counts
message
bsky.proto:345Interactions
repeated refs = 1
repeated string skip_cache_for_dids = 2
message
bsky.proto:350repeated int32 likes = 1
repeated int32 reposts = 2
repeated int32 replies = 3
repeated int32 quotes = 4
rpc GetCountsForUsers (, )
bsky.proto:1217message
bsky.proto:357repeated string dids = 1
message
bsky.proto:361repeated int32 posts = 1
repeated int32 reposts = 2
repeated int32 following = 3
repeated int32 followers = 4
repeated int32 lists = 5
repeated int32 feeds = 6
repeated int32 starter_packs = 7
rpc GetStarterPackCounts (, )
bsky.proto:1218message
bsky.proto:371repeated refs = 1
message
bsky.proto:375repeated int32 joined_week = 1
repeated int32 joined_all_time = 2
rpc GetListCounts (, )
bsky.proto:1219message
bsky.proto:380repeated refs = 1
message
bsky.proto:384repeated int32 list_items = 1
message
bsky.proto:388optional start = 1
optional end = 2
message
bsky.proto:393int32 count = 1
rpc GetActors (, )
bsky.proto:1223Profile
message
bsky.proto:450- return actor information for dids A, B, C… - profile hydration - should this include handles? apply repo takedown?
repeated string dids = 1
repeated string skip_cache_for_dids = 2
message
bsky.proto:477repeated actors = 1
rpc GetDidsByHandles (, )
bsky.proto:1224message
bsky.proto:484- return did for handle A - `resolveHandle` - answering queries where the query param is a handle
repeated string handles = 1
bool lookup_unidirectional = 2
message
bsky.proto:489repeated string dids = 1
rpc GetRelationships (, )
bsky.proto:1227Relationships
message
bsky.proto:500- return relationships between user A and users B, C, D... - profile hydration - block application
string actor_did = 1
repeated string target_dids = 2
message
bsky.proto:516repeated relationships = 1
rpc GetBlockExistence (, )
bsky.proto:1228message
bsky.proto:534repeated pairs = 1
message
bsky.proto:538repeated bool exists = 1
repeated blocks = 2
rpc GetActorLists (, )
bsky.proto:1231Lists
message
bsky.proto:590- return list of uris of lists created by A - `getLists`
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:596repeated string list_uris = 1
string cursor = 2
rpc GetListMembers (, )
bsky.proto:1232message
bsky.proto:555- Return dids of users in list A - E.g. to view items in one of your mute lists
string list_uri = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:561repeated listitems = 1
string cursor = 2
rpc GetListMembership (, )
bsky.proto:1233message
bsky.proto:568- Return list uris where user A in list B, C, D… - Used in thread reply gates
string actor_did = 1
repeated string list_uris = 2
message
bsky.proto:573repeated string listitem_uris = 1
rpc GetListCount (, )
bsky.proto:1234message
bsky.proto:579- Return number of items in list A - For aggregate
string list_uri = 1
message
bsky.proto:583int32 count = 1
rpc GetActorMutesActor (, )
bsky.proto:1237Mutes
message
bsky.proto:607- return boolean if user A has muted user B - hydrating mute state onto profiles
string actor_did = 1
string target_did = 2
message
bsky.proto:612bool muted = 1
rpc GetMutes (, )
bsky.proto:1238message
bsky.proto:618- return list of user dids of users who A mutes - `getMutes`
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:624repeated string dids = 1
string cursor = 2
Mutelists
message
bsky.proto:636- return list uri of *any* list through which user A has muted user B - hydrating mute state onto profiles - note: we only need *one* uri even if a user is muted by multiple lists
string actor_did = 1
string target_did = 2
message
bsky.proto:641string list_uri = 1
message
bsky.proto:647- return boolean if actor A has subscribed to mutelist B - list view hydration
string actor_did = 1
string list_uri = 2
message
bsky.proto:652bool subscribed = 1
message
bsky.proto:658- return list of list uris of mutelists that A subscribes to - `getListMutes`
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:664repeated string list_uris = 1
string cursor = 2
Thread Mutes
message
bsky.proto:673string actor_did = 1
repeated string thread_roots = 2
message
bsky.proto:678repeated bool muted = 1
rpc GetBidirectionalBlock (, )
bsky.proto:1249Blocks
message
bsky.proto:689- Return block uri if there is a block between users A & B (bidirectional) - hydrating (& actioning) block state on profiles - handling 3rd party blocks
string actor_did = 1
string target_did = 2
message
bsky.proto:694string block_uri = 1
rpc GetBlocks (, )
bsky.proto:1250message
bsky.proto:700- Return list of block uris and user dids of users who A blocks - `getBlocks`
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:706repeated string block_uris = 1
string cursor = 2
Blocklists
message
bsky.proto:718- Return list uri of ***any*** list through which users A & B have a block (bidirectional) - hydrating (& actioning) block state on profiles - handling 3rd party blocks
string actor_did = 1
string target_did = 2
message
bsky.proto:723string list_uri = 1
message
bsky.proto:729- return boolean if user A has subscribed to blocklist B - list view hydration
string actor_did = 1
string list_uri = 2
message
bsky.proto:734string listblock_uri = 1
message
bsky.proto:740- return list of list uris of Blockslists that A subscribes to - `getListBlocks`
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:746repeated string list_uris = 1
string cursor = 2
rpc GetNotifications (, )
bsky.proto:1258Notifications
message
bsky.proto:758- list recent notifications for a user - notifications should include a uri for the record that caused the notif & a “reason” for the notification (reply, like, quotepost, etc) - this should include both read & unread notifs
string actor_did = 1
int32 limit = 2
string cursor = 3
bool priority = 4
message
bsky.proto:774repeated notifications = 1
string cursor = 2
rpc GetNotificationSeen (, )
bsky.proto:1259message
bsky.proto:791- get a user’s “last seen time” - hydrating read state onto notifications
string actor_did = 1
bool priority = 2
message
bsky.proto:796optional timestamp = 1
message
bsky.proto:802- get a count of all unread notifications (notifications after `updateSeen`) - `getUnreadCount`
string actor_did = 1
bool priority = 2
message
bsky.proto:807int32 count = 1
message
bsky.proto:781- update a user’s “last seen time” - `updateSeen`
string actor_did = 1
optional timestamp = 2
bool priority = 3
message
bsky.proto:787(message has no fields)
rpc GetActorFeeds (, )
bsky.proto:1264FeedGenerators
message
bsky.proto:817- Return uris of feed generator records created by user A - `getActorFeeds`
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:823repeated string uris = 1
string cursor = 2
rpc GetSuggestedFeeds (, )
bsky.proto:1265message
bsky.proto:831- Returns a list of suggested feed generator uris for an actor, paginated - `getSuggestedFeeds` - This is currently just hardcoded in the Appview DB
string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:837repeated string uris = 1
string cursor = 2
message
bsky.proto:853- Returns feed generator validity and online status with uris A, B, C… - Not currently being used, but could be worhthwhile.
repeated string uris = 1
message
bsky.proto:857repeated string status = 1
rpc SearchFeedGenerators (, )
bsky.proto:1267message
bsky.proto:842string query = 1
int32 limit = 2
message
bsky.proto:847repeated string uris = 1
rpc GetAuthorFeed (, )
bsky.proto:1270Feeds
message
bsky.proto:876- Returns recent posts authored by a given DID, paginated - `getAuthorFeed` - Optionally: filter by if a post is/isn’t a reply and if a post has a media object in it
string actor_did = 1
int32 limit = 2
string cursor = 3
FeedType feed_type = 4
message
bsky.proto:897repeated items = 1
string cursor = 2
rpc GetTimeline (, )
bsky.proto:1271message
bsky.proto:904- Returns recent posts authored by users followed by a given DID, paginated - `getTimeline`
string actor_did = 1
int32 limit = 2
string cursor = 3
bool exclude_replies = 4
bool exclude_reposts = 5
bool exclude_quotes = 6
message
bsky.proto:913repeated items = 1
string cursor = 2
rpc GetListFeed (, )
bsky.proto:1272message
bsky.proto:931- Return recent post uris from users in list A - `getListFeed` - (This is essentially the same as `getTimeline` but instead of follows of a did, it is list items of a list)
string list_uri = 1
int32 limit = 2
string cursor = 3
bool exclude_replies = 4
bool exclude_reposts = 5
bool exclude_quotes = 6
message
bsky.proto:940repeated items = 1
string cursor = 2
rpc GetThread (, )
bsky.proto:1275Threads
message
bsky.proto:950Return posts uris of any replies N levels above or M levels below post A
string post_uri = 1
int32 above = 2
int32 below = 3
message
bsky.proto:956repeated string uris = 1
rpc SearchActors (, )
bsky.proto:1278Search
message
bsky.proto:966- Return DIDs of actors matching term, paginated - `searchActors` skeleton
string term = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:972repeated string dids = 1
string cursor = 2
rpc SearchPosts (, )
bsky.proto:1279message
bsky.proto:979- Return uris of posts matching term, paginated - `searchPosts` skeleton
string term = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:985repeated string uris = 1
string cursor = 2
rpc SearchStarterPacks (, )
bsky.proto:1280message
bsky.proto:992- Return uris of starter packs matching term, paginated - `searchStarterPacks` skeleton
string term = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:998repeated string uris = 1
string cursor = 2
rpc GetFollowSuggestions (, )
bsky.proto:1283Suggestions
message
bsky.proto:1009- Return DIDs of suggested follows for a user, excluding anyone they already follow - `getSuggestions`, `getSuggestedFollowsByActor`
string actor_did = 1
string relative_to_did = 2
int32 limit = 3
string cursor = 4
message
bsky.proto:1016repeated string dids = 1
string cursor = 2
rpc GetSuggestedEntities (, )
bsky.proto:1284message
bsky.proto:1028int32 limit = 1
string cursor = 2
message
bsky.proto:1033repeated entities = 1
string cursor = 2
rpc GetLabels (, )
bsky.proto:1287Labels
message
bsky.proto:1044- Get all labels on a subjects A, B, C (uri or did) issued by dids D, E, F… - label hydration on nearly every view
repeated string subjects = 1
repeated string issuers = 2
message
bsky.proto:1049repeated bytes labels = 1
rpc GetAllLabelers (, )
bsky.proto:1288message
bsky.proto:153(message has no fields)
message
bsky.proto:155repeated string uris = 1
repeated records = 2
rpc GetActorStarterPacks (, )
bsky.proto:1291Starter packs
message
bsky.proto:1057string actor_did = 1
int32 limit = 2
string cursor = 3
message
bsky.proto:1063repeated string uris = 1
string cursor = 2
rpc GetLatestRev (, )
bsky.proto:1294Sync
message
bsky.proto:1074- Latest repo rev of user w/ DID - Read-after-write header in`getProfile`, `getProfiles`, `getActorLikes`, `getAuthorFeed`, `getListFeed`, `getPostThread`, `getTimeline`. Could it be view dependent?
string actor_did = 1
message
bsky.proto:1078string rev = 1
rpc GetBlobTakedown (, )
bsky.proto:1297Moderation
message
bsky.proto:1111string did = 1
string cid = 2
message
bsky.proto:1116bool taken_down = 1
string takedown_ref = 2
rpc GetRecordTakedown (, )
bsky.proto:1298message
bsky.proto:1132string record_uri = 1
message
bsky.proto:1136bool taken_down = 1
string takedown_ref = 2
rpc GetActorTakedown (, )
bsky.proto:1299message
bsky.proto:1123string did = 1
message
bsky.proto:1127bool taken_down = 1
string takedown_ref = 2
rpc GetIdentityByDid (, )
bsky.proto:1302Identity
message
bsky.proto:1083string did = 1
message
bsky.proto:1086string did = 1
string handle = 2
bytes keys = 3
bytes services = 4
optional updated = 5
rpc GetIdentityByHandle (, )
bsky.proto:1303message
bsky.proto:1094string handle = 1
message
bsky.proto:1097string handle = 1
string did = 2
bytes keys = 3
bytes services = 4
optional updated = 5
rpc GetFollowsFollowing (, )
bsky.proto:1306Graph
message
bsky.proto:1147GetFollowsFollowing gets the list of DIDs that the actor follows that also follow the targets
string actor_did = 1
repeated string target_dids = 2
message
bsky.proto:1157repeated results = 1
rpc Ping (, )
bsky.proto:1309Ping
message
bsky.proto:1162Ping
(message has no fields)
message
bsky.proto:1163(message has no fields)
rpc TakedownBlob (, )
bsky.proto:1319Moderation
message
bsky.proto:1373string did = 1
string cid = 2
string ref = 3
optional seen = 4
message
bsky.proto:1380(message has no fields)
rpc TakedownRecord (, )
bsky.proto:1320message
bsky.proto:1390string record_uri = 1
string ref = 2
optional seen = 3
message
bsky.proto:1396(message has no fields)
rpc TakedownActor (, )
bsky.proto:1321message
bsky.proto:1356string did = 1
string ref = 2
optional seen = 3
message
bsky.proto:1362(message has no fields)
message
bsky.proto:1347string actor_did = 1
bool active = 2
string upstream_status = 3
message
bsky.proto:1353(message has no fields)
rpc UntakedownBlob (, )
bsky.proto:1324message
bsky.proto:1382string did = 1
string cid = 2
optional seen = 3
message
bsky.proto:1388(message has no fields)
rpc UntakedownRecord (, )
bsky.proto:1325message
bsky.proto:1399string record_uri = 1
optional seen = 2
message
bsky.proto:1404(message has no fields)
rpc UntakedownActor (, )
bsky.proto:1326message
bsky.proto:1365string did = 1
optional seen = 2
message
bsky.proto:1370(message has no fields)
rpc CreateActorMute (, )
bsky.proto:1329Ingestion
message
bsky.proto:1407string actor_did = 1
string subject_did = 2
message
bsky.proto:1412(message has no fields)
rpc DeleteActorMute (, )
bsky.proto:1330message
bsky.proto:1414string actor_did = 1
string subject_did = 2
message
bsky.proto:1419(message has no fields)
rpc ClearActorMutes (, )
bsky.proto:1331message
bsky.proto:1421string actor_did = 1
message
bsky.proto:1425(message has no fields)
message
bsky.proto:1427string actor_did = 1
string subject_uri = 2
message
bsky.proto:1432(message has no fields)
message
bsky.proto:1434string actor_did = 1
string subject_uri = 2
message
bsky.proto:1439(message has no fields)
message
bsky.proto:1441string actor_did = 1
message
bsky.proto:1445(message has no fields)
rpc CreateThreadMute (, )
bsky.proto:1337message
bsky.proto:1447string actor_did = 1
string thread_root = 2
message
bsky.proto:1452(message has no fields)
rpc DeleteThreadMute (, )
bsky.proto:1338message
bsky.proto:1454string actor_did = 1
string thread_root = 2
message
bsky.proto:1459(message has no fields)
rpc ClearThreadMutes (, )
bsky.proto:1339message
bsky.proto:1461string actor_did = 1
message
bsky.proto:1465(message has no fields)
message
bsky.proto:455Used in:
bool exists = 1
string handle = 2
optional profile = 3
bool taken_down = 4
string takedown_ref = 5
optional tombstoned_at = 6
bool labeler = 7
string allow_incoming_chats_from = 8
string upstream_status = 9
optional created_at = 10
bool priority_notifications = 11
double pagerank = 12
bool trusted_verifier = 13
map<string, > verified_by = 14
repeated string tags = 15
Tags being applied to the account itself
repeated string profile_tags = 16
Tags being applied to the profile record
optional status_record = 17
message
bsky.proto:883Used in:
string uri = 1
string cid = 2
string repost = 3
string repost_cid = 4
bool posts_and_author_threads = 5
bool posts_no_replies = 6
bool posts_with_media = 7
bool is_reply = 8
bool is_repost = 9
bool is_quote_post = 10
bool posts_with_video = 11
message
bsky.proto:527Used in:
string blocked_by = 1
string blocking = 2
string blocked_by_list = 3
string blocking_by_list = 4
Used in:
FEED_TYPE_UNSPECIFIED = 0
FEED_TYPE_POSTS_AND_AUTHOR_THREADS = 1
FEED_TYPE_POSTS_NO_REPLIES = 2
FEED_TYPE_POSTS_WITH_MEDIA = 3
FEED_TYPE_POSTS_WITH_VIDEO = 4
message
bsky.proto:191Used in: ,
string uri = 1
string actor_did = 2
string subject_did = 3
message
bsky.proto:1152Used in:
string target_did = 1
repeated string dids = 2
message
bsky.proto:332Used in:
string uri = 1
string subject = 2
message
bsky.proto:548Used in:
string uri = 1
string did = 2
message
bsky.proto:765Used in:
string recipient_did = 1
string uri = 2
string reason = 3
string reason_subject = 4
optional timestamp = 5
bool priority = 6
message
bsky.proto:78Used in:
bool violates_thread_gate = 1
bool has_media = 2
bool is_reply = 3
bool violates_embedding_rules = 4
bool has_post_gate = 5
bool has_thread_gate = 6
bool has_video = 7
message
bsky.proto:12Used in: , , , , , , , , , , , , , , , , , ,
bytes record = 1
string cid = 2
optional indexed_at = 4
bool taken_down = 5
optional created_at = 6
optional sorted_at = 7
string takedown_ref = 8
message
bsky.proto:421Used in: , , , , , , , ,
string uri = 1
string cid = 2
message
bsky.proto:522- return whether a block (bidrectionally and either direct or through a list) exists between two dids - enforcing 3rd party block violations
Used in:
string a = 1
string b = 2
message
bsky.proto:505Used in:
bool muted = 1
string muted_by_list = 2
string blocked_by = 3
string blocking = 4
string blocked_by_list = 5
string blocking_by_list = 6
string following = 7
string followed_by = 8
message
bsky.proto:1021Used in:
string tag = 1
string subject = 2
string subject_type = 3
int64 priority = 4
message
bsky.proto:918Used in: ,
string uri = 1
string cid = 2
string repost = 3
string repost_cid = 4
bool is_reply = 5
bool is_repost = 6
bool is_quote_post = 7
message
bsky.proto:234Used in:
string actor_did = 1
string rkey = 2
string subject_did = 3
optional created_at = 7
optional indexed_at = 8
optional sorted_at = 9
message
bsky.proto:219Used in:
string rkey = 1
string handle = 2
string display_name = 3
optional sorted_at = 4
message
bsky.proto:254Used in:
string actor_did = 1
string rkey = 2
string subject_did = 3
optional created_at = 7
optional indexed_at = 8
optional sorted_at = 9