QuickSwapBrokerService

Get broker stats

Read the broker's QuickSwaps by status, deposits, payouts and fees in a window, per day or month.

Method

GET

Path

/v1/quickswap/brokers/{broker}/stats

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

GET

/v1/quickswap/brokers/{broker}/stats

Request

Testnet

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

{
  "periods": [
    {
      "createdCount": "1",
      "delivered": [
        {
          "amount": {
            "baseUnits": "value",
            "decimals": 36
          },
          "assetId": 100
        }
      ],
      "deposited": [
        {
          "amount": {
            "baseUnits": "value",
            "decimals": 36
          },
          "assetId": 100
        }
      ],
      "fees": [
        {
          "affiliateFee": {
            "baseUnits": "value",
            "decimals": 36
          },
          "assetId": 100,
          "brokerFee": {
            "baseUnits": "value",
            "decimals": 36
          },
          "serviceFee": {
            "baseUnits": "value",
            "decimals": 36
          }
        }
      ],
      "periodStart": "2025-01-01T00:00:00Z",
      "statuses": [
        {
          "count": "1",
          "status": "ALLOCATING"
        }
      ]
    }
  ]
}

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

Broker name.

endTime string (date-time)

End of the window, an RFC 3339 time, exclusive, at most 366 days after startTime.

groupBy enum must be defined value

The UTC period to group by.

startTime string (date-time)

Start of the window, an RFC 3339 time, inclusive.

6 fields

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

QuickSwaps created in the period, inside the window.

Example 1

2 fields

4 fields

2 fields

assetId integer (int32)

Asset charged, as an AssetConfig.ledger_id from GET /v1/chain/deposit-withdraw/config.

Example 100

2 fields

periodStart string (date-time)

Start of the UTC day or month.

Example 2025-01-01T00:00:00Z

2 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}/stats

Request

Testnet

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

{
  "periods": [
    {
      "createdCount": "1",
      "delivered": [
        {
          "amount": {
            "baseUnits": "value",
            "decimals": 36
          },
          "assetId": 100
        }
      ],
      "deposited": [
        {
          "amount": {
            "baseUnits": "value",
            "decimals": 36
          },
          "assetId": 100
        }
      ],
      "fees": [
        {
          "affiliateFee": {
            "baseUnits": "value",
            "decimals": 36
          },
          "assetId": 100,
          "brokerFee": {
            "baseUnits": "value",
            "decimals": 36
          },
          "serviceFee": {
            "baseUnits": "value",
            "decimals": 36
          }
        }
      ],
      "periodStart": "2025-01-01T00:00:00Z",
      "statuses": [
        {
          "count": "1",
          "status": "ALLOCATING"
        }
      ]
    }
  ]
}