Navigate...
Get Distribution
sdk.distributions.get(id)
Retrieve a single distribution by ID. Returns full details including current status, chain/token info, recipient and amount totals, and timestamps. Use this to check the state of a distribution or to poll for status changes after execution.
API key required to run methods
API Key *
Base URL
id
string
required
Distribution ID
Distribution ID
Returns
Distribution
Full distribution object
id
string
Unique distribution identifier
projectId
string
Parent project ID
name
string
Distribution name
status
string
DRAFT | PREPARED | PENDING | IN_PROGRESS | COMPLETED | PARTIALLY_COMPLETED | FAILED | CANCELLED
chainId
number
Target blockchain chain ID
tokenAddress
string
Token contract address
tokenSymbol
string
Token symbol (e.g. USDC)
totalRecipients
number | null
Number of recipients in the distribution
totalAmount
string | null
Total token amount to distribute (human-readable)
account
string | null
Sender wallet address
listId
string | null
Linked recipient list ID (if created from a list)
idempotencyKey
string | null
Idempotency key (if provided at creation)
feeData
DistributionFeeDataDto | null
Fee estimation: { estimatedGas, estimatedCost, gasPrice, maxFeePerGas, maxPriorityFeePerGas }
createdAt
string
ISO 8601 creation timestamp
updatedAt
string
ISO 8601 last update timestamp
executedAt
string | null
When execution started
completedAt
string | null
When distribution completed or failed
Errors
Invalid distribution id
The request is not authorized
You do not have permission to access this resource
Distribution not found
See Also
getStats()
Get batch-level completion counts for progress tracking
getTransactions()
View individual transaction batches and their on-chain hashes
cancel()
Cancel this distribution if not yet completed
Generated Code