REST API›Stablecoin

GET

Get orders summary for issuer (across all enterprises)

Returns aggregated order amounts and counts for all assets issued by the authenticated enterprise, aggregated across all enterprises that hold those assets. Amounts are returned as strings in lowest denomination (no decimal formatting). By default, includes all non-failed orders (created, pending, and fulfilled). Use the optional status parameter to filter by specific order statuses.

Query Params

  • stablecoin array of strings or string
    Stablecoin name(s) to filter across all chains

    ONE OF

    array of string enums
  • chain string
    Blockchain network identifier to filter summary

    at least 1 characters

  • status array of strings or string
    Order processing status(es) to filter summary - accepts only user-facing statuses

    ONE OF

    array of string enums
  • groupBy string enum
    Time period grouping for time-series data. When provided, returns timeSeries array in response.
    hourdayweekmonthyear
  • fromDate string date-time
    Start date for time-series data (inclusive). Defaults to 1 year ago if groupBy is provided.
  • toDate string date-time
    End date for time-series data (inclusive). Defaults to current timestamp if groupBy is provided.
  • clientEnterpriseId string or array of strings
    Enterprise ID(s) of the client enterprise(s) to filter summary data

Responses

200
OK

Response Body

object

  • byAsset map of objects required
    Breakdown by individual asset keyed by token identifier
    byAsset object
    • <key> object
      value object
      • chain string required
        Chain identifier
      • decimals number required
        Token decimals
      • mint object required
        Mint order summary
        mint object
        • amount string required
          Total amount in lowest denomination
        • count number required
          Total number of orders
        • byStatus object required
          Breakdown by order status (only includes statuses with data)
          byStatus object
          • created object
            created object
            • count number required
              Number of orders in this status
            • amount string required
              Total amount in lowest denomination
          • pending object
            pending object
            • Same shape as OrderStatusBreakdown.
          • fulfilled object
            fulfilled object
            • Same shape as OrderStatusBreakdown.
      • burn object required
        Burn order summary
        burn object
        • amount string required
          Total amount in lowest denomination
        • count number required
          Total number of orders
        • byStatus object required
          Breakdown by order status (only includes statuses with data)
          byStatus object
          • created object
            created object
            • Same shape as OrderStatusBreakdown.
          • pending object
            pending object
            • Same shape as OrderStatusBreakdown.
          • fulfilled object
            fulfilled object
            • Same shape as OrderStatusBreakdown.
  • timeSeries array of objects
    timeSeries object
    • period string required
      ISO8601 date string representing start of period
    • mintAmount string required
      Total mint amount in lowest denomination
    • mintCount number required
      Number of mint orders
    • burnAmount string required
      Total burn/redeem amount in lowest denomination
    • burnCount number required
      Number of burn/redeem orders
400
Bad Request
No response body
404
Not Found
No response body
500
Internal Server Error
No response body