TESTNET
Connect

chain.withdraw.v1.AutoWithdrawService

ListAutoWithdrawRuns

List the account's auto-withdraw runs with their payouts, newest first. An API key needs READ_AUTO_WITHDRAW in its policy and reads only its own account. Both refusals answer PERMISSION_DENIED: a key whose policy lacks the action gets "api key policy does not allow READ_AUTO_WITHDRAW", and a key that names an account other than its own, such as a root-account key naming a subaccount, gets "api key target scope mismatch".

POST
chain.withdraw.v1.AutoWithdrawService/ListAutoWithdrawRuns

Request

Testnet 
curl --request POST \ \
  --url 'https://api.testnet.polyester.com/chain.withdraw.v1.AutoWithdrawService/ListAutoWithdrawRuns' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "limit": 100,
  "pageToken": "eyJvZmZzZXQiOjEwMH0",
  "subaccountId": "6789012345678"
}'

Responses

{
  "nextPageToken": "eyJvZmZzZXQiOjIwMH0",
  "runs": [
    {
      "createdAt": "2025-01-01T00:00:00Z",
      "finishedAt": "2025-01-01T00:00:00Z",
      "reason": "value",
      "ruleVersion": 1,
      "runSeq": "1",
      "scheduledFor": "2025-01-01T00:00:00Z",
      "state": "RUN_PLANNED",
      "steps": [
        {
          "amountE18": {
            "hi": "1",
            "lo": "1"
          },
          "assetId": 100,
          "availableE18": {
            "hi": "1",
            "lo": "1"
          },
          "destinationAddress": "0x3333333333333333333333333333333333333333",
          "destinationChainId": "1",
          "intentId": "9155001234567",
          "reason": "value",
          "state": "STEP_PENDING",
          "txHash": "0xabc123def4567890abc123def4567890abc123def4567890abc123def4567890",
          "valueUsdE18": {
            "hi": "1",
            "lo": "1"
          }
        }
      ]
    }
  ]
}
Request
chain.withdraw.v1.ListAutoWithdrawRunsRequest
Response
chain.withdraw.v1.ListAutoWithdrawRunsResponse
subaccountId string (fixed64)

Public subaccount ID; omit for the root account.

limit integer (int32) ≤ 100

Maximum number of runs to return: 0 means 20, at most 100.

pageToken string max 256 chars

Opaque, exclusive, keyset-backed cursor from a previous response, bound to the caller's account or subaccount and the newest-first run_seq order. Empty for the first page.

8 fields
nextPageToken string

Cursor for the next page. Empty when no more results exist.

Possible errors: 46
KeyHTTP statusConnect codeErrorWhen
account-shard-unavailable503unavailableAccount Shard UnavailableThe account shard cannot currently accept fund movement.
amount-below-minimum400invalid_argumentAmount Below MinimumThe withdraw amount is below the configured minimum including fees.
amount-exceeds-route-precision400invalid_argumentAmount Exceeds Route PrecisionThe withdraw amount has more decimal places than the destination network's token supports.
amount-exceeds-supply400invalid_argumentAmount Exceeds SupplyThe withdraw amount exceeds the available zipped-asset supply.
api-key-binding-invalid403permission_deniedAPI Key Binding InvalidAPI-key authorization binding verification failed.
api-key-binding-public-key-mismatch403permission_deniedAPI Key Binding Public Key MismatchThe API-key authorization binding does not match the configured public key.
api-key-binding-scope-mismatch403permission_deniedAPI Key Binding Scope MismatchThe API-key authorization binding does not cover the requested scope.
api-key-not-found403permission_deniedAPI Key Not FoundThe API key could not be resolved.
auth-authentication-required401unauthenticatedAuthentication RequiredAuthentication is required.
auth-session-kind-not-allowed403permission_deniedInteractive Session RequiredThis operation accepts only an interactive session; API keys are refused.
capital-view-unavailable503unavailableCapital View UnavailableThe authoritative capital view is not ready.
chain-metadata-unavailable503unavailableChain Metadata UnavailableRequired chain or contract metadata is unavailable.
conflict409abortedConflictThe request conflicts with existing state.
destination-validation-unavailable503unavailableDestination Validation UnavailableDestination validation is temporarily unavailable.
external-destination-not-whitelisted403permission_deniedExternal Destination Not WhitelistedThe external destination is not whitelisted.
failed-precondition400failed_preconditionFailed PreconditionA required withdraw precondition was not satisfied.
fee-unavailable503unavailableFee UnavailableRequired network fee data is unavailable.
funds-lock-conflict409abortedFunds Lock ConflictThe funds lock conflicts with an existing or finalized reservation.
idempotency-conflict409already_existsIdempotency ConflictThe idempotency key was reused with different request data.
insufficient-funds400failed_preconditionInsufficient FundsThe source account does not have enough available Trading balance.
internal-error500internalInternal ErrorThe withdraw failed because of an unexpected server error.
internal-recipient-not-whitelisted403permission_deniedInternal Recipient Not WhitelistedThe internal funding recipient is not whitelisted.
invalid-action400invalid_argumentInvalid Withdraw ActionThe withdraw action is invalid for this endpoint.
invalid-amount400invalid_argumentInvalid AmountThe withdraw amount is invalid.
invalid-auto-withdraw-schedule400invalid_argumentInvalid Auto-Withdraw ScheduleThe auto-withdraw schedule is invalid for its cadence.
invalid-destination-address400invalid_argumentInvalid Destination AddressThe destination address is invalid.
invalid-destination-chain400invalid_argumentInvalid Destination ChainThe destination chain is invalid.
invalid-request400invalid_argumentInvalid RequestThe request payload or one of its fields is invalid.
invalid-subaccount-id400invalid_argumentInvalid SubaccountThe selected subaccount identifier is invalid.
not-found404not_foundNot FoundThe requested resource was not found.
permission-denied403permission_deniedPermission DeniedThe caller is not permitted to perform this withdraw operation.
rate-limit-exceeded429resource_exhaustedRate Limit ExceededThe withdraw admission rate limit was exceeded.
service-unavailable503unavailableService UnavailableA required service is temporarily unavailable.
signature-required400invalid_argumentSignature RequiredA payload signature is required.
signature-scheme-unsupported400invalid_argumentSignature Scheme UnsupportedThe signature scheme is unsupported.
signer-wallet-invalid400invalid_argumentInvalid Signer WalletThe signer wallet is invalid.
source-smart-account-unavailable400failed_preconditionSource Smart Account UnavailableThe source smart-account address is unavailable.
step-up-unavailable503unavailableStep-Up UnavailableFresh step-up verification is temporarily unavailable.
subaccount-not-found404not_foundSubaccount Not FoundThe selected subaccount does not exist.
supply-unavailable503unavailableSupply UnavailableRequired zipped-asset supply data is unavailable.
unauthenticated401unauthenticatedUnauthenticatedAuthentication is required.
unsupported-asset400invalid_argumentUnsupported AssetThe requested asset or withdraw route is not supported.
unsupported-ledger400invalid_argumentUnsupported LedgerThe requested ledger is not supported for withdrawals.
wallet-binding-invalid403permission_deniedWallet Binding InvalidWallet authorization binding verification failed.
wallet-binding-scope-mismatch403permission_deniedWallet Binding Scope MismatchThe wallet authorization binding does not cover the requested scope.
wallet-binding-signer-mismatch403permission_deniedWallet Binding Signer MismatchThe wallet authorization binding does not match the signer.