surfaces

List every published surface across the registry

List curated public surfaces.

get/api/v1/surfaces

Request

  • Base URL: https://api.metagraph.sh
  • URL: https://api.metagraph.sh/api/v1/surfaces
  • Auth: none required

Query parameters

netuidinteger

Subnet id (netuid). 0 is the root subnet -- a stake-allocation construct rather than a running subnet. It IS present in the registry collections, but it is excluded from application-subnet counts, and stake on it is denominated in TAO rather than in a subnet alpha token, so its economics are not directly comparable to a running subnet's.

kind'archive' | 'dashboard' | 'data-artifact' | 'docs' | 'example' | 'openapi' | 'repo-registry' | 'sdk' | 'source-repo' | 'sse' | 'subnet-api' | 'subtensor-rpc' | 'subtensor-wss' | 'website'
providerstring

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.

idstring

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.

auth_required'true' | 'false'
public_safe'true' | 'false'
rate_limited'true' | 'false'
fieldsstring

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.

limitinteger

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.

cursorinteger

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.

page_snapshotstring

Opt into checked collection paging: send start at cursor 0, then echo the returned snapshot (REST meta.pagination.snapshot; MCP snapshot) with subsequent numeric cursors, or follow the returned Link URLs. A changed result or query returns REST 400 invalid_query with catalog_changed, or MCP catalog_restart_required; restart from cursor 0. This does not retain old rows or continue across mutations. Checked requests bypass page caches. At most 5000 matching rows, 16777216 canonical bytes and 64 nesting levels can be verified; narrow filters on catalog_budget_exceeded. Omit for legacy offset paging.

sort'id' | 'kind' | 'name' | 'netuid' | 'provider'

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.

order'asc' | 'desc'

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

format'json' | 'csv'

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

Response

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

oktrue required
schema_version1 required

Changes

No recorded changes to this operation across all 1 revision of this API.