API Reference / Purchases
Count purchases per filter option
Returns, for each requested facet field (strategy, account, contract, marketplace), how many purchases carry each value under the same PurchaseFilter and status selection as ListPurchases, with the field's own filter left out. Drives the purchases filter flyout.
/ contracts. v1. Contracts/ GetPurchaseFacetCountsRequest body
application/jsonRequired
Request for the per value counts of up to 8 purchase facet fields under the same filter and status selection as ListPurchases, so a filter flyout shows how many purchases each option would select.
fields?array<string>The facet fields to count, at most 8.
Value in"PURCHASE_"PURCHASE_"PURCHASE_"PURCHASE_"PURCHASE_
filter?PurchaseFilterThe same filter as ListPurchases. Each facet is counted with every other field applied but not its own, so choosing one account still shows the counts of the other accounts.
Show attributes
accountName?stringExact 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?stringOnly purchases attributed before this time. Absent sets no upper bound.
Format"date-time"
createdFrom?stringOnly 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_"PURCHASE_"PURCHASE_
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_"PURCHASE_"PURCHASE_"PURCHASE_"PURCHASE_"PURCHASE_
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_"PURCHASE_"PURCHASE_
hasCoveringSellingContract?booleanTrue 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?stringOnly 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_"PURCHASE_
needsReview?booleanTrue 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?stringCase-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_"PURCHASE_"PURCHASE_"PURCHASE_
statuses?array<string>The list's lifecycle status selection, so the flyout reflects the open tab. Empty includes every status.
Value in"PURCHASE_"PURCHASE_"PURCHASE_"PURCHASE_"PURCHASE_"PURCHASE_
Response body
application/json
Success
facets?array<PurchaseFacetCounts>One entry per requested field, in request order.
Show attributes
counts?FacetFieldCountsThe values ordered by count descending then value, at most 50, with truncated set when more exist.
Show attributes
truncated?booleanTrue when the field has more than 50 values, so the list shows only the 50 most common.
values?array<FacetValueCount>The values and their counts, ordered by count descending then by value, at most 50.
Show attributes
count?stringNumber of rows carrying the value under the facet's predicate. Returned as a JSON string to preserve integer precision.
Format"int64"
value?stringThe value as the list rows carry it: an enum name, a base64 id or an account name, so a client maps it to a label exactly as it maps a row.
field?stringThe facet field these counts are for.
Value in"PURCHASE_"PURCHASE_"PURCHASE_"PURCHASE_"PURCHASE_
application/json
The request was malformed, such as a missing required field or an unparseable cursor.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
curl -X POST "https://api.goldmine.to/contracts.v1.Contracts/GetPurchaseFacetCounts" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"statuses": [
"PURCHASE_STATUS_PENDING"
],
"fields": [
"PURCHASE_FACET_FIELD_ACCOUNT_NAME",
"PURCHASE_FACET_FIELD_STRATEGY"
]
}'const res = await fetch("https://api.goldmine.to/contracts.v1.Contracts/GetPurchaseFacetCounts", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"statuses": [
"PURCHASE_STATUS_PENDING"
],
"fields": [
"PURCHASE_FACET_FIELD_ACCOUNT_NAME",
"PURCHASE_FACET_FIELD_STRATEGY"
]
}),
});
const data = await res.json();body := strings.NewReader(`{
"statuses": [
"PURCHASE_STATUS_PENDING"
],
"fields": [
"PURCHASE_FACET_FIELD_ACCOUNT_NAME",
"PURCHASE_FACET_FIELD_STRATEGY"
]
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/contracts.v1.Contracts/GetPurchaseFacetCounts", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/contracts.v1.Contracts/GetPurchaseFacetCounts",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"statuses": [
"PURCHASE_STATUS_PENDING"
],
"fields": [
"PURCHASE_FACET_FIELD_ACCOUNT_NAME",
"PURCHASE_FACET_FIELD_STRATEGY"
]
},
)
data = res.json(){
"facets": [
{
"field": "PURCHASE_FACET_FIELD_ACCOUNT_NAME",
"counts": {
"values": [
{
"value": "trader_steam_01",
"count": "7"
}
],
"truncated": false
}
},
{
"field": "PURCHASE_FACET_FIELD_STRATEGY",
"counts": {
"values": [
{
"value": "PURCHASE_STRATEGY_LISTING",
"count": "7"
}
],
"truncated": false
}
}
]
}{
"code": "invalid_argument",
"message": "The request was malformed, such as a missing required field or an unparseable cursor."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}