swap.quickswap.v1.QuickSwapBrokerService

ListVaults

ListVaults lists the broker's affiliate vaults. Errors: - NOT_FOUND: BROKER_NOT_FOUND. - INVALID_ARGUMENT: a page_token from another broker or malformed.

Method

POST

Path

swap.quickswap.v1.QuickSwapBrokerService/ListVaults

Service

swap.quickswap.v1.QuickSwapBrokerService

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

POST

swap.quickswap.v1.QuickSwapBrokerService/ListVaults

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/swap.quickswap.v1.QuickSwapBrokerService/ListVaults' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "broker": "value",
  "limit": 100,
  "pageToken": "eyJvZmZzZXQiOjEwMH0"
}'

Responses

{
  "nextPageToken": "eyJvZmZzZXQiOjIwMH0",
  "vaults": [
    {
      "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.ListVaultsRequest

Response

swap.quickswap.v1.ListVaultsResponse

broker string /^[a-z0…0,62}$/

Broker name. A broker API key may name only its own broker.

limit integer (int32) ≤ 200

Maximum number of vaults to return; 0 means 100, at most 200.

pageToken string max 64 chars

Opaque keyset cursor from a previous next_page_token, exclusive, bound to the broker and ordered by ascending account_id. Empty for the first page.

5 fields

nextPageToken string

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

Possible errors: 5

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.