Skip to content

API Reference / Purchases

Count purchases per status in a workspace

Returns the number of purchases in each status for the workspace under the same PurchaseFilter as ListPurchases. Drives the purchases list page status-tab counts without loading every purchase.

POST/contracts.v1.Contracts/CountPurchases

Request body

application/jsonRequired

Request for the number of purchases in each status in the caller's workspace, using the same filter as ListPurchases.

filter?PurchaseFilter

The same filter as ListPurchases, so status counts match the filtered list.

Show attributes
accountName?string

Exact Steam account name that executed the buy. Absent includes every account.

contractIds?array<string>

Only purchases attributed to one of these contracts. Empty includes every contract.

coveringSellingContractIds?array<string>

Only purchases whose bought item is held (arriving, in the inventory or listed) and covered now by one of these selling contracts, resolved as GetCoveringSellingContract resolves it, OR within the field. Empty includes every purchase. At most 200 ids.

createdBefore?string

Only purchases attributed before this time. Absent sets no upper bound.

Format"date-time"

createdFrom?string

Only purchases attributed at or after this time. The attribution time is used because purchased_at is unset while a purchase is pending. Absent sets no lower bound.

Format"date-time"

deliveryStatuses?array<string>

Customer-facing delivery states, OR within the field. Empty includes every state.

Value in"PURCHASE_DELIVERY_STATUS_PENDING""PURCHASE_DELIVERY_STATUS_DELIVERED""PURCHASE_DELIVERY_STATUS_FAILED"

failureReasons?array<string>

Only failed or rolled back purchases with one of these failure reasons, OR within the field, the same values as the FAILURE_REASON facet. Empty includes every purchase.

Value in"PURCHASE_FAILURE_REASON_LISTING_UNAVAILABLE""PURCHASE_FAILURE_REASON_INSUFFICIENT_BALANCE""PURCHASE_FAILURE_REASON_ACCOUNT_UNAVAILABLE""PURCHASE_FAILURE_REASON_MARKETPLACE_REJECTED""PURCHASE_FAILURE_REASON_TRADE_NOT_COMPLETED""PURCHASE_FAILURE_REASON_TRADE_REVERSED"

flags?array<string>

Review flags, OR within the field: a purchase matches when it carries any of the named flags. Empty does not restrict.

Value in"PURCHASE_FLAG_OVER_MAX_PRICE""PURCHASE_FLAG_WRONG_FLOAT""PURCHASE_FLAG_NOT_DELIVERED"

hasCoveringSellingContract?boolean

True selects only purchases whose bought item is held and covered by a selling contract now. False selects only purchases whose bought item is held and covered by none. A purchase with no held item never matches either value. Omitted includes every purchase.

marketHashNames?array<string>

Exact market_hash_name set, OR within the field, for an item's own purchases. Empty includes every item.

marketplaces?array<string>

Marketplace slugs the purchase was bought on (for example csfloat, market-csgo, dmarket), OR within the field, the same values as the MARKETPLACE facet. Empty includes every marketplace. At most 20 values.

maxPriceNowKind?string

Only purchases whose bought item is still held (arriving, in the inventory or listed) and whose contract targets the item now, compared by the contract's current maximum price for the item against the price paid. A purchase whose contract no longer targets the item never matches. Omitted includes every purchase.

Value in"PURCHASE_MAX_PRICE_NOW_BELOW_PAID""PURCHASE_MAX_PRICE_NOW_AT_OR_ABOVE_PAID"

needsReview?boolean

True selects only purchases carrying any flag (over max price, wrong float or not delivered), the same set as every PurchaseFlag together. False selects only purchases with none of those flags. Omitted includes both.

paintSeeds?array<integer>

Exact paint seeds (pattern indexes, 0 to 1000), OR within the field. A purchase with no known seed never matches. Empty includes every purchase. At most 200 seeds.

query?string

Case-insensitive literal substring of the item's market_hash_name, not a regular expression or wildcard pattern. Absent or empty matches every purchase.

strategies?array<string>

Buying mechanisms, OR within the field. Empty includes every strategy.

Value in"PURCHASE_STRATEGY_LISTING""PURCHASE_STRATEGY_BUY_ORDER""PURCHASE_STRATEGY_AUCTION""PURCHASE_STRATEGY_OFFER"

Response body

application/json

Success

counts?array<PurchaseStatusCount>

Count of purchases in each status, scoped to the workspace and the filter. A status with no purchases may be omitted.

Show attributes
count?integer

Number of purchases in this status.

Format"int32"

status?string

The purchase status this count is for.

Value in"PURCHASE_STATUS_PENDING""PURCHASE_STATUS_COMPLETED""PURCHASE_STATUS_FAILED""PURCHASE_STATUS_TRADES_PENDING""PURCHASE_STATUS_TRADED""PURCHASE_STATUS_ROLLED_BACK"

deliveryCounts?array<PurchaseDeliveryStatusCount>

Count of purchases in each customer-facing delivery state, under the same scope and filter. A state with no purchases may be omitted.

Show attributes
count?integer

Number of purchases in this state.

Format"int32"

deliveryStatus?string

The delivery state this count is for.

Value in"PURCHASE_DELIVERY_STATUS_PENDING""PURCHASE_DELIVERY_STATUS_DELIVERED""PURCHASE_DELIVERY_STATUS_FAILED"

curl -X POST "https://api.goldmine.to/contracts.v1.Contracts/CountPurchases" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "counts": [
    {
      "status": "PURCHASE_STATUS_TRADED",
      "count": 12
    },
    {
      "status": "PURCHASE_STATUS_PENDING",
      "count": 3
    }
  ]
}