Skip to content

API Reference / Purchases

List purchases in a workspace

Returns a paged list of purchases in the workspace, filtered by lifecycle status and the shared PurchaseFilter (contracts, item name search, exact item names, account, attribution time, strategy and review flags), in the requested order. Each page carries hydrated entities, so no follow-up GetPurchases is needed.

POST/contracts.v1.Contracts/ListPurchases

Request body

application/jsonRequired

Request for one page of the purchases in the caller's workspace, filtered by status and filter, in the requested order. Failed buy attempts that never committed money are not purchases a member sees and are never returned.

cursor?string

Opaque pagination cursor from a previous ListPurchasesResponse. Empty for the first page.

descending?boolean

Order descending instead of ascending.

filter?PurchaseFilter

Optional filters applied before pagination. Keep unchanged when continuing with a cursor.

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"

limit?integer

Maximum number of IDs to return. Server caps this at a service-defined upper bound.

Format"int32"

sortField?string

Field to order the page by. Unspecified orders by creation time.

Value in"PURCHASE_SORT_FIELD_CREATED_AT""PURCHASE_SORT_FIELD_UPDATED_AT""PURCHASE_SORT_FIELD_LISTING_PRICE""PURCHASE_SORT_FIELD_MARKET_HASH_NAME""PURCHASE_SORT_FIELD_ACCOUNT_NAME""PURCHASE_SORT_FIELD_PURCHASED_AT""PURCHASE_SORT_FIELD_CONTRACT_NAME""PURCHASE_SORT_FIELD_PAINT_SEED"

statuses?array<string>

Optional lifecycle status set, the grouping dimension CountPurchases breaks down by. Empty includes every status.

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

Response body

application/json

Success

nextCursor?string

Cursor to pass to fetch the next page. Empty when there are no more results.

purchases?array<Purchase>

Full purchases for this page. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetPurchases.

Show attributes
accountAttempts?array<PurchaseAccountAttempt>

The buying accounts tried, in order, for a failed purchase. Empty when none were reported.

Show attributes
accountName?string

The account that was tried.

attemptedAt?string

When the attempt was made.

Format"date-time"

detail?string

A plain sentence describing the failure. Never names a credential.

reason?string

Why this account's attempt failed.

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"

accountName?string

Steam/marketplace account that executed the buy.

afterStopFlaggedAt?string

Set when this purchase was recorded while buying was stopped.

Format"date-time"

buyingOrigin?BuyingOrigin

Whose switches had the market and the way of buying on when the buy was committed. Unset on a purchase recorded before this was kept.

Show attributes
marketOnBy?string

Whose switch had the market on: WORKSPACE or CONTRACT.

Value in"BUYING_SWITCH_ORIGIN_DEFAULT""BUYING_SWITCH_ORIGIN_WORKSPACE""BUYING_SWITCH_ORIGIN_CONTRACT"

wayOnBy?string

Whose switch had the way of buying on: DEFAULT, WORKSPACE or CONTRACT.

Value in"BUYING_SWITCH_ORIGIN_DEFAULT""BUYING_SWITCH_ORIGIN_WORKSPACE""BUYING_SWITCH_ORIGIN_CONTRACT"

chargedAmount?string

The amount the market charged, in that currency.

chargedCurrency?string

The currency the market charged in.

contractId?string

Contract that matched and won attribution for this purchase.

Format"byte" base64

contractVersion?string

The contract's version when the buy was committed, from the snapshot it was bought under. Unset when no snapshot is known.

Format"int64"

createdAt?string

When the purchase was attributed.

Format"date-time"

createdBy?string

Actor whose contract evaluation produced the winning intent this purchase was recorded against. Unset when the intent traces back to a background evaluation (a periodic re-evaluation sweep, or a SERVICE own-behalf actor), or when the winning active intent was withdrawn before this purchase could read it.

Format"byte" base64

custody?PurchaseCustody

Set while the market that sold the item holds it until it is withdrawn to the receiving Steam account. The item is owned and not yet received.

Show attributes
heldSince?string

When the purchase was recorded as held at the market.

Format"date-time"

market?string

The market holding the item.

transferId?string

The market's reference of the withdrawal. Empty until it is asked for.

withdrawableAt?string

When the market lets the item be withdrawn: its trade lock's end. Unset when it can be withdrawn now.

Format"date-time"

withdrawalRequestedAt?string

When the withdrawal to Steam was asked for. Unset while the item still waits at the market.

Format"date-time"

deletedAt?string

When the purchase was soft-deleted. Unset for active purchases.

Format"date-time"

deliveredAt?string

When the bought item arrived in the workspace's Steam inventory. Unset until delivered.

Format"date-time"

deliveryAccountName?string

The Steam account that received the delivery trade offer.

deliveryDeadline?string

When an undelivered purchase is flagged as late.

Format"date-time"

deliveryOfferCreatedAt?string

When the delivery trade offer was created on Steam.

Format"date-time"

deliveryStatus?string

Customer-facing state: pending, delivered or failed. Failed means rolled back after the buy.

Value in"PURCHASE_DELIVERY_STATUS_PENDING""PURCHASE_DELIVERY_STATUS_DELIVERED""PURCHASE_DELIVERY_STATUS_FAILED"

deliveryTradeCompletedAt?string

When Steam completed the trade that delivered this purchase, from Steam's own record of the trade. Unset while Steam's time is not known, never filled with the time it was noticed or reported.

Format"date-time"

deliveryTradeOfferId?string

The Steam trade offer that delivered this purchase, bound by an exact asset id match when the delivery entered escrow or was received. Unset until then.

escrowEndDate?string

The escrow hold's expected release date, when Steam reports one. Unset when Steam withheld the ETA, or when the delivery was never escrowed.

Format"date-time"

escrowedAt?string

When the delivery was first observed in escrow. Unset when the delivery was never held.

Format"date-time"

evaluatedAt?string

When the winning contract was last evaluated before the buy, read at assignment. With each reference price's observed_at it says how old the figures were and that they were still current at that evaluation. Unset for purchases recorded before it was stored.

Format"date-time"

expectedDeliveryAccountName?string

The Steam account that receives the item.

expectedDeliveryAssetIds?array<string>

The Steam asset ids the delivery offer must give.

expectedDeliveryOfferId?string

The newest Steam offer id the market named for the delivery.

failedAt?string

When the purchase reached a terminal failure - failed or rolled_back. Unset for a purchase that has not failed.

Format"date-time"

failureDetail?string

A plain sentence about the failure. Unset when none was reported.

failureReason?string

Why the purchase failed: the last account attempt's reason. Unset unless the purchase failed or was rolled back with a reported reason.

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"

flaggedForReviewAt?string

When the stale-purchase reconciliation first flagged this purchase for manual review, having found it stuck past its delivery deadline. A durable, stamp-once audit fact. Unset until flagged and never erased. The live needs-review set is the flagged purchases whose inventory item is still pending_trade.

Format"date-time"

floatValue?number

The bought item's real Steam float value, recorded at assignment. Unset when no real float was recorded, distinct from a 0.0 wear.

Format"double"

heldAtBuy?string

Copies of the item the workspace held when the purchase was recorded, not counting this purchase: the count the contract's keep limit (max_owned_per_item) is checked against, read in the same transaction that recorded the purchase. Set by GetPurchase and GetPurchases only. List reads leave it unset. Unset on a purchase recorded before this was kept.

Format"int64"

id?string

Opaque 16-byte purchase identifier.

Format"byte" base64

listingAssetId?string

Steam asset ID recorded on the marketplace listing at purchase time.

listingConflictFlaggedAt?string

Set when another purchase already held the same listing id on this market.

Format"date-time"

listingId?string

Marketplace listing identifier the item was purchased from.

listingPriceCents?string

Actual listing price paid on the marketplace, in cents.

Format"int64"

listingPriceMicros?string

The dollar price paid, in millionths of a dollar: charged_amount exactly when the market charged in dollars, else listing_price_cents. listing_price_cents is the same price rounded up to a cent, kept for limits. Show and sum this field.

Format"int64"

marketHashName?string

Canonical Steam market_hash_name of the item being purchased.

marketReadings?array<PurchaseMarketReading>

The market data figures the contract's market data rules read for the bought item, taken when the purchase was recorded, one per market data rule of the recorded configuration. Set by GetPurchase and GetPurchases only. List reads leave it empty. Empty when the contract has no market data rule, until the figures are read (seconds after the record), and on a purchase recorded before this was kept.

Show attributes
figure?number

The figure read, in US dollars for a price and as reported otherwise. Unset when no figure was fresh enough, which the rule counts as not met.

Format"double"

met?boolean

Whether the rule held for that figure. Unset when it could not be judged.

metric?string

The metric of that source the rule reads, as the rule names it.

path?string

The rule's position in the recorded predicate: its child indexes from the root joined by dots, as GetPurchaseConfiguration returns the predicate.

readAt?string

When the figure was read.

Format"date-time"

source?string

The market data source the rule reads.

marketplace?string

Source marketplace slug.

maxBuyPriceCents?string

Maximum price the contract was willing to pay at attribution time, in cents.

Format"int64"

maxFloat?number

Upper bound of the winning contract's float window the purchase was committed against. 1.0 means no upper bound. Unset for purchases recorded before the window was stored.

Format"double"

minFloat?number

Lower bound of the winning contract's float window the purchase was committed against. 0.0 means no lower bound. Unset for purchases recorded before the window was stored.

Format"double"

moneyHoldDeadline?string

When the held money is expected to be final.

Format"date-time"

moneyHoldReason?string

The market's own stage or waiting reason while the money is held.

moneyState?string

Whether the market still holds the money, has made it final, or has returned it.

Value in"PURCHASE_MONEY_STATE_HELD""PURCHASE_MONEY_STATE_FINAL""PURCHASE_MONEY_STATE_REFUNDED""PURCHASE_MONEY_STATE_REVERSED"

overCeilingFlaggedAt?string

When this purchase was recorded with a listing price above the winning intent's committed max price - a market-service bug that overpaid, making platform_fee_cents negative. Stamped once at record time inside AssignPurchase and never erased. A permanent needs-review contributor that does not self-clear as the item delivers, because a negative-fee loss stays visible through to manual resolution.

Format"date-time"

overLimitFlaggedAt?string

Set when this purchase took its contract past a limit.

Format"date-time"

paidMismatchFlaggedAt?string

Set when the market's paid figure differs from the price that was sent.

Format"date-time"

paintSeed?integer

The bought item's pattern index (paint seed, 0 to 1000), from the listing at assignment or decoded from the delivered item's inspect link. Unset when unknown, distinct from seed 0.

Format"int32"

platformFeeCents?string

Platform fee (max_buy_price - listing_price), in cents.

Format"int64"

positionId?string

The position this purchase was recorded against, when a market worker recorded it.

Format"byte" base64

purchasedAt?string

When the purchase transitioned to completed - the buy executed and funds were committed. Unset while pending.

Format"date-time"

referencePrices?array<ReferencePrice>

Per-reference price breakdown of the winning intent behind max_buy_price_cents, so the purchase price is traceable to the exact source figures behind it.

Show attributes
lastObservedAt?string

For a stale reference, when last_value_cents was observed. Set only when outcome is stale.

Format"date-time"

lastValueCents?string

For a stale reference, the last value the source reported before the reference's adjustment, in US cents. Set only when outcome is stale.

Format"int64"

metric?string

The metric read for a market data lookup. Absent for a sale computation.

observedAt?string

When the figure behind value_cents was observed: the market observation's own time for a market data lookup, or the newest sale in the window for a sale computation. Absent when value_cents is absent.

Format"date-time"

outcome?string

Whether the reference resolved a price, found only an observation older than its freshness window, or found no data at all.

Value in"REFERENCE_PRICE_OUTCOME_RESOLVED""REFERENCE_PRICE_OUTCOME_STALE""REFERENCE_PRICE_OUTCOME_MISSING"

priceCents?string

The price after the reference's adjustment, in US cents, which the valuation strategy combines. Absent when the source had no usable data.

Format"int64"

referenceIndex?integer

Zero-based position of the reference in the valuation's references.

Format"int32"

source?string

The reference's market source, such as "market-csgo".

valueCents?string

The price the source gave before the reference's adjustment, in US cents. Absent when the source had no usable data.

Format"int64"

revivedAt?string

Set when this purchase was recorded after its reservation had been closed or had passed its deadline.

Format"date-time"

snapshotId?string

The evaluation snapshot whose intent the purchase was committed against, readable with GetSnapshot. Unset for purchases recorded before the snapshot was stored.

Format"int64"

status?string

Current purchase lifecycle state.

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

strategy?string

Buying mechanism that produced the purchase, recorded as provenance.

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

tradedAt?string

When the Steam trade completed and the item was received. Unset until traded.

Format"date-time"

updatedAt?string

When the purchase was last modified.

Format"date-time"

updatedBy?string

Same actor as created_by. Stamped once at record time and never revised by a later status transition.

Format"byte" base64

version?string

Optimistic concurrency version. Incremented on every status change.

Format"int64"

workspaceId?string

Workspace the purchase belongs to.

Format"byte" base64

wrongFloatFlaggedAt?string

When this purchase was recorded with a float outside the winning intent's committed float window - a market-service bug that bought the wrong item. Stamped once at record time inside AssignPurchase and never erased. A permanent needs-review contributor that does not self-clear as the item delivers, because a wrong-item buy stays visible through to manual resolution.

Format"date-time"

wrongItemFlaggedAt?string

Set when the market returned or shows another item than the one bought.

Format"date-time"

curl -X POST "https://api.goldmine.to/contracts.v1.Contracts/ListPurchases" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 50,
    "cursor": "",
    "statuses": [
      "PURCHASE_STATUS_FAILED"
    ]
  }'
{
  "purchases": [],
  "nextCursor": ""
}