com.atiproto.repo.item.count

Count active (completed) items. If recordUri is provided, counts items for that record. If subject is provided, counts items received by that DID. If neither is provided, counts items sent by the authenticated user. Optionally filtered by a start/end datetime window. When the authenticated user is the subject/owner of the target, the response also includes the sum of amounts.

Repository @atiproto.com did:plc:4x5dcv6u4wlkjcssto7f22nu namespace authority
Details · query
Kindquery
Authorityitem.repo.atiproto.com
Indexed

Query

query · GET

Parameters

query string

endDate

string · datetime

Only count items completed at or before this timestamp

recordUri

string · at-uri

AT-URI of the record being tipped. Takes precedence over subject.

startDate

string · datetime

Only count items completed at or after this timestamp

subject

string · did

DID of the item recipient. Ignored if recordUri is provided. If omitted (and recordUri is omitted), the query counts items sent by the authenticated user.

Output

application/json

amount

integer

Sum of all item amounts in cents. Only returned when the authenticated user is the subject/owner of the target (or when counting their own sent items).

count

requiredinteger

Number of active (completed) items matching the filter

currency

string

Currency of the summed amount. Only returned when the authenticated user is the subject/owner of the target (or when counting their own sent items).

  • maxLength: 3

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • Count active subscriptions. If subject is provided, counts subscriptions received by that DID. If omitted, counts subscriptions the authenticated user has active (as the subscriber). Optionally filtered by a start/end datetime window (matching billingStartDate). When the authenticated user is the subject/owner of the target, the response also includes the sum of amounts.

  • List items sent by the authenticated user

  • Get a specific item sent by the authenticated user. Looks up by item record uri, subject (recipient) DID, or record uri. These are mutually exclusive and resolved in that order.

  • List items received by the authenticated user (items where the authed user is the recipient/subject). Includes items marked private, which are only stored in atiproto's database.

  • Validate that the authenticated user (as the sender) has completed item payment(s). Looks up by itemUri (a specific item record), recordUri (sums all items for that record), or subject (recipient DID). These are mutually exclusive and resolved in that order.