QuickSwapBrokerService

Get broker

Get the broker, its limits and current usage, and the caller's role.

Method

GET

Path

/v1/quickswap/brokers/{broker}

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

GET

/v1/quickswap/brokers/{broker}

Request

Testnet

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

{
  "broker": {
    "createRps": 1,
    "defaultVaultAccountId": "7563897446546",
    "displayName": "value",
    "enabled": false,
    "maxAffiliateVaults": 1,
    "maxCreatesPerHour": 1,
    "maxUnfundedAddresses": 1,
    "name": "value",
    "quoteRps": 1,
    "readRps": 1,
    "role": "OWNER",
    "rootAccountId": "7563897446546"
  },
  "usage": {
    "affiliateVaults": 1,
    "createsLastHour": 1,
    "unfundedAddresses": 1
  }
}

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

Broker name.

12 fields

createRps integer (int32)

Create requests per second allowed for each API key of the broker, which is also the burst. Over the rate, CreateQuickSwap fails with RESOURCE_EXHAUSTED / BROKER_LIMIT and a Retry-After header.

Example 1

defaultVaultAccountId string /^[0-9]+$/

Public sub-account ID of the default vault, credited with broker fees that name no affiliate.

Example 7563897446546

displayName string

Display name.

Example value

enabled boolean

Whether the broker may quote and create QuickSwaps. A disabled broker keeps reads, vaults, keys and members.

Example false

maxAffiliateVaults integer (int32)

Affiliate vaults the broker may create, active and disabled together. At the limit, CreateAffiliateVault fails with RESOURCE_EXHAUSTED / BROKER_LIMIT.

Example 1

maxCreatesPerHour integer (int32)

Quick Swaps the broker may create in any rolling hour. At the limit, CreateQuickSwap fails with RESOURCE_EXHAUSTED / BROKER_LIMIT until the oldest create of the hour is more than an hour old.

Example 1

maxUnfundedAddresses integer (int32)

Unfunded Quick Swaps the broker may hold at once: Quick Swaps whose deposit address is being issued or is still awaiting a deposit within its funding window. At the limit, CreateQuickSwap fails with RESOURCE_EXHAUSTED / BROKER_LIMIT; a deposit or the end of a funding window frees a slot.

Example 1

name string

Broker name: the immutable identifier used in every request.

Example value

quoteRps integer (int32)

Quote requests per second allowed for each API key of the broker, which is also the burst. Over the rate, QuoteQuickSwap fails with RESOURCE_EXHAUSTED / BROKER_LIMIT and a Retry-After header.

Example 1

readRps integer (int32)

Read requests per second allowed for each API key of the broker, which is also the burst. GetQuickSwap and every QuickSwapBrokerService call by an API key count as reads. Over the rate, the call fails with RESOURCE_EXHAUSTED / BROKER_LIMIT and a Retry-After header.

Example 1

role enum

The caller's role; BROKER_ROLE_UNSPECIFIED for a broker API key.

OWNER ADMIN FINANCE AFFILIATE_MANAGER VIEWER

Example OWNER

rootAccountId string /^[0-9]+$/

Public account ID of the broker's root account.

Example 7563897446546

3 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.

GET

/v1/quickswap/brokers/{broker}

Request

Testnet

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

{
  "broker": {
    "createRps": 1,
    "defaultVaultAccountId": "7563897446546",
    "displayName": "value",
    "enabled": false,
    "maxAffiliateVaults": 1,
    "maxCreatesPerHour": 1,
    "maxUnfundedAddresses": 1,
    "name": "value",
    "quoteRps": 1,
    "readRps": 1,
    "role": "OWNER",
    "rootAccountId": "7563897446546"
  },
  "usage": {
    "affiliateVaults": 1,
    "createsLastHour": 1,
    "unfundedAddresses": 1
  }
}