Sign in
Stablecoin

Get orders summary for enterprise

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.

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

Path parameters

enterpriseIdstring required
Example:67bc4ae090e8af8f9b412d3d67e85252

Enterprise id

Query parameters

string[]
OR
'gousd' | 'usd1' | 'sofid' | 'cusd' | 'fyusd' | 'qxmp' | 'scaasacme'

Stablecoin name(s) to filter across all chains

chainstring
Example:hteth

Blockchain network identifier to filter summary

string[]
OR
'created' | 'pending' | 'fulfilled' | 'pendingApproval' | 'rejected'

Order processing status(es) to filter summary - accepts only user-facing statuses

groupBy'hour' | 'day' | 'week' | 'month' | 'year'
Example:month

Time period grouping for time-series data. When provided, returns timeSeries array in response.

fromDatestring date-time
Example:2024-01-01T00:00:00.000Z

Start date for time-series data (inclusive). Defaults to 1 year ago if groupBy is provided.

toDatestring date-time
Example:2024-12-31T23:59:59.999Z

End date for time-series data (inclusive). Defaults to current timestamp if groupBy is provided.

Response

OK

byAssetobject required

Breakdown by individual asset keyed by token identifier

Example response

{
  "timeSeries": [
    {
      "period": "2024-01-01T00:00:00.000Z",
      "mintAmount": "1000000000000000000000",
      "mintCount": 5,
      "burnAmount": "500000000000000000000",
      "burnCount": 3
    }
  ]
}

Changes

Changed in 1 of the 17 revisions of this API.4

  • 42597b3507554See the full diff
    • ○

      added the optional property byAsset/additionalProperties/burn/allOf[subschema #1: OrderTypeSummary]/byStatus/pendingApproval to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property byAsset/additionalProperties/burn/allOf[subschema #1: OrderTypeSummary]/byStatus/rejected to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property byAsset/additionalProperties/mint/allOf[subschema #1: OrderTypeSummary]/byStatus/pendingApproval to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property byAsset/additionalProperties/mint/allOf[subschema #1: OrderTypeSummary]/byStatus/rejected to the response with the 200 status

      response-optional-property-added