Skip to main content
GET
List Instances (v1)

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Query Parameters

limit
integer
default:25

Instances per page. Default 25, max 25. Values ≤ 0 are treated as 5.

Required range: x <= 25
after_token
string

Keyset pagination cursor from the previous response's next_token. An invalid token returns a 400 error.

order_by
string

JSON array of sort directives, e.g. [{"col":"id","dir":"asc"}]. Valid dir values: asc, desc (anything else treated as asc). id is always appended as a tiebreaker. Invalid column returns 400.

select_cols
string
default:["*"]

JSON array of column names to return, e.g. ["id","label","actual_status"]. Use ["*"] for all columns (default). Unknown column names are returned as null.

select_filters
string
default:{}

JSON object of column filters. Supported operators: eq, neq, gt, gte, lt, lte, in, notin. Filterable columns: actual_status, gpu_name, verification, id, label, and other columns stored directly on the contract record. Computed fields (e.g. dph_total, num_gpus) are not filterable and return 400.

Response

Returns {success: true, total_instances, label_counts, instances_found, instances, next_token} with paginated instance data.

success
boolean

True on success

total_instances
integer

Total number of matching instances

label_counts
object

Map of label string to instance count

instances_found
integer

Number of instances in this page

instances
object[]

Array of instance objects

next_token
string

Pagination token for the next page, or null