List participant lots
curl --request GET \
--url https://api.scrip.dev/v1/participants/{id}/balances/lots \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.scrip.dev/v1/participants/{id}/balances/lots"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.scrip.dev/v1/participants/{id}/balances/lots', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrip.dev/v1/participants/{id}/balances/lots",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scrip.dev/v1/participants/{id}/balances/lots"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/participants/{id}/balances/lots")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/participants/{id}/balances/lots")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"availability": {
"gross_available_lot_total": "20.00",
"ledger_available_balance": "5.00",
"overdraft_offset": "15.00",
"spendable_available": "5.00"
},
"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"
}
}{
"code": "bad_request",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Invalid request parameters"
}{
"code": "unauthorized",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Missing or invalid credentials"
}{
"code": "forbidden",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Insufficient permissions for this action"
}{
"code": "not_found",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Resource not found"
}{
"code": "internal_error",
"message": "An internal error occurred"
}Balances
List participant lots
List lots for a participant by asset. Only applicable to LOT inventory mode assets.
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>'import requests
url = "https://api.scrip.dev/v1/participants/{id}/balances/lots"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.scrip.dev/v1/participants/{id}/balances/lots', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrip.dev/v1/participants/{id}/balances/lots",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scrip.dev/v1/participants/{id}/balances/lots"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scrip.dev/v1/participants/{id}/balances/lots")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrip.dev/v1/participants/{id}/balances/lots")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"availability": {
"gross_available_lot_total": "20.00",
"ledger_available_balance": "5.00",
"overdraft_offset": "15.00",
"spendable_available": "5.00"
},
"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"
}
}{
"code": "bad_request",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Invalid request parameters"
}{
"code": "unauthorized",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Missing or invalid credentials"
}{
"code": "forbidden",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Insufficient permissions for this action"
}{
"code": "not_found",
"details": {
"expected": "<string>",
"field": "<string>",
"fields": [
{
"expected": "<unknown>",
"field": "<string>",
"message": "This field is required",
"reason": "required",
"received": "<string>"
}
],
"reason": "invalid",
"received": "<string>"
},
"message": "Resource not found"
}{
"code": "internal_error",
"message": "An internal error occurred"
}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 lotstatus:DEFERRED,AVAILABLE,HELD,CONSUMED, orEXPIREDreference_id: correlation ID linking this held lot to a hold operation, if setexpires_at: when this lot expires, if setmatures_at: when this lot becomes spendable, if set
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
ApiKeyAuthBearerAuth
API key passed in the X-API-Key header.
Path Parameters
Participant ID
Query Parameters
Program ID
Asset ID
Filter by status: AVAILABLE, HELD, DEFERRED, CONSUMED, EXPIRED
Filter lots expiring before this time (RFC 3339)
Filter lots expiring after this time (RFC 3339)
Filter lots by reference_id correlation key
Maximum number of results (default 50, max 200)
Required range:
x >= 1Pagination cursor from previous response