Volume

Returns the transactions volume breakdown of a client

get

Returns the volume breakdown of the transactions of a client. The summary is returned for the current month. The breakdown for each transaction path is returned for the current month and the current day. The volume is in US dollars. Two decimal places are allowed. The volume is divided according to the status of the transactions:

IDLE: transaction has been created and is waiting for initiation,
INITIATED: transaction has been initiated, it is in progress of resolution by Rialto,
COMPLETED: transaction has been completed.

Authorizations

Path parameters

clientIdstringrequired

The unique identifier of the client.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.rialtobridge.xyz/api/manager/v1/clients/{clientId}/transactions/volume' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY'

200

401

404

500

{
  "currentMonth": {
    "limit": 100000,
    "remaining": 12345.76,
    "idle": 3310.21,
    "initiated": 2000,
    "completed": 11925.81,
    "total": 17236.01
  },
  "paths": [
    {
      "transactionType": "OFFRAMP",
      "fiatFeeGroup": "USD",
      "blockchainFeeGroup": "USD_STABLECOIN",
      "currentMonth": {
        "idle": 1000,
        "initiated": 2000,
        "completed": 3000,
        "total": 6000
      },
      "currentDay": {
        "idle": 100,
        "initiated": 200,
        "completed": 300,
        "total": 600
      }
    },
    {
      "transactionType": "ONRAMP",
      "fiatFeeGroup": "G10",
      "blockchainFeeGroup": "EUR_STABLECOIN",
      "currentMonth": {
        "idle": 2200,
        "initiated": 0,
        "completed": 8500,
        "total": 10700
      },
      "currentDay": {
        "idle": 220,
        "initiated": 0,
        "completed": 850,
        "total": 1070
      }
    }
  ]
}

The transactions volume breakdown.