Home Admin guide Platform API Methods for creating reports

Methods for creating reports

Similar endpoints may be used to access data presented on different Admin Panel pages. In such cases, the detail data is returned based on specific filter parameters supported for a request.

The following methods are used to access various user data:

POST[host]/back-api/reporting/reports/data/assets-and-balances

Get data about assets and balances

POST[host]/back-api/reporting/reports/data/users

Get user data

POST[host]/back-api/reporting/reports/data/users/balances

Get user balances

POST[host]/back-api/reporting/reports/data/users/logins

Get a log of user sessions

POST[host]/back-api/reporting/reports/data/commissions

Get summary data about commissions and PnL

POST[host]/back-api/reporting/reports/data/commissions/assets

Get commissions and PnL by assets

POST[host]/back-api/reporting/reports/data/commissions/users

Get commissions and PnL by users

POST[host]/back-api/reporting/reports/data/orders

Get order history

POST[host]/back-api/reporting/reports/data/orders/opened

Get open orders

POST[host]/back-api/reporting/reports/data/orders/transactions

Get a list of trades

POST[host]/back-api/reporting/reports/data/transfers

Get a list of transfers

Get data about assets and balances

Use this method to obtain information about user balances in specified assets.

Note

The balances are calculated only for users with the following roles: Trader, User and Market Maker.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • AssetId — an array of string values

  • AssetAmount — a value range

For details about these fields, see the response description below.

Sorting parameters:

To learn about sorting the response data, refer to Sorting.

POST[host]/back-api/reporting/reports/data/assets-and-balances

{
  "filters": [
    {
      "entryType": "Exact",
      "field": "AssetId",
      "values": ["btc", "usdt"],
      "exclude": false
    },
    {
      "entryType": "NumericRange",
      "field": "AssetAmount",
      "from": "10",
      "to": "20"
    }
  ],
  "sort": {
    "field": "Asset",
    "direction": "Desc"
  }
}

Response

The response includes the following data about each asset:

assetId string

The asset identifier.

assetName string

The asset name.

assetAmount string

The total available asset amount on user accounts.

assetAmountInRAT string

The total available asset amount on user accounts, in conversion to the platform root asset (such as USD).

assetAmountScale string

The number of decimal places displayed for asset amounts.

This value must be within 2—18 range.

rootAsset string

The platform root asset (such as USD).

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "AssetId",
      "values": ["btc", "usdt"],
      "exclude": false
    },
    {
      "entryType": "NumericRange",
      "field": "AssetAmount",
      "from": "10",
      "to": "20"
    }],
  "sort": {
    "field": "AssetId",
    "direction": "Desc"
  },
  "paging": {
    "page": 1,
    "per_page": 15,
    "total": 2950
  },
  "data": [
    {
      "assetId": "btc",
      "assetName": "Bitcoin",
      "assetAmount": "123",
      "assetAmountInRAT": "11122334",
      "assetAmountScale": "8",
      "rootAsset": "usd"
    },
    {
      "assetId": "eth",
      "assetName": "Ethereum",
      "assetAmount": "321",
      "assetAmountInRAT": "332244",
      "assetAmountScale": "8",
      "rootAsset": "usd"
    }
  ]
}

Get user data

Use this method to obtain a list of exchange users meeting custom criteria.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • Status — an array of string values

  • Roles — an array of string values

  • Email — an array of string values

  • CreatedAt — a value range

  • LastSignInDate — a value range

For details about these fields, see the response description below.

Sorting parameters:

To learn about sorting the response data, refer to Sorting.

POST[host]/back-api/reporting/reports/data/users

{
  "filters": [
    {
      "entryType": "Exact",
      "field": "Status",
      "values": ["Terminated"],
      "exclude": false
    },
    {
      "entryType": "Exact",
      "field": "Roles",
      "values": ["Trader"],
      "exclude": false
    },
    {
      "entryType": "Exact",
      "field": "Email",
      "values": ["fr@mailinator.com"],
      "exclude": false
    },
    {
      "entryType": "DateRange",
      "field": "CreatedAt",
      "from": "2022-01-01",
      "to": "2022-09-01"
    },
    {
      "entryType": "DateRange",
      "field": "LastSignInDate",
      "from": "2022-01-01",
      "to": "2022-09-01"
    }
  ],
  "sort": {
    "field": "CreatedAt",
    "direction": "Desc"
  }
}

Response

The response includes the following data about each user:

status string

The current user account status. Possible values:

  • Active

  • Frozen

  • Terminated

hasTradingApiKey boolean

If true, a user is provided the API keys and allowed to trade via API; otherwise, false.

userId string

The user identifier.

email string

The user email.

roles string

An array of string values identifying the user roles.

username string

The username.

createdAt string

The date and time when a user account was created.

totalBalanceInRAT string

The total balance on all trading accounts opened for a user, in conversion to the platform root asset (such as USD).

totalCommissionInRAT string

The total commissions paid by a user so far, in conversion to the platform root asset (such as USD).

lastSignInDate string

The date and time when a user last signed in to the exchange.

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "Status",
      "values": ["Terminated"],
      "exclude": false
    },
    {
      "entryType": "Exact",
      "field": "Roles",
      "values": ["Trader"],
      "exclude": false
    },
    {
      "entryType": "Exact",
      "field": "Email",
      "values": ["fr@mailinator.com"],
      "exclude": false
    },
    {
      "entryType": "DateRange",
      "field": "CreatedAt",
      "from": "2022-01-01",
      "to": "2022-09-01"
    },
    {
      "entryType": "DateRange",
      "field": "LastSignInDate",
      "from": "2022-01-01",
      "to": "2022-09-01"
    }
  ],
  "sort": {
    "field": "CreatedAt",
    "direction": "Desc"
  },
  "paging": {
    "page": 1,
    "per_page": 15,
    "total": 2950
  },
  "data": [
    {
      "status": "Terminated",
      "hasTradingApiKey": false,
      "userId": "10e25c72-9195-40d1-92fd-fb46f21cece5",
      "email": "fr@mailinator.com",
      "roles": [
        "Trader"
      ],
      "username": "12000000000000000fr",
      "createdAt": "2021-06-09T14:24:38.718846Z",
      "totalBalanceInRAT": "1234",
      "totalCommissionInRAT": "1234",
      "lastSignInDate": "2021-06-09T14:24:38.718846Z"
    }
  ]
}

Get user balances

Use this method to obtain detailed information about the balance on each of a user’s trading accounts.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameter is available for this request:

  • userId — an array of string values

POST[host]/back-api/reporting/reports/data/users/balances

{
  "filters": [
    {
    "entryType": "Exact",
    "field": "UserId",
    "values": ["a770e6a9-664a-4cf8-d83b-53484ff5a1d6"],
    "exclude": false
    }
  ]
}

Response

The response includes the following data about each user asset:

assetId string

The asset identifier.

assetName string

The asset name.

assetAmount string

The total asset amount on a user’s account, including both locked and available amounts.

lockedAssetAmount string

The asset amount that is currently locked on a user’s account.

availableAssetAmount string

The asset amount that is currently available on a user’s account.

lockedAssetAmountInRAT string

The asset amount that is currently locked on a user’s account, in conversion to the platform root asset (such as USD).

availableAssetAmountInRAT string

The asset amount that is currently available on a user’s account, in conversion to the platform root asset (such as USD).

assetAmountInRAT string

The total asset amount on a user’s account, including both locked and available amounts, in conversion to the platform root asset (such as USD).

rateToRootAsset string

The rate of an asset to the platform root asset, as of the time when each transaction with the asset was made.

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "UserId",
      "values": [
        "a770e6a9-664a-4cf8-d83b-53484ff5a1d6"
      ],
      "exclude": false
    }
  ],
  "paging": {
    "page": 1,
    "per_page": 15,
    "total": 2
  },
  "data": [
    {
      "assetId": "ada",
      "assetName": "ada",
      "assetAmount": "79999.09800",
      "lockedAssetAmount": "1",
      "availableAssetAmount": "79998.09800",
      "assetAmountInRAT": "28252.85584546",
      "lockedAssetAmountInRAT": "0.35316468",
      "availableAssetAmountInRAT": "28252.50268078",
      "rateToRootAsset": "0.35316468"
    },
    {
      "assetId": "bch",
      "assetName": "Bitcoin Cash",
      "assetAmount": "80000.001",
      "lockedAssetAmount": "0",
      "availableAssetAmount": "80000.001",
      "assetAmountInRAT": "8630223.89027780",
      "lockedAssetAmountInRAT": "0",
      "availableAssetAmountInRAT": "8630223.89027780",
      "rateToRootAsset": "107.87779728"
    }
  ]
}

Get a log of user sessions

Use this method to learn when a specified user has been signed in to the exchange.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • userId — an array of string values

POST[host]/back-api/reporting/reports/data/users/logins

{
  "filters": [
    {
    "entryType": "Exact",
    "field": "UserId",
    "values": ["a770e6a9-664a-4cf8-d83b-53484ff5a1d6"],
    "exclude": false
    }
  ]
}

Response

The response includes the following data about each user session:

userId string

The user identifier.

ip string

The IP address from which a user signed in to the exchange.

loginAt string

The date and time when a user signed in to the exchange.

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "UserId",
      "values": [
        "a770e6a9-664a-4cf8-d83b-53484ff5a1d6"
      ],
      "exclude": false
    }
  ],
  "paging": {
    "page": 1,
    "per_page": 15,
    "total": 37256
  },
  "data": [
    {
      "userId": "a770e6a9-664a-4cf8-d83b-53484ff5a1d6",
      "ip": "127.0.0.1",
      "loginAt": "2021-07-12T09:28:37.471005Z"
    },
    {
      "userId": "a770e6a9-664a-4cf8-d83b-53484ff5a1d6",
      "ip": "127.0.0.1",
      "loginAt": "2021-07-12T09:28:37.766392Z"
    },
    {
      "userId": "a770e6a9-664a-4cf8-d83b-53484ff5a1d6",
      "ip": "139.45.249.182",
      "loginAt": "2021-07-12T15:08:17.146538Z"
    }
  ]
}

Get summary data about commissions and PnL

Use this method to obtain summmary information about commissions paid by a specified user and their current PnL.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • userId — an array of string values

  • Email — an array of string values

POST[host]/back-api/reporting/reports/data/commissions

{
  "filters": [
    {
      "entryType": "Exact",
      "field": "UserId",
      "values": ["1fc47ca8-b710-01fa-8afb-072ca73471ec"],
      "exclude": false
    },
    {
      "entryType": "Exact",
      "field": "Email",
      "values": ["email@mail.com"],
      "exclude": false
    }
  ]
}

Response

The response includes the following summary data about a user:

totalAmountInRAT string

The total asset amount on user trading accounts, in conversion to the platform root asset (such as USD).

totalCommissionInRAT string

The total commission paid by a user, in conversion to the platform root asset (such as USD).

totalTradedVolumeInRAT string

The total volume traded by a user, in conversion to the platform root asset (such as USD).

realizedPnlInRAT string

The realized PnL calculated for a user, in the platform root asset (such as USD).

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "UserId",
      "values": ["1fc47ca8-b710-01fa-8afb-072ca73471ec"],
      "exclude": false
    },
    {
      "entryType": "Exact",
      "field": "Email",
      "values": ["email@mail.com"],
      "exclude": false
    }
  ],
  "paging": {
    "page": 1,
    "perPage": 15,
    "total": 1
  },
  "data": [
    {
      "totalAmountInRAT": "6607323398472258446.07157805",
      "totalCommissionInRAT": "33471058.42758149",
      "totalTradedVolumeInRAT": "14068669358.44684580",
      "realizedPnlInRAT": "-170036444651.30807845"
    }
  ]
}

Get commissions and PnL by assets

Use this method to obtain detailed information about commissions paid for a specified asset and its summary PnL.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • assetId — an array of string values

  • assetAmount — a value range

  • assetAmountInRAT — a value range

  • realizedPnlInRAT — a value range

  • totalAssetCommission — a value range

  • totalCommissionInRAT — a value range

  • totalTradedVolumeInRAT — a value range

  • unrealizedPnlInRAT — a value range

For details about these fields, see the response description below.

POST[host]/back-api/reporting/reports/data/commissions/assets

{
  "filters": [
    {
      "entryType": "Exact",
      "field": "AssetId",
      "values": ["btc"],
      "exclude": false
    }
  ]
}

Response

The response includes the following data about each asset:

assetId string

The asset identifier.

assetName string

The asset name.

assetAmount string

The total asset amount on user trading accounts.

totalAssetCommission string

The total commission paid for transactions with an asset.

assetAmountInRAT string

The total asset amount on user trading accounts, in conversion to the platform root asset (such as USD).

totalCommissionInRAT string

The total commission paid for transactions with an asset, in conversion to the platform root asset (such as USD).

totalTradedVolumeInRAT string

The total volume traded in an asset, in conversion to the platform root asset (such as USD).

realizedPnlInRAT string

The realized PnL calculated for trades with an asset, in the platform root asset (such as USD).

unrealizedPnlInRAT string

The unrealized PnL calculated for trades with an asset, in the platform root asset (such as USD).

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "UserId",
      "values": ["1fc47ca8-b710-01fa-8afb-072ca73471ec"],
      "exclude": false
    }
  ],
  "paging": {
    "page": 1,
    "per_page": 15,
    "total": 1
  },
  "data": [
    {
      "assetId": "eth",
      "assetName": "Ethereum",
      "assetAmount": "0.00000997",
      "totalAssetCommission": "0.00000002",
      "assetAmountInRAT": "0.00000402",
      "totalCommissionInRAT": "0.00000001",
      "totalTradedVolumeInRAT": "0.00000405",
      "realizedPnlInRAT": "0.00000000",
      "unrealizedPnlInRAT": "-0.00000999"
    },
    {
      "assetId": "btc",
      "assetName": "Bitcoin",
      "assetAmount": "5.97990000",
      "totalAssetCommission": "0.00000000",
      "assetAmountInRAT": "145883.35916789",
      "totalCommissionInRAT": "0",
      "totalTradedVolumeInRAT": "98560.73836924",
      "realizedPnlInRAT": "-25429.84982680",
      "unrealizedPnlInRAT": "-83995.99422230"
    }
  ]
}

Get commissions and PnL by users

Use this method to obtain detailed information about commissions paid by each exchange user and their current PnL.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • userId — an array of string values

  • feeGroupId — an array of string values

  • status — an array of string values

  • totalAmountInRAT — a value range

  • totalCommissionInRAT — a value range

  • totalTradedVolumeInRAT — a value range

  • realizedPnlInRAT — a value range

  • unrealizedPnlInRAT — a value range

For details about these fields, see the response description below.

POST[host]/back-api/reporting/reports/data/commissions/users

{
  "filters": [
    {
      "entryType": "Exact",
      "field": "status",
      "values": ["Active"],
      "exclude": false
    }
  ]
}

Response

The response includes the following data about each user:

userId string

The user identifier.

email string

The user email.

status string

The current user account status. Possible values:

  • Active

  • Frozen

  • Terminated

totalAmountInRAT string

The total asset amount on user trading accounts, in conversion to the platform root asset (such as USD).

totalCommissionInRAT string

The total commission paid by a user, in conversion to the platform root asset (such as USD).

totalTradedVolumeInRAT string

The total volume traded by a user, in conversion to the platform root asset (such as USD).

realizedPnlInRAT string

The realized PnL calculated for a user, in the platform root asset (such as USD).

unrealizedPnlInRAT string

The unrealized PnL calculated for a user, in the platform root asset (such as USD).

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "status",
      "values": ["Active"],
      "exclude": false
    }
  ],
  "paging": {
    "page": 1,
    "per_page": 15,
    "total": 1
  },
  "data": [
    {
      "userId": "df8030da-f62f-2517-58ae-153cba7df18c",
      "email": "2fa_email@mailinator.com",
      "status": "Active",
      "totalAmountInRAT": "689754.07723650",
      "totalCommissionInRAT": "0.00000000",
      "totalTradedVolumeInRAT": "0.00000000",
      "realizedPnlInRAT": "0.00000000",
      "unrealizedPnlInRAT": "-201709.59762000"
    },
    {
      "userId": "8b8aae38-7500-1c98-c110-5cf749ba3821",
      "email": "2fa_google@mailinator.com",
      "status": "Active",
      "totalAmountInRAT": "689754.07723650",
      "totalCommissionInRAT": "0.00000000",
      "totalTradedVolumeInRAT": "0.00000000",
      "realizedPnlInRAT": "0.00000000",
      "unrealizedPnlInRAT": "-201709.59762000"
    }
  ]
}

Get order history

Use this method to obtain a list of orders filtered based on the specified parameters.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • baseAmount — a value range

  • commissionAmount — a value range

  • commissionAssetId — an array of string values

  • commissionInRAT — a value range

  • createdAt — a value range

  • marketId — an array of string values

  • orderStatus — an array of string values

  • orderType — an array of string values

  • orderId — an array of string values

  • quoteAmount — a value range

  • side — an array of string values

  • userId — an array of string values

For details about these fields, see the response description below.

POST[host]/back-api/reporting/reports/data/orders

{
  "filters": [
    {
      "entryType": "Exact",
      "field": "UserId",
      "values": ["a770e6a9-664a-4cf8-d83b-53484ff5a1d6"],
      "exclude": false
    },
    {
      "entryType": "Exact",
      "field": "OrderStatus",
      "values": ["Completed", "Cancelled", "Reverted", "Rejected"],
      "exclude": false
    }
  ]
}

Response

The response includes the following data about each user order:

orderId string

The order identifier.

userId string

The user identifier.

userEmail string

The user email.

marketId string

The currency pair identifier (such as btc_usdt): {baseAsset}_{quoteAsset}.

side string

The order side: Buy or Sell.

orderType string

The order type. Possible values:

  • Market

  • Limit

  • MarketFOK

baseAmount string

The order amount, in the base asset.

quoteAmount string

The order amount, in the quote asset.

remainingAmount string

For partially filled orders, the amount which remains to be filled.

fillFactor string

For partially filled orders, the percentage by which an order is filled so far.

avgExecutionPrice string

The average price at which an order or its portion is filled by this time.

commissionAmount string

The commission paid for an order, in a specified asset.

commissionAssetId string

The identifier of an asset in which commission was paid.

commissionAssetName string

The name of an asset in which commission was paid.

commissionInRAT string

The commission paid for an order, in the platform root asset (such as USD).

orderStatus string

The order status. Possible values:

  • Completed

  • Cancelled

  • Reverted

  • Rejected

createdAt string

The date and time when an order was placed.

updatedAt string

The date and time when an order was last updated.

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "UserId",
      "values": [
        "a770e6a9-664a-4cf8-d83b-53484ff5a1d6"
      ],
      "exclude": false
    },
    {
      "entryType": "Exact",
      "field": "OrderStatus",
      "values": [
        "Completed",
        "Cancelled",
        "Reverted",
        "Rejected"
      ],
      "exclude": false
    }
  ],
  "paging": {
    "page": 1,
    "per_page": 15,
    "total": 1
  },
  "data": [
    {
      "orderId": "-5188146770730642212",
      "userId": "910debe4-af88-4645-8f65-f11e280d462b",
      "userEmail": "ashaparev+18112@b2broker.com",
      "marketId": "btc_usd",
      "side": "Buy",
      "orderType": "Market",
      "baseAmount": "0.55",
      "quoteAmount": "24750.00",
      "remainingAmount": "0",
      "fillFactor": "1",
      "avgExecutionPrice": "45000",
      "commissionAmount": "0.0275",
      "commissionAssetId": "btc",
      "commissionAssetName": "Bitcoin",
      "commissionInRAT": "6.248616000",
      "orderStatus": "Completed",
      "createdAt": "2022-11-18T12:22:40.802241Z",
      "updatedAt": "2022-11-18T12:22:40.811823Z"
    }
  ]
}

Get open orders

Use this method to obtain a list of open orders placed by a specified user.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • userId — an array of string values

  • createdAt — a value range

  • side — an array of string values

  • marketId — an array of string values

  • baseAmount — a value range

  • quoteAmount — a value range

  • limitPrice — a value range

  • filledAmount — a value range

  • remainingAmount — a value range

For details about these fields, see the response description below.

POST[host]/back-api/reporting/reports/data/orders/opened

{
  "filters": [
    {
    "entryType": "Exact",
    "field": "UserId",
    "values": ["a770e6a9-664a-4cf8-d83b-53484ff5a1d6"],
    "exclude": false
    }
  ]
}

Response

The response includes the following data about each open order:

orderId string

The order identifier.

marketId string

The currency pair identifier (such as btc_usdt): {baseAsset}_{quoteAsset}.

side string

The order side: Buy or Sell.

orderType string

The order type. Always Limit.

baseAmount string

The entire order amount requested when an order was placed, in the base asset.

quoteAmount string

The entire order amount requested when an order was placed, in the quote asset.

limitPrice string

For limit orders, the limit price specified for an order when it was placed.

filledAmount string

The amount in which the order is filled so far.

remainingAmount string

For partially filled orders, the amount which remains to be filled.

createdAt string

The date and time when an order was placed.

updatedAt string

The date and time when an order was last updated.

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "UserId",
      "values": [
        "676c7f42-7a55-494d-955d-6b7776b3c4de"
      ],
      "exclude": false
    }
  ],
  "paging": {
    "page": 1,
    "per_page": 15,
    "total": 1
  },
  "data": [
    {
      "orderId": "689286052",
      "marketId": "btc_usdt",
      "side": "Buy",
      "orderType": "Limit",
      "baseAmount": "0",
      "quoteAmount": "0",
      "limitPrice": "18000",
      "filledAmount": "0",
      "remainingAmount": "1",
      "createdAt": "2022-10-14T12:13:41.506945Z",
      "updatedAt": "2022-10-14T12:13:41.786041Z"
    },
    {
      "orderId": "689785841",
      "marketId": "btc_usdt",
      "side": "Sell",
      "orderType": "Limit",
      "baseAmount": "0",
      "quoteAmount": "0",
      "limitPrice": "23000",
      "filledAmount": "0",
      "remainingAmount": "1",
      "createdAt": "2022-10-14T12:15:19.751636Z",
      "updatedAt": "2022-10-14T12:15:19.790063Z"
    }
  ]
}

Get a list of trades

Use this method to obtain a list of trades meeting the specified criteria.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • orderId — an array of string values

  • commissionAssetId — an array of string values

  • createdAt — a value range

  • marketId — an array of string values

  • side — an array of string values

  • baseAmount — a value range

  • quoteAmount — a value range

  • commissionAmount — aa value range

  • avgExecutionPrice — a value range

The trades list must be filtered either by orderId or commissionAssetId.

For details about these fields, see the response description below.

POST[host]/back-api/reporting/reports/data/orders/transactions

{
  "filters": [
    {
      "entryType": "Exact",
      "field": "CommissionAssetId",
      "values": ["btc"],
      "exclude": false
    }
  ]
}

Response

The response includes the following data about each trade:

orderId string

The order identifier.

executionId string

The trade identifier.

userId string

The user identifier.

userEmail string

The user email.

userRoles array

An array of string values identifying the user roles.

marketId string

The currency pair identifier (such as btc_usdt): {baseAsset}_{quoteAsset}.

side string

The order side: Buy or Sell.

orderType string

The order type. Possible values:

  • Market

  • Limit

  • MarketFOK

baseAmount string

The order amount, in the base asset.

quoteAmount string

The order amount, in the quote asset.

orderStatus string

The order status. Possible values:

  • Completed

  • Cancelled

  • Reverted

  • Rejected

executedAt string

The date and time when a trade was executed.

createdAt string

The date and time when an order was placed.

commissionAmount string

The commission paid for a trade, in a specified asset.

commissionAssetId string

The identifier of an asset in which commission was paid.

commissionAssetName string

The name of an asset in which commission was paid.

commissionInRAT string

The commission paid for a trade, in the platform root asset (such as USD).

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "CommissionAssetId",
      "values": [
        "btc"
      ],
      "exclude": false
    }
  ],
  "paging": {
    "page": 1,
    "perPage": 15,
    "total": 1
  }
  "data": [
      {
        "orderId": "1495603614",
        "executionId": "2996455863",
        "userId": "26d5f1dc-4d5c-0116-235d-45d5d5c5af30",
        "userEmail": "copycat@mailinator.com",
        "userRoles": [
          "Bot"
        ],
        "marketId": "eur_usdt",
        "side": "Buy",
        "orderType": "Limit",
        "baseAmount": "60000",
        "quoteAmount": "58080.000",
        "orderStatus": "Cancelled",
        "executedAt": "2022-10-11T09:51:30.041107Z",
        "createdAt": "2022-10-11T09:51:27.755524Z",
        "commissionAmount": "0",
        "commissionAssetId": "eur",
        "commissionAssetName": "eur",
        "commissionInRAT": "0.000000"
      },
      {
        "orderId": "1495604216",
        "executionId": "2996455863",
        "userId": "c17d562b-b96c-4fa2-a0a9-efeb81143cac",
        "userEmail": "dshumakova+233332@b2broker.net",
        "userRoles": [
          "Trader"
        ],
        "marketId": "eur_usdt",
        "side": "Sell",
        "orderType": "Market",
        "baseAmount": "60000",
        "quoteAmount": "58080.000",
        "orderStatus": "Completed",
        "executedAt": "2022-10-11T09:51:30.041107Z",
        "createdAt": "2022-10-11T09:51:30.041107Z",
        "commissionAmount": "58.0800",
        "commissionAssetId": "usdt",
        "commissionAssetName": "Usdt",
        "commissionInRAT": "0.0562214400"
      }
  ]


}

Get a list of transfers

Use this method to obtain detailed information about transfers meeting the specified criteria.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Filter parameters:

The following filter parameters are available for this request:

  • userId — an array of string values

  • email — an array of string values

  • createdAt — a value range

  • type — an array of string values

  • assetId — an array of string values

  • assetAmountInRAT — a value range

  • status — an array of string values

For details about these fields, see the response description below.

POST[host]/back-api/reporting/reports/data/transfers

{
  "filters": [
    {
    "entryType": "Exact",
    "field": "UserId",
    "values": ["a770e6a9-664a-4cf8-d83b-53484ff5a1d6"],
    "exclude": false
    }
  ]
}

Response

The response includes the following data about each transfer made by a user:

userId string

The user identifier.

username string

The username.

email string

The user email.

roles array

An array of string values identifying the user roles.

id string

The transfer identifier.

assetId string

The asset identifier.

assetName string

The asset name.

type string

The transaction type: Deposit or Withdrawal.

status string

The transaction status. Possible values:

  • AwaitingConfirmation — the transfer request awaits confirmation

  • Pending — the transfer is being processed

  • Completed — transfer processing is complete, this is a final state

  • Failed — transfer processing failed, this is a final state

  • Cancelled — the transfer request was cancelled

assetAmount string

The amount transferred.

createdAt string

The date and time when a transfer request was made.

rateToRootAsset string

The rate of an asset to the platform root asset, as of the time when a transfer was made.

assetAmountInRAT string

The amount transferred, in the platform root asset (such as USD).

This amount is calculated based on the rateToRootAsset value.

externalId string

The transaction identifier assigned by an external platform.

RESPONSE EXAMPLE 
{
  "filters": [
    {
      "entryType": "Exact",
      "field": "UserId",
      "values": [
        "a770e6a9-664a-4cf8-d83b-53484ff5a1d6"
      ],
      "exclude": false
    }
  ],
  "paging": {
    "page": 1,
    "per_page": 15,
    "total": 1
  },
  "data": [
    {
      "userId": "a770e6a9-664a-4cf8-d83b-53484ff5a1d6",
      "userEmail": "admin@mailinator.com",
      "userRoles": [
        "Admin",
        "NoCommission"
      ],
      "id": "1",
      "assetId": "btc",
      "assetName": "Bitcoin",
      "type": "Deposit",
      "status": "Completed",
      "assetAmount": "10",
      "createdAt": "2021-07-12T08:47:28.287329Z",
      "rateToRootAsset": "34148.06931000",
      "assetAmountInRAT": "341480.69310000",
      "externalId": ""
    },
    {
      "userId": "a770e6a9-664a-4cf8-d83b-53484ff5a1d6",
      "userEmail": "admin@mailinator.com",
      "userRoles": [
        "Admin",
        "NoCommission"
      ],
      "id": "2",
      "assetId": "usdt",
      "assetName": "Usdt",
      "type": "Deposit",
      "status": "Completed",
      "assetAmount": "80000",
      "createdAt": "2021-07-12T08:47:28.287329Z",
      "rateToRootAsset": "1.00054946",
      "assetAmountInRAT": "80043.95680000",
      "externalId": ""
    }
  ]
}