auth.v1.AddressBookService
ListAddressBooks
Method
POST
Path
auth.v1.AddressBookService/ListAddressBooks
Service
auth.v1.AddressBookService
Visibility
Authentication
Session token or API key
MFA Requirement
Not required
POST
auth.v1.AddressBookService/ListAddressBooks Request
Testnet
curl --request POST \ \
--url 'https://api.testnet.polyester.com/auth.v1.AddressBookService/ListAddressBooks' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{}'Responses
{
"books": [
{
"callerRole": "VIEWER",
"label": "Main Account",
"ownerUsername": "trader_alpha",
"scope": {
"rootAccountId": "7563897446546",
"scopeType": "SCOPE_ROOT",
"subaccountId": "6789012345678"
},
"smartAccountAddress": "0x2222222222222222222222222222222222222222"
}
]
}Request
auth.v1.ListAddressBooksRequestResponse
auth.v1.ListAddressBooksResponse 5 fields
3 fields
scopeType enum
Address-book scope type.
SCOPE_ROOT SCOPE_SUBACCOUNT
rootAccountId string (fixed64)
Root account that owns this address book.
subaccountId string (fixed64)
Subaccount for subaccount-scoped books. Empty for root account books.
callerRole enum
Caller role for this address book.
VIEWER TRADER LEVERAGED_TRADER TREASURY ADMIN OWNER
label string
Display label for the address book. Usually present for subaccounts.
ownerUsername string
Username of the root owner when available.
smartAccountAddress string
Smart account address associated with this account or subaccount.
| 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. |