Skip to content

API Reference / Contracts

Get this workspace's ownership coverage

Returns whether the workspace's record of which Steam accounts hold which items is complete and fresh enough to enforce owned-item limits, as bounded counts with no account identified. A buying contract with a max_owned_per_item limit is paused with holdings unconfirmed while coverage is not complete.

POST/contracts.v1.Contracts/GetOwnershipCoverage

Request body

application/jsonRequired

Request for the caller's workspace's ownership coverage on its own. The workspace comes from the caller's actor, so the request carries no fields.

No fields.

Response body

application/json

Success

coverage?OwnershipCoverage

The aggregate assessment. Absent only when the service runs without an inventory membership source, in which case coverage is unknown rather than empty.

Show attributes
complete?boolean

True only when every authoritative workspace account has a matching current-lifecycle, complete and fresh context-2 ownership proof.

freshCompleteAccounts?integer

Recorded accounts with complete, fresh proofs. This count alone does not certify membership or zero ownership.

Format"int32"

reason?string

Overall proof assessment. Membership mismatch includes unobserved or changed account identities. Pending, failed and stale observations remain distinguishable in recorded_reasons.

Value in"OWNERSHIP_COVERAGE_REASON_COMPLETE""OWNERSHIP_COVERAGE_REASON_PENDING""OWNERSHIP_COVERAGE_REASON_UNKNOWN_BODY""OWNERSHIP_COVERAGE_REASON_PRIVATE""OWNERSHIP_COVERAGE_REASON_AUTHENTICATION""OWNERSHIP_COVERAGE_REASON_RATE_LIMITED""OWNERSHIP_COVERAGE_REASON_UNAVAILABLE""OWNERSHIP_COVERAGE_REASON_UNPROVEN_READ""OWNERSHIP_COVERAGE_REASON_STALE""OWNERSHIP_COVERAGE_REASON_MEMBERSHIP_MISMATCH"

recordedAccounts?integer

Nondeleted locally recorded accounts in the workspace. May differ from authoritative membership during bootstrap or lifecycle changes.

Format"int32"

recordedReasons?array<OwnershipCoverageReasonCount>

Bounded aggregate counts by recorded proof reason. No account names, Steam IDs, timestamps or membership fingerprint are returned.

Show attributes
accountCount?integer

Number of recorded observations with this reason. These are not certified current-member counts when membership does not match.

Format"int32"

reason?string

Bounded reason for these locally recorded account observations.

Value in"OWNERSHIP_COVERAGE_REASON_COMPLETE""OWNERSHIP_COVERAGE_REASON_PENDING""OWNERSHIP_COVERAGE_REASON_UNKNOWN_BODY""OWNERSHIP_COVERAGE_REASON_PRIVATE""OWNERSHIP_COVERAGE_REASON_AUTHENTICATION""OWNERSHIP_COVERAGE_REASON_RATE_LIMITED""OWNERSHIP_COVERAGE_REASON_UNAVAILABLE""OWNERSHIP_COVERAGE_REASON_UNPROVEN_READ""OWNERSHIP_COVERAGE_REASON_STALE""OWNERSHIP_COVERAGE_REASON_MEMBERSHIP_MISMATCH"

totalAccounts?integer

Authoritative workspace account total. Absent when the native membership read failed. Explicit zero means a verified empty membership, not unknown coverage.

Format"int32"

curl -X POST "https://api.goldmine.to/contracts.v1.Contracts/GetOwnershipCoverage" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "coverage": {
    "complete": false,
    "freshCompleteAccounts": 3,
    "reason": "OWNERSHIP_COVERAGE_REASON_COMPLETE",
    "recordedAccounts": 3,
    "recordedReasons": [
      {
        "accountCount": 3,
        "reason": "OWNERSHIP_COVERAGE_REASON_COMPLETE"
      }
    ],
    "totalAccounts": 3
  }
}