Skip to content

com.atproto.repo.describeRepo

Lexicon Version: 1

Type: query

Get information about an account and repository, including the list of collections. Does not require auth.

Parameters:

NameTypeReq’dDescriptionConstraints
repostringThe handle or DID of the repo.Format: at-identifier
Output:
  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
handlestringFormat: handle
didstringFormat: did
didDocunknownThe complete DID document for this account.
collectionsArray of stringList of all the collections (NSIDs) for which this repo contains at least one record.
handleIsCorrectbooleanIndicates if handle is currently valid (resolves bi-directionally)

{
"lexicon": 1,
"id": "com.atproto.repo.describeRepo",
"defs": {
"main": {
"type": "query",
"description": "Get information about an account and repository, including the list of collections. Does not require auth.",
"parameters": {
"type": "params",
"required": [
"repo"
],
"properties": {
"repo": {
"type": "string",
"format": "at-identifier",
"description": "The handle or DID of the repo."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"handle",
"did",
"didDoc",
"collections",
"handleIsCorrect"
],
"properties": {
"handle": {
"type": "string",
"format": "handle"
},
"did": {
"type": "string",
"format": "did"
},
"didDoc": {
"type": "unknown",
"description": "The complete DID document for this account."
},
"collections": {
"type": "array",
"description": "List of all the collections (NSIDs) for which this repo contains at least one record.",
"items": {
"type": "string",
"format": "nsid"
}
},
"handleIsCorrect": {
"type": "boolean",
"description": "Indicates if handle is currently valid (resolves bi-directionally)"
}
}
}
}
}
}
}