auth.v1.AddressBookService
ListTransferCounterparties
Request
curl --request POST \ \
--url 'https://api.testnet.polyester.com/auth.v1.AddressBookService/ListTransferCounterparties' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"direction": "DEPOSIT_FROM",
"kind": "EXTERNAL_CHAIN",
"limit": 100,
"subaccountId": "6789012345678"
}'Responses
{
"counterparties": [
{
"addressBookEntryId": "1",
"counterpartyId": "1",
"direction": "DEPOSIT_FROM",
"external": {
"address": "0x3333333333333333333333333333333333333333",
"polychainChainId": 1
},
"firstSeenAt": "2025-01-01T00:00:00Z",
"kind": "EXTERNAL_CHAIN",
"lastSeenAt": "2025-01-01T00:00:00Z",
"saved": false,
"scope": {
"rootAccountId": "7563897446546",
"scopeType": "SCOPE_ROOT",
"subaccountId": "6789012345678"
},
"useCount": "1"
}
],
"truncated": false
}auth.v1.ListTransferCounterpartiesRequestauth.v1.ListTransferCounterpartiesResponseOptional subaccount scope. Omit to use the root account address book.
Optional transfer direction filter.
Optional destination type filter.
Maximum number of counterparties to return. Defaults to 200 when omitted; maximum is 200.
Stable public id of this transfer counterparty.
Address-book scope type.
Root account that owns this address book.
Subaccount for subaccount-scoped books. Empty for root account books.
Most recent transfer direction for this counterparty.
Counterparty type.
Whether this counterparty is already saved in the address book.
Saved address book entry id when saved is true.
Number of transfers observed for this counterparty.
Time this counterparty was first observed, as a UTC timestamp.
Time this counterparty was last observed, as a UTC timestamp.
External network identifier for the destination address.
Destination address on the selected external network: 1-256 characters, without whitespace or angle brackets.
Root account that owns the target internal account.
Target account or subaccount public id.
Whether target_account_id identifies a root account or a subaccount.
Smart account address for the internal transfer destination.
Username for the destination root account, when available.
Label for the destination subaccount, when the destination is a subaccount.
True when more matching counterparties exist than were returned. This bounded view does not provide continuation.
| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |