com.atproto.repo.listRecords

List a range of records in a repository, matching a specific collection. Does not require auth.

class atproto_client.models.com.atproto.repo.list_records.Params

Bases: ParamsModelBase

Parameters model for com.atproto.repo.listRecords.

field collection: Nsid [Required]

The NSID of the record type.

field cursor: str | None = None

Cursor.

field limit: int | None = None

The number of records to return.

Constraints:

  • ge = 1

  • le = 100

field repo: AtIdentifier [Required]

The handle or DID of the repo.

field reverse: bool | None = None

Flag to reverse the order of the returned records.

class atproto_client.models.com.atproto.repo.list_records.ParamsDict

Bases: TypedDict

collection: Nsid

The NSID of the record type.

repo: AtIdentifier

The handle or DID of the repo.

cursor: NotRequired[str | None]

Cursor.

limit: NotRequired[int | None]

The number of records to return.

reverse: NotRequired[bool | None]

Flag to reverse the order of the returned records.

class atproto_client.models.com.atproto.repo.list_records.Response

Bases: ResponseModelBase

Output data model for com.atproto.repo.listRecords.

field cursor: str | None = None

Cursor.

field records: List[models.ComAtprotoRepoListRecords.Record] [Required]

Records.

class atproto_client.models.com.atproto.repo.list_records.Record

Bases: ModelBase

Definition model for com.atproto.repo.listRecords.

field cid: Cid [Required]

Cid.

field uri: AtUri [Required]

Uri.

field value: UnknownType [Required]

Value.

Constraints:

  • __module__ = atproto_client.models.unknown_union

  • __firstlineno__ = 72

  • __doc__ = Annotation for lexicon unknown fields: any registered record type, else DotDict. Record types are looked up in the runtime registry rather than in a union fixed at import time, so a record defined by a package generated from custom lexicons is decoded to its own model.

  • __get_pydantic_core_schema__ = <bound method UnknownRecordFallback.__get_pydantic_core_schema__ of <class ‘atproto_client.models.unknown_union.UnknownRecordFallback’>>

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘atproto_client.models.unknown_union’, ‘__firstlineno__’: 72, ‘__doc__’: ‘Annotation for lexicon unknown fields: any registered record type, else DotDict.nnRecord types are looked up in the runtime registry rather than in a union fixed at import time,nso a record defined by a package generated from custom lexicons is decoded to its own model.n’, ‘__get_pydantic_core_schema__’: <classmethod(<function UnknownRecordFallback.__get_pydantic_core_schema__ at 0x786e5ef30d60>)>, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘UnknownRecordFallback’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘UnknownRecordFallback’ objects>