API Reference / Contract evaluation
Explain why named items are or are not matches of a contract
Evaluates a contract's predicate and valuation against up to 10 named catalog items, whether or not the contract matches them, and returns for each item the result of every predicate node, the figure each market data rule read, the price from each valuation reference before any price bound, the combined maximum price, the item's own float window, and where the item ends up: matched, or left out by a rule, by having no price, or by a price bound, with the path of the first node that leaves it out. Use this for the one match a member opens and the few items a search names. It is priced per named item, never per match. To explain a saved contract version, send that version's predicate and valuation.
/ analytics. v1. Analytics/ GetContractItemExplanationsRequest body
application/jsonRequired
Request to explain a contract's predicate and valuation against a few named catalog items.
contractIdstringOpaque 16-byte identifier of the contract being explained, base64-encoded in JSON. Required and must be a valid identifier, but only the predicate and valuation in this request are evaluated, never the stored contract.
Format"byte" base64
marketHashNames?array<string>The items to explain, from 1 to 10 distinct market hash names. Explanations come back in this order.
predicate?PredicateWhich items the contract matches, with every filter set reference already expanded, exactly as sent to EvaluateContract. Node paths in the response index this predicate as sent.
Show attributes
filterSet?FilterSetReferenceThis node is a reference to a named, reusable filter set, expanded into its fragment before evaluation.
Show attributes
filterSetId?stringIdentifier of the referenced filter set. Must belong to the same workspace as the contract. The contracts worker expands it into its predicate fragment before evaluation.
Format"byte" base64
group?PredicateGroupThis node is a group: an AND/OR combination of child predicate nodes.
Show attributes
condition?stringLogical combinator applied to rules: AND or OR.
Value in"PREDICATE_"PREDICATE_
rules?array<Predicate>Child predicate nodes combined by condition. Must be non-empty.
rule?PredicateRuleThis node is a leaf rule: a single subject-operator-value condition.
Show attributes
field?stringThis rule's subject is an item attribute, resolved against the items catalog.
Value in"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_
marketData?MarketDataFieldThis rule's subject is a (source, metric) market-observation value.
Show attributes
freshnessFreshnessMaximum age of the observation this rule reads. Required, exactly one positive unit: an observation older than now minus freshness is treated as unavailable and the rule does not match.
Show attributes
maximumAge?stringThe oldest market data to use. Must be positive.
metric?stringName of the market-observation metric to resolve, for example a source's 7-day sales volume.
source?stringMarket-data source the metric is resolved against.
operator?stringComparison operator applied to the subject's resolved value. Which operators are legal depends on the subject: field allows the full attribute operator set (narrowed to gte/gt for min_wear and lte/lt for max_wear), market_data allows only eq, neq, gt, gte, lt, lte and between (with a number_range_value, both ends inclusive), and value_field allows only gt, gte, lt, lte. The list operators in, not_in, contains_any and contains_none take a string_list_value. Contains_any and contains_none apply only to the text fields market_hash_name, weapon, paint and collection, and item_age_days also takes between.
Value in"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_"PREDICATE_
value?PredicateValueRight-hand side value the subject is compared against.
Show attributes
boolValue?booleanBoolean value, used when the subject's comparison is against a boolean item attribute such as has_stat_trak or has_souvenir.
decimalValue?stringExact decimal number as text, used for a float (wear) bound on min_wear or max_wear: digits, a point and up to 16 decimal places, with no sign and no exponent, from 0 to 1. Kept and returned exactly as given, so 0.2734 reads back as 0.2734 and 0.27340 as 0.27340. A float bound given as number_value is read as the shortest decimal that number prints as, and every float bound is returned as decimal_value.
numberRangeValue?NumberRangeNumber range, used with the between operator on a market-data or item_age_days rule: the rule matches when the value is at least minimum and at most maximum.
Show attributes
maximum?numberThe highest value inside the range, included. Must be at least minimum.
Format"double"
minimum?numberThe lowest value inside the range, included.
Format"double"
numberValue?numberNumeric value, used when the subject's comparison is against a number: a market-data bound, a computed-price bound, or a numeric item attribute.
Format"double"
stringListValue?StringListList of string values, used with the in, not_in, contains_any and contains_none operators.
Show attributes
values?array<string>The wrapped list of string values.
stringValue?stringString value, used when the subject's comparison is against text.
valueField?stringThis rule's subject is the valuation's combined computed price for the item.
Value in"PREDICATE_
valuation?ValuationHow the contract prices an item. Absent explains the predicate only.
Show attributes
references?array<ValuationReference>The price sources to combine, each a market data lookup or a sale computation.
Show attributes
adjustment?numberFraction applied to the resolved price, which is multiplied by one plus this value: -0.3 pays 30 percent under, 0.1 pays 10 percent over. From -1 to 10.
Format"double"
aggregationAggregationHow the selected sales combine into one price. Required for a sale computation and not allowed on a market data lookup.
Show attributes
average?AverageOptionsOptions for an average. Only used when type is average.
Show attributes
weighted?booleanTrue weights each sale by its quantity. False averages sale prices equally.
type?stringThe combining function: average, median, minimum, maximum, mode or percentile. Percentile needs the reference's percentile field.
Value in"AGGREGATION_"AGGREGATION_"AGGREGATION_"AGGREGATION_"AGGREGATION_"AGGREGATION_
freshnessFreshnessMaximum age of the observation a market-data lookup reads. Required for a market-data lookup (metric set). Rejected for a sale computation (window/aggregation set).
Show attributes
maximumAge?stringThe oldest market data to use. Must be positive.
lag?LagShifts an hours or days window into the past. Sale computation only. Absent prices on the latest sales.
Show attributes
shift?stringHow far to shift the window back from now. Only valid with a time window.
metric?stringMetric to read, such as "listing-price", which makes this a market data lookup. Absent for a sale computation.
outlier?OutlierDrops sales far from the typical price before combining them. Sale computation only. Absent keeps every sale.
Show attributes
sigma?numberSales more than this many standard deviations from the mean are dropped, such as 2.0.
Format"double"
percentileintegerPercentile to take, from 0 to 100. Required with the percentile aggregation and not allowed otherwise.
Format"int32"
source?stringMarket source to price from, such as "market-csgo".
truncatePercentage?booleanFor a market-data lookup, preserve the raw fractional USD cents until calculating trunc((100 + adjustment * 100) * (raw / 100)). False retains the ordinary nearest-cent rounding. True is rejected for sale computations.
window?WindowWhich recent sales to read, which together with aggregation makes this a sale computation. Absent for a market data lookup.
Show attributes
count?integerRead the most recent this many sales, whenever they happened. Cannot be combined with lag.
Format"int32"
length?stringRead sales from this long before now. Lag can shift the window into the past.
strategy?stringHow the references combine into one price. MIN is required for a buying contract and MAX for a selling contract. AVG is valid for either. Pairing the wrong extreme with a contract type risks overpaying (MAX on a buying contract) or underpricing (MIN on a selling contract).
Value in"VALUATION_"VALUATION_"VALUATION_
Response body
application/json
Success
explanations?array<ContractItemExplanation>The explanations, one per named item, in request order.
Show attributes
category?stringThe item's catalog category, such as weapon_skin. Absent when unknown.
collection?stringThe item's collection. Absent when it has none.
excludingPath?stringPath of the first predicate node that leaves the item out: the first failing rule of an all-of group, or an any-of group none of whose branches holds. Empty when the item is matched, has no price, or is not in the catalog.
marketHashName?stringThe item's market hash name, as named in the request.
maxBuyPriceCents?stringThe valuation's combined price in US cents before any price bound is applied. Absent when a reference the strategy needs has no price, or without a valuation.
Format"int64"
maxFloat?numberHighest float of the item's own share of the predicate's float window. Absent when the predicate sets no float bound or the item has no float.
Format"double"
maxFloatDecimal?stringmax_float as exact decimal text, as EvaluateContract reports it: the predicate's own upper bound exactly as given when that bound is this item's upper edge, otherwise the item's own wear boundary to at least two decimal places. Set exactly when max_float is set.
maxWear?numberHighest float the item's wear allows, from 0.0 to 1.0. Absent for an item without a float.
Format"double"
minFloat?numberLowest float of the item's own share of the predicate's float window. Absent when the predicate sets no float bound or the item has no float.
Format"double"
minFloatDecimal?stringmin_float as exact decimal text, as EvaluateContract reports it: the predicate's own lower bound exactly as given when that bound is this item's lower edge, otherwise the item's own wear boundary to at least two decimal places. Set exactly when min_float is set.
minWear?numberLowest float the item's wear allows, from 0.0 to 1.0. Absent for an item without a float.
Format"double"
nodes?array<ContractNodeResult>Every node of the predicate as sent, groups and rules, in pre-order, judged for the item. Empty when the item is not in the catalog.
Show attributes
figure?numberFor a market data rule, the figure it read, in US dollars for a price and as reported otherwise. Absent for other nodes, and when no figure was fresh enough.
Format"double"
met?booleanWhether the node holds for the item. A rule whose figure is missing does not hold. Absent only for a price bound when the item has no price to judge it against.
path?stringThe node's position: its child indexes from the root joined by dots. The root is the empty path. "0.2" is the third child of the root's first child.
outcome?stringWhere the item ends up: matched, left out by a rule, without a price, outside a price bound, or not in the catalog.
Value in"CONTRACT_"CONTRACT_"CONTRACT_"CONTRACT_"CONTRACT_
paint?stringThe item's finish, such as Redline. Absent when the item has none.
rarity?stringThe item's rarity. Absent when unknown.
referencePrices?array<ReferencePrice>Each valuation reference's resolved price for the item, in reference order, exactly as EvaluateContract reports them.
Show attributes
lastObservedAt?stringFor a stale reference, when last_value_cents was observed. Set only when outcome is stale.
Format"date-time"
lastValueCents?stringFor 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?stringThe metric read for a market data lookup. Absent for a sale computation.
observedAt?stringWhen 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?stringWhether the reference resolved a price, found only an observation older than its freshness window, or found no data at all.
Value in"REFERENCE_"REFERENCE_"REFERENCE_
priceCents?stringThe 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?integerZero-based position of the reference in the valuation's references.
Format"int32"
source?stringThe reference's market source, such as "market-csgo".
valueCents?stringThe price the source gave before the reference's adjustment, in US cents. Absent when the source had no usable data.
Format"int64"
weapon?stringThe item's weapon, such as AK-47. Absent when the item has none.
weaponType?stringThe item's weapon type, such as rifle. Absent when the item has none.
licensedSourcesWithheld?LicensedSourcesWithheldNo longer set: price reads carry no limits, so no licensed price source's figures are left out. Kept so existing clients still decode the response.
Show attributes
limit?stringThe rule that left them out.
Value in"LICENSED_"LICENSED_"LICENSED_"LICENSED_"LICENSED_
resetsAt?stringWhen the limit next admits the read, for the per-minute and per-day limits. Absent for a rule the caller fixes by changing the read.
Format"date-time"
sourceFamily?stringThe licensed provider whose figures were left out.
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/analytics.v1.Analytics/GetContractItemExplanations" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"contractId": "AY86PB0ufwCKGyw9Tl9gcQ==",
"marketHashNames": [
"AK-47 | Redline (Field-Tested)"
],
"predicate": {
"filterSet": {
"filterSetId": "AY86PB0ufwCKGyw9Tl9gcQ=="
}
},
"valuation": {
"references": [
{
"adjustment": 3,
"aggregation": {},
"freshness": {},
"lag": {},
"metric": "listing-price",
"outlier": {},
"percentile": 3,
"source": "buff163",
"truncatePercentage": false,
"window": {}
}
],
"strategy": "VALUATION_STRATEGY_MIN"
}
}'const res = await fetch("https://api.goldmine.to/analytics.v1.Analytics/GetContractItemExplanations", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"contractId": "AY86PB0ufwCKGyw9Tl9gcQ==",
"marketHashNames": [
"AK-47 | Redline (Field-Tested)"
],
"predicate": {
"filterSet": {
"filterSetId": "AY86PB0ufwCKGyw9Tl9gcQ=="
}
},
"valuation": {
"references": [
{
"adjustment": 3,
"aggregation": {},
"freshness": {},
"lag": {},
"metric": "listing-price",
"outlier": {},
"percentile": 3,
"source": "buff163",
"truncatePercentage": false,
"window": {}
}
],
"strategy": "VALUATION_STRATEGY_MIN"
}
}),
});
const data = await res.json();body := strings.NewReader(`{
"contractId": "AY86PB0ufwCKGyw9Tl9gcQ==",
"marketHashNames": [
"AK-47 | Redline (Field-Tested)"
],
"predicate": {
"filterSet": {
"filterSetId": "AY86PB0ufwCKGyw9Tl9gcQ=="
}
},
"valuation": {
"references": [
{
"adjustment": 3,
"aggregation": {},
"freshness": {},
"lag": {},
"metric": "listing-price",
"outlier": {},
"percentile": 3,
"source": "buff163",
"truncatePercentage": false,
"window": {}
}
],
"strategy": "VALUATION_STRATEGY_MIN"
}
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/analytics.v1.Analytics/GetContractItemExplanations", 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/analytics.v1.Analytics/GetContractItemExplanations",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"contractId": "AY86PB0ufwCKGyw9Tl9gcQ==",
"marketHashNames": [
"AK-47 | Redline (Field-Tested)"
],
"predicate": {
"filterSet": {
"filterSetId": "AY86PB0ufwCKGyw9Tl9gcQ=="
}
},
"valuation": {
"references": [
{
"adjustment": 3,
"aggregation": {},
"freshness": {},
"lag": {},
"metric": "listing-price",
"outlier": {},
"percentile": 3,
"source": "buff163",
"truncatePercentage": false,
"window": {}
}
],
"strategy": "VALUATION_STRATEGY_MIN"
}
},
)
data = res.json(){
"explanations": [
{
"category": "example",
"collection": "example",
"excludingPath": "example",
"marketHashName": "AK-47 | Redline (Field-Tested)",
"maxBuyPriceCents": "2360",
"maxFloat": 3,
"maxFloatDecimal": "example",
"maxWear": 3,
"minFloat": 3,
"minFloatDecimal": "example",
"minWear": 3,
"nodes": [
{}
],
"outcome": "CONTRACT_ITEM_OUTCOME_MATCHED",
"paint": "example",
"rarity": "example",
"referencePrices": [
{}
],
"weapon": "example",
"weaponType": "example"
}
],
"licensedSourcesWithheld": {
"limit": "LICENSED_SOURCE_LIMIT_NOT_SIGNED_IN",
"resetsAt": "2026-11-03T16:10:00Z",
"sourceFamily": "example"
}
}{
"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."
}