swap.quickswap.v1.QuickSwapBrokerService
GetVault
GetVault returns one affiliate vault. Errors: - NOT_FOUND: BROKER_NOT_FOUND or VAULT_NOT_FOUND.
Method
POST
Path
swap.quickswap.v1.QuickSwapBrokerService/GetVault
Service
swap.quickswap.v1.QuickSwapBrokerService
Visibility
Authentication
Session token
MFA Requirement
Not required
POST
swap.quickswap.v1.QuickSwapBrokerService/GetVault Request
Testnet
curl --request POST \ \
--url 'https://api.testnet.polyester.com/swap.quickswap.v1.QuickSwapBrokerService/GetVault' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"accountId": "7563897446546",
"broker": "value"
}'Responses
{
"vault": {
"accountId": "7563897446546",
"createdAt": "2025-01-01T00:00:00Z",
"label": "Name Of My Subaccount",
"status": "VAULT_ACTIVE",
"updatedAt": "2025-01-01T00:00:00Z"
}
}Request
swap.quickswap.v1.GetVaultRequestResponse
swap.quickswap.v1.GetVaultResponse broker string
Broker name. A broker API key may name only its own broker.
accountId string (fixed64)
Public sub-account ID of the vault.
5 fields
accountId string (fixed64)
Public sub-account ID of the vault; name it in AffiliateShare.account_id.
label string
Broker-chosen label, unique per broker.
status enum
Whether new QuickSwaps can name the vault.
VAULT_ACTIVE VAULT_DISABLED
createdAt string (date-time)
When the vault was created.
updatedAt string (date-time)
When the vault was last changed.
| 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. |