Skip to content

API Reference / Intents

List this workspace's intent rollup for a side

Returns the workspace's own rolled-up buying or selling intents, one row per item and float window with the workspace's best price and the number of its contracts contributing. Only the caller's own rows are returned, with server-side price/name/contributor-count ordering before pagination.

POST/contracts.v1.Contracts/ListWorkspaceIntentRollup

Request body

application/jsonRequired

Request for one page of the caller's workspace's combined buying or selling targets, one row per item and float window.

cursor?string

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

descending?boolean

Order descending instead of ascending. Start a new cursor when changing the filter, side, field or direction.

filter?WorkspaceIntentRollupFilter

Optional filters applied before pagination.

Show attributes
atHoldLimit?boolean

Requires contract_id. True keeps only rows whose owned_count has reached that contract's max owned per item. False keeps the rest. A contract without that limit has no row at it. Omitted includes both.

boughtNothing?boolean

True keeps only rows whose purchases_7d_count is zero. False keeps only rows with at least one such purchase. Omitted includes both.

cheapestSeen?string

Only rows whose cheapest listing seen in the last 24 hours stands this way against the max price. Buying side only. Omitted includes every row.

Value in"WORKSPACE_INTENT_CHEAPEST_SEEN_JUST_OVER_MAX_PRICE""WORKSPACE_INTENT_CHEAPEST_SEEN_OVER_MAX_PRICE""WORKSPACE_INTENT_CHEAPEST_SEEN_AT_OR_UNDER_MAX_PRICE""WORKSPACE_INTENT_CHEAPEST_SEEN_NONE_SEEN"

contractId?string

Only rows one of whose contributing active intents belongs to this contract of the caller's workspace. Absent does not restrict.

Format"byte" base64

hasStock?boolean

True keeps only rows whose held_count is above zero. False keeps only rows with nothing held. Omitted includes both.

marketHashNames?array<string>

Exact market_hash_name set, OR within the field, so one read prices a page of catalog items. Empty includes every item. At most 200 names, each nonempty.

query?string

Optional case-insensitive substring, matched server side against the row's market_hash_name or against the name of any of this workspace's contracts contributing an active intent to the row. Absent or empty returns every row.

selections?array<ItemCategorySelection>

Only rows whose item is in one of these catalog categories, each narrowed by weapon type for skins, OR within the field. At most 20, under the catalog filter's own rules. Empty includes every row.

Show attributes
category?string

The catalog category.

Value in"ITEM_CATEGORY_WEAPON_SKIN""ITEM_CATEGORY_KNIFE_SKIN""ITEM_CATEGORY_GLOVE_SKIN""ITEM_CATEGORY_STICKER""ITEM_CATEGORY_PATCH""ITEM_CATEGORY_CASE""ITEM_CATEGORY_STICKER_CAPSULE""ITEM_CATEGORY_MUSIC_KIT""ITEM_CATEGORY_AGENT""ITEM_CATEGORY_KEY""ITEM_CATEGORY_GRAFFITI""ITEM_CATEGORY_KEYCHAIN""ITEM_CATEGORY_COMMODITY_PIN""ITEM_CATEGORY_TOOL"

weaponTypes?array<string>

Weapon types inside the category, as the catalog names them (rifle, sniper, pistol, smg, heavy), any of them. Empty selects the whole category.

limit?integer

Maximum number of rows to return. Server caps this at a service-defined upper bound (1000) and defaults to it when unset.

Format"int32"

sidestring

Which intent direction to roll up: BUYING or SELLING. Required.

Value in"CONTRACT_TYPE_BUYING""CONTRACT_TYPE_SELLING"

sortField?string

Order across all matching workspace targets, before pagination. Unspecified preserves price ordering. Equal values use item name and exact float bounds as stable tie breakers.

Value in"WORKSPACE_INTENT_ROLLUP_SORT_FIELD_PRICE""WORKSPACE_INTENT_ROLLUP_SORT_FIELD_NAME""WORKSPACE_INTENT_ROLLUP_SORT_FIELD_CONTRIBUTING_COUNT""WORKSPACE_INTENT_ROLLUP_SORT_FIELD_MIN_FLOAT""WORKSPACE_INTENT_ROLLUP_SORT_FIELD_PURCHASES_7D""WORKSPACE_INTENT_ROLLUP_SORT_FIELD_CHEAPEST_SEEN"

Response body

application/json

Success

items?array<WorkspaceIntentRollupItem>

This workspace's own intent rollup rows for the requested side, in the requested server order (descending top_price_cents by default).

Show attributes
averageBuyPriceCents?string

Average buy price of the held_count items, in cents, rounded to the nearest cent. Unset when held_count is zero.

Format"int64"

averageBuyPriceMicros?string

Average buy price of the held_count items, in millionths of a dollar, from their exact buy prices and rounded to the nearest millionth. Unset when held_count is zero.

Format"int64"

cheapestSeenAt?string

The last time a listing at cheapest_seen_price_micros was seen. Unset with it.

Format"date-time"

cheapestSeenMarket?string

The key of the market the cheapest listing was seen on. Unset with it.

cheapestSeenPriceMicros?string

The lowest asking price, in millionths of a dollar, among the listings of this item inside this row's float window that any of the platform's readers saw on any market in the last 24 hours. Unset when none was seen in that time, and always on the selling side. The listing may have sold since.

Format"int64"

contractPurchases7dCount?integer

Of purchases_7d_count, the purchases made by the contract the read filters by (WorkspaceIntentRollupFilter.contract_id). Set only when the read filters by one contract.

Format"int32"

heldCount?integer

This workspace's held inventory items of this item inside the row's float window: pending trade, in the inventory or listed, whichever contract bought them.

Format"int32"

lastChange?TargetChange

The newest change of top_contract_id's intent for this row inside the 7 days evaluation history is kept: the target added, or its max price moved. Unset when that intent has not changed in the last 7 days.

Show attributes
changedAt?string

When the evaluation that made the change wrote it.

Format"date-time"

fromPriceCents?string

The max price before the change, in cents. Set only when the max price moved.

Format"int64"

kind?string

Added, or the max price moved.

Value in"TARGET_CHANGE_KIND_ADDED""TARGET_CHANGE_KIND_PRICE_MOVED"

toPriceCents?string

The max price the change set, in cents.

Format"int64"

lastPurchaseId?string

The most recent of the purchases purchases_7d_count counts, base64-encoded in JSON. Unset when there were none.

Format"byte" base64

lastPurchasePriceCents?string

The listing price paid for last_purchase_id, in cents. Unset when there were none.

Format"int64"

lastPurchasePriceMicros?string

The price paid for last_purchase_id, in millionths of a dollar, exact to the fraction of a cent the market charged. Unset when there were none.

Format"int64"

listedCount?integer

Of held_count, the items currently listed for sale.

Format"int32"

marketHashName?string

Canonical Steam market_hash_name of the item this row rolls up.

maxFloat?number

Float window upper bound. 1.0 means no upper bound.

Format"double"

minFloat?number

Float window lower bound. 0.0 means no lower bound.

Format"double"

ownContributingCount?integer

Number of this workspace's own contracts contributing an active intent for this item, float window, and side.

Format"int32"

ownedCount?integer

Copies of this item the workspace holds now across every float window, counted exactly as the max owned per item limit counts them: items in the Steam inventory plus items bought and still arriving, each counted once.

Format"int32"

purchases7dAverageMicros?string

Average price paid for the purchases purchases_7d_count counts, in millionths of a dollar, from their exact prices and rounded to the nearest millionth. Unset when there were none.

Format"int64"

purchases7dCount?integer

Purchases of this item in the last 7 days by this workspace's contributing contracts, counting only buys whose recorded float lies inside this row's float window and excluding failed and rolled back purchases.

Format"int32"

referencePrices?array<ReferencePrice>

Per-reference price breakdown behind top_price_cents: each source's resolved price before and after its adjustment, carried from the contributing active intent that set this workspace's best price.

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"

side?string

Which intent direction this row rolls up, inherited from the originating contract's type: BUYING or SELLING.

Value in"CONTRACT_TYPE_BUYING""CONTRACT_TYPE_SELLING"

topContractId?string

This workspace's contract whose active intent sets top_price_cents: the highest price, with the lowest contract id winning a tie, the same rule that picks reference_prices. When own_contributing_count is above one, the others want the row at the same or a lower price. Unset only while the rollup is being rebuilt.

Format"byte" base64

topContractName?string

Current name of top_contract_id. Unset with it.

topPriceCents?string

This workspace's own best price for this item, float window, and side, in cents: the max price for a buying intent or the computed list price for a selling intent.

Format"int64"

tradeHoldCount?integer

Of held_count, the items in the inventory but not yet tradable, inside Valve's post-trade hold.

Format"int32"

nextCursor?string

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

curl -X POST "https://api.goldmine.to/contracts.v1.Contracts/ListWorkspaceIntentRollup" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "side": "buy",
    "limit": 50,
    "cursor": ""
  }'
{
  "items": [
    {
      "marketHashName": "AK-47 | Redline (Field-Tested)",
      "side": "buy",
      "maxFloat": 0.38,
      "topPriceCents": "4800",
      "ownContributingCount": 2,
      "referencePrices": [
        {
          "referenceIndex": 0,
          "source": "buff163",
          "metric": "sell_min",
          "valueCents": "5000",
          "priceCents": "4800"
        }
      ]
    },
    {
      "marketHashName": "AWP | Asiimov (Field-Tested)",
      "side": "buy",
      "maxFloat": 0.38,
      "topPriceCents": "8730",
      "ownContributingCount": 1
    }
  ],
  "nextCursor": ""
}