Ctrl+K

Get orders summary for enterprise

get/api/stablecoin/v1/enterprise/{enterpriseId}/orders-summary

Returns aggregated order amounts and counts by asset. 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.

Path Parameters

  • enterpriseIdstringRequired
    Enterprise id
    Example: 67bc4ae090e8af8f9b412d3d67e85252
    Min length: >= 1 characters

Query Parameters

  • stablecoinarray or string
    Stablecoin name(s) to filter across all chains
    Example: usd1
  • chainstring
    Blockchain network identifier to filter summary
    Example: hteth
    Min length: >= 1 characters
  • statusarray or string
    Order processing status(es) to filter summary - accepts only user-facing statuses
    Example: created
  • groupBystring
    Time period grouping for time-series data. When provided, returns timeSeries array in response.
    Example: month
    Enum: hour day week month year
  • fromDatestring<date-time>
    Start date for time-series data (inclusive). Defaults to 1 year ago if groupBy is provided.
    Example: 2024-01-01T00:00:00.000Z
  • toDatestring<date-time>
    End date for time-series data (inclusive). Defaults to current timestamp if groupBy is provided.
    Example: 2024-12-31T23:59:59.999Z

200 Response

byAsset dictionary<string, object> required
Breakdown by individual asset keyed by token identifier
object
timeSeries array[object]
Time-series data points. Only present when groupBy parameter is provided.
period string required
ISO8601 date string representing start of period
Example: 2024-01-01T00:00:00.000Z
mintAmount string required
Total mint amount in lowest denomination
Example: 1000000000000000000000
mintCount number required
Number of mint orders
Example: 5
burnAmount string required
Total burn/redeem amount in lowest denomination
Example: 500000000000000000000
burnCount number required
Number of burn/redeem orders
Example: 3

400 Response

404 Response

500 Response