Skip to main content
API referenceSearch

Search Index

Last updated

GET
/api/v1/search-index

Fetch the slim search index — the same documents as /search without the per-document token blobs, for fast browser typeahead and listing.

Query Parameters

type?string

Value in

  • "subnet"
  • "surface"
  • "provider"
netuid?integer
Range0 <= value
q?string
Lengthlength <= 200
fields?string
Match^[A-Za-z_][A-Za-z0-9_]*(,[A-Za-z_][A-Za-z0-9_]*)*$
limit?integer
Range1 <= value <= 1000
cursor?integer
Range0 <= value
sort?string

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

Value in

  • "netuid"
  • "slug"
  • "title"
  • "type"
order?unknown

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"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/search-index"
{  "data": {    "contract_version": "2026-06-29.1",    "document_count": 1,    "documents": [      {        "artifact_path": "example",        "id": "example",        "title": "Example Subnet",        "type": "subnet"      }    ],    "generated_at": "2026-06-01T00:00:00.000Z",    "notes": "Example description.",    "schema_version": 1  },  "meta": {    "artifact_path": "example",    "cache": "short",    "contract_version": "2026-06-29.1",    "generated_at": "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}