Skip to main content
GET
List participant lots
Returns individual lots for a LOT mode asset belonging to a participant. Only applies to assets configured in LOT mode; for SIMPLE mode assets, use the balances endpoint instead. Each lot includes:
  • remaining: balance still available in this lot
  • status: DEFERRED, AVAILABLE, HELD, CONSUMED, or EXPIRED
  • reference_id: correlation ID linking this held lot to a hold operation, if set
  • expires_at: when this lot expires, if set
  • matures_at: when this lot becomes spendable, if set
Filter by status, expires_before, expires_after, and reference_id to find lots nearing expiration, isolate held lots, or identify lots belonging to a specific hold.
For usage patterns and examples, see the Balance Operations guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Participant ID

Query Parameters

program_id
string<uuid>

Program ID

asset_id
string<uuid>
required

Asset ID

status
string

Filter by status: AVAILABLE, HELD, DEFERRED, CONSUMED, EXPIRED

expires_before
string

Filter lots expiring before this time (RFC 3339)

expires_after
string

Filter lots expiring after this time (RFC 3339)

reference_id
string

Filter lots by reference_id correlation key

limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

Response

List of lots with asset-wide availability reconciliation

availability
object
data
object[]
pagination
object