QuickSwapBrokerService

List affiliate vaults

List the broker's affiliate vaults.

Method

GET

Path

/v1/quickswap/brokers/{broker}/vaults

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

GET

/v1/quickswap/brokers/{broker}/vaults

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/quickswap/brokers/value/vaults?limit=100' \
  --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

{
  "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"
    }
  ]
}

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

Broker name.

limit integer ≤ 200

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

pageToken string max 64 chars

Opaque keyset cursor from a previous nextPageToken, exclusive, bound to the broker and ordered by ascending account ID. Omit for the first page.

nextPageToken string

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

Example eyJvZmZzZXQiOjIwMH0

5 fields

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.