Skip to main content
GET
/
v1
/
participants
/
{id}
/
balances
/
lots
List participant lots
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/balances/lots \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "amount": "100.00",
      "asset_id": "550e8400-e29b-41d4-a716-446655440001",
      "created_at": "2024-01-15T10:30:00Z",
      "expires_at": "2025-12-31T23:59:59Z",
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "matures_at": "2024-06-01T00:00:00Z",
      "reference_id": "auth_12345",
      "remaining": "75.50",
      "status": "AVAILABLE"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}
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

​
data
object[]

Data contains the list of items

​
pagination
object

Pagination contains cursor information for fetching more results