AddressBookService
List Transfer Counterparties
List recent transfer counterparties, including destinations that are not saved in the address book.
Request
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/auth/transfer-counterparties?direction=DEPOSIT_FROM&kind=EXTERNAL_CHAIN&limit=100&subaccountId=6789012345678' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
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": "ROOT",
"subaccountId": "3AN28yugKY2"
},
"useCount": "1"
}
],
"truncated": false
}Optional transfer direction filter.
Optional destination type filter.
Maximum number of counterparties to return. Defaults to 200 when omitted; maximum is 200.
Optional subaccount scope. Omit to use the root account address book.
Stable public id of this transfer counterparty.
1Address-book scope type.
ROOTRoot account that owns this address book.
7563897446546Subaccount for subaccount-scoped books. Empty for root account books.
3AN28yugKY2Most recent transfer direction for this counterparty.
DEPOSIT_FROMCounterparty type.
EXTERNAL_CHAINWhether this counterparty is already saved in the address book.
falseSaved address book entry id when saved is true.
1Number of transfers observed for this counterparty.
1Time this counterparty was first observed, as a UTC timestamp.
2025-01-01T00:00:00ZTime this counterparty was last observed, as a UTC timestamp.
2025-01-01T00:00:00ZExternal network identifier for the destination address.
1Destination address on the selected external network.
0x3333333333333333333333333333333333333333Root 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.
false| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |