Skip to main content
API referenceCandidates

Subnet Candidates

Last updated

GET
/api/v1/subnets/{netuid}/candidates

List unpromoted candidate surfaces for one subnet.

Path Parameters

netuid*integer

The subnet's numeric id on the Bittensor network, as used by the chain itself.

Range0 <= value

Query Parameters

kind?string

Value in

  • "archive"
  • "dashboard"
  • "data-artifact"
  • "docs"
  • "example"
  • "openapi"
  • "repo-registry"
  • "sdk"
  • "source-repo"
  • "sse"
  • "subnet-api"
  • "subtensor-rpc"
  • "subtensor-wss"
  • "website"
provider?string

Restrict the result to rows whose field equals this value. Matched exactly (case-insensitively), not searched for as a substring — an unmatched value yields an empty result rather than an error.

Lengthlength <= 100
state?string

Value in

  • "schema-invalid"
  • "schema-valid"
  • "maintainer-review"
  • "verified"
  • "stale"
  • "rejected"
id?string

Restrict the result to rows whose field equals this value. Matched exactly (case-insensitively), not searched for as a substring — an unmatched value yields an empty result rather than an error.

Lengthlength <= 100
confidence?string

Value in

  • "low"
  • "medium"
  • "high"
fields?string

Comma-separated allow-list projecting the response's primary row collection down to just these fields. A response carrying several collections projects only the primary one -- the others keep their full shape. An unrecognised field is a 400 invalid_query naming both the field and the collection it was resolved against, rather than being ignored.

Match^[\s,]*[A-Za-z_][A-Za-z0-9_]*(\s*,[\s,]*[A-Za-z_][A-Za-z0-9_]*)*[\s,]*$
limit?integer

Maximum number of rows to return in one page (at most 1000). A larger value, or a non-positive one, is rejected with 400 invalid_query -- so a short page means the result set is exhausted, not that the server quietly capped you (#9916). Omitted, every matching row is returned.

Range1 <= value <= 1000
cursor?integer

Row offset to resume from — the numeric position of the first row to return, not an opaque token. Rows inserted since the previous page shift it, so prefer the keyset cursor where a tool offers one.

Range0 <= value
sort?string

Field to sort by — the bare field name only (e.g. sort=total_stake_alpha). Pair with the separate order parameter to choose direction; a combined field:desc token is NOT supported.

Value in

  • "confidence"
  • "id"
  • "kind"
  • "name"
  • "netuid"
  • "provider"
  • "state"
order?string

Sort direction for sort: asc or desc (default desc). This is a separate parameter from sort — e.g. ?sort=emission_share&order=desc.

Value in

  • "asc"
  • "desc"
format?string

Response format override. Use csv to download the transformed list as text/csv; json keeps the default response envelope.

Default"json"

Value in

  • "json"
  • "csv"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/subnets/1/candidates"
{  "data": {    "candidates": [      {        "auth_required": true,        "id": "example",        "kind": "archive",        "name": "Example Subnet",        "netuid": 7,        "provider": "example-provider",        "public_safe": true,        "schema_version": 1,        "source_url": "https://api.metagraph.sh/example",        "state": "schema-invalid",        "url": "https://api.metagraph.sh/example"      }    ],    "contract_version": "2026-06-29.1",    "generated_at": "2026-06-01T00:00:00.000Z",    "name": "Example Subnet",    "netuid": 7,    "notes": "Example description.",    "schema_version": 1,    "slug": "example-subnet"  },  "meta": {    "artifact_path": "example",    "cache": "short",    "contract_version": "2026-06-29.1",    "generated_at": "2026-06-01T00:00:00.000Z",    "observed_through": "2026-06-01T00:00:00.000Z",    "pagination": {      "collection": "example",      "cursor": 1,      "limit": 1,      "next_cursor": 1,      "order": "asc",      "returned": 1,      "sort": "example",      "total": 1    },    "published_at": "2026-06-01T00:00:00.000Z",    "source": "live-cron-prober",    "stale_contract": {      "built_under": "example",      "live": "example"    }  },  "ok": true,  "schema_version": 1}