Goldmine

List purchases in a workspace

Returns a paged list of purchases in the workspace. Supports filtering by contract_id and lifecycle status. Each page carries hydrated entities, so no follow-up GetPurchases is needed.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contractId?string

Optional filter: return only purchases attributed to this contract.

Formatbyte

cursor?string

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

limit?integer

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

Formatint32

status?string

Optional filter: return only purchases in this lifecycle state.

Value in

"PURCHASE_STATUS_UNSPECIFIED" | "PURCHASE_STATUS_PENDING" | "PURCHASE_STATUS_COMPLETED" | "PURCHASE_STATUS_FAILED" | "PURCHASE_STATUS_TRADES_PENDING" | "PURCHASE_STATUS_TRADED" | "PURCHASE_STATUS_ROLLED_BACK"

Response Body

`application/json`

curl -X POST "https://loading/contracts.v1.Contracts/ListPurchases" \  -H "Content-Type: application/json" \  -d '{    "limit": 50,    "cursor": "",    "status": "PURCHASE_STATUS_FAILED"  }'

{
  "purchases": [],
  "nextCursor": ""
}

{
  "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."
}

List purchases in a workspace

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

500application/json

Filter by failed status with no matching purchases

List pending purchases for a specific contract

List the first page of purchases in a workspace

Fetch the next page of traded purchases with a cursor

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`