---
title: "GET /api/v1/candidates"
method: GET
path: "/api/v1/candidates"
tags: ["candidates"]
---

# GET /api/v1/candidates

`GET /api/v1/candidates`

## Request

- Base URL: `https://api.metagraph.sh`
- URL: `https://api.metagraph.sh/api/v1/candidates`
- Auth: none required

List unpromoted candidate surfaces.

## Query parameters

- `netuid` integer
- `kind` 'archive' | 'dashboard' | 'data-artifact' | 'docs' | 'example' | 'openapi' | 'repo-registry' | 'sdk' | 'source-repo' | 'sse' | 'subnet-api' | 'subtensor-rpc' | 'subtensor-wss' | 'website'
- `provider` string
- `state` 'schema-invalid' | 'schema-valid' | 'maintainer-review' | 'verified' | 'stale' | 'rejected'
- `id` string
- `confidence` 'low' | 'medium' | 'high'
- `fields` string
- `limit` integer
- `cursor` integer
- `page_snapshot` string
- `sort` 'confidence' | 'id' | 'kind' | 'name' | 'netuid' | 'provider' | 'state'
- `order` 'asc' | 'desc'
- `format` 'json' | 'csv'

## Response `200`

Canonical artifact wrapped in the Metagraphed API envelope, or the transformed list as text/csv when CSV is requested.

- object
  - `data` object, required
    - `candidates` CandidateSurface[], required
      - `auth` SurfaceAuth, nullable
        - `body_envelope` object: For scheme:signature with location:body -- which key of the outgoing JSON body carries the credential, and which carries the payload it signs.
          - `credential_key` string, required
          - `payload_key` string, required
        - `location` 'header' | 'query' | 'cookie' | 'body': Where the credential is sent. `body` only applies to scheme:signature, whose values are merged into the outgoing JSON request body.
        - `name` string: The single header the credential goes in.
        - `names` string[]: The header SET, for schemes that need more than one (signature schemes send hotkey + nonce + signature together). Present instead of `name`, not alongside it.
        - `scheme` 'none' | 'bearer' | 'api-key' | 'basic' | 'oauth2' | 'signature' | 'custom', required: `signature` means the request is signed per-call (a hotkey/nonce/signature header set, see `names`), not a static token.
        - `scopes_note` string: How the requirement was established -- often a live-checked 401, because a subnet's own OpenAPI frequently declares no securitySchemes at all.
        - `token_url` string
        - `value_format` string
      - `auth_required` boolean, required
      - `confidence` 'low' | 'medium' | 'high'
      - `confirmed_by` string[]
      - `id` string, required
      - `kind` 'archive' | 'dashboard' | 'data-artifact' | 'docs' | 'example' | 'openapi' | 'repo-registry' | 'sdk' | 'source-repo' | 'sse' | 'subnet-api' | 'subtensor-rpc' | 'subtensor-wss' | 'website', required
      - `name` string, required
      - `netuid` integer, required
      - `provider` string, required
      - `public_safe` boolean, required
      - `rate_limit` SurfaceRateLimit
        - `burst` integer
        - `cost_notes` string
        - `requests` integer, required
        - `scope` 'per-key' | 'per-ip' | 'global' | 'unknown'
        - `window` string, required
      - `rate_limit_notes` string
      - `review_notes` string
      - `schema_version` 1, required
      - `source_tier` 'native-chain' | 'provider-claimed' | 'third-party-index' | 'community-docs'
      - `source_type` string
      - `source_url` string, uri, required
      - `source_urls` string[]
      - `state` 'schema-invalid' | 'schema-valid' | 'maintainer-review' | 'verified' | 'stale' | 'rejected', required
      - `subnet_name` string, nullable
      - `superseded_by` string, nullable
      - `url` string, uri, required
      - `verification` VerificationResult
        - `archived` boolean
        - `candidate_id` string, required
        - `classification` 'live' | 'redirected' | 'auth-required' | 'dead' | 'unsafe' | 'unsupported' | 'rate-limited' | 'transient' | 'timeout' | 'content-mismatch' | 'wrong-chain' | 'unknown', required
        - `confidence_score` integer
        - `content_type` string, nullable
        - `default_branch` string, nullable
        - `description` string, nullable
        - `error` string, nullable
        - `github_api_status` integer
        - `github_api_url` string, uri
        - `homepage` string, nullable
        - `html_url` string, uri
        - `kind` 'archive' | 'dashboard' | 'data-artifact' | 'docs' | 'example' | 'openapi' | 'repo-registry' | 'sdk' | 'source-repo' | 'sse' | 'subnet-api' | 'subtensor-rpc' | 'subtensor-wss' | 'website'
        - `last_push_at` string, nullable
        - `latency_ms` integer, nullable
        - `method_tested` string
        - `name` string
        - `netuid` integer
        - `private_redirect_blocked` boolean
        - `provider` string
        - `quality_signals` SurfaceQualitySignals
          - `archived` boolean
          - `content_type_matches_kind` boolean
          - `has_default_branch` boolean
          - `has_recent_push_metadata` boolean
          - `public_safe` boolean
          - `rate_limited` boolean
          - `redirected` boolean
          - `source_tier` 'native-chain' | 'provider-claimed' | 'third-party-index' | 'community-docs'
          - `transient_failure` boolean
        - `redirect_target` string, uri, nullable
        - `source_tier` 'native-chain' | 'provider-claimed' | 'third-party-index' | 'community-docs'
        - `source_type` string
        - `source_url` string, uri
        - `source_urls` string[]
        - `status` 'ok' | 'degraded' | 'failed' | 'unknown', required
        - `status_code` integer, nullable
        - `topics` string[]
        - `url` string, uri, required
        - `verified_at` string, required
    - `contract_version` string
    - `count` integer: How many candidates the list carries, where the producer counts them.
    - `generated_at` string, required
    - `notes` union: Public-safe notes; may be a string or a string list depending on the adapter.
      - string
      - string[]
    - `schema_version` 1, required
  - `meta` ResponseMeta, required
    - `artifact_path` string
    - `cache` 'short' | 'standard' | 'static'
    - `catalog_paging` object
      - `reason` 'catalog_changed' | 'catalog_budget_exceeded' | 'catalog_unavailable', required
    - `contract_version` string, required
    - `generated_at` string, nullable: Deterministic build content marker (epoch by default); not a wall clock. Use published_at for human-facing freshness.
    - `observed_through` string, date-time, nullable: How far the tier that answered this request has observed at all. A payload reporting no activity at or before this time is a measured absence; one whose subject is newer is outside coverage, not empty. Null when the horizon is unreadable.
    - `pagination` PaginationMeta
      - `collection` string, required
      - `cursor` integer, required
      - `limit` integer, required
      - `next_cursor` integer, nullable, required
      - `order` 'asc' | 'desc'
      - `returned` integer, required
      - `snapshot` string: Present only for page_snapshot paging. Echo as page_snapshot on subsequent pages; a changed collection or query requires a restart.
      - `sort` string, nullable
      - `total` integer, required
    - `published_at` string, date-time, nullable: Real publish time from the KV latest pointer, distinct from generated_at. Null before the first publish or when the control KV is unbound.
    - `source` string
    - `stale_contract` object: Present ONLY when the served artifact was built under an older contract than the live one (serve-time drift, #1001) — the body may predate a schema change. Mirrored on the x-metagraph-stale-contract response header for monitoring.
      - `built_under` string, required: Contract version the served artifact was built under.
      - `live` string, required: Current (live) contract version the Worker is running.
  - `ok` true, required
  - `schema_version` 1, required

## Other responses

- `304`: ETag matched and the cached response is still valid.
- `400`: Query parameters were malformed or unsupported.
- `404`: Artifact or API route was not found.
- `405`: HTTP method is not supported.
- `500`: Unexpected backend error.

---

[API](https://skmtc.dev/metagraph/apis/metagraphed-api.md) · [All operations](https://skmtc.dev/metagraph/apis/metagraphed-api/llms.txt) · [OpenAPI document](https://skmtc.dev/metagraph/apis/metagraphed-api/revisions/e29036024bb1?raw)