---
title: "Search Tor relays"
method: GET
path: "/api/v1/network/tor/search"
tags: ["Sugra NetAtlas"]
---

# Search Tor relays

`GET /api/v1/network/tor/search`

## Query parameters

- `q` string, required
- `limit` integer

## Response `200`

Successful Response

- NetworkTorSearchData
  - `relay_count` union
    - integer
    - number
  - `bridge_count` union
    - integer
    - number
  - `relays` NetworkTorSearchNetworkRelay[], nullable
    - `nickname` string, nullable
    - `fingerprint` string, nullable
    - `or_addresses` string[], nullable
    - `flags` string[], nullable
    - `country` string, nullable
    - `country_name` string, nullable
    - `as` string, nullable
    - `as_name` string, nullable
    - `consensus_weight` union
      - integer
      - number
    - `advertised_bandwidth` union
      - integer
      - number
    - `version` string, nullable
  - `bridges` NetworkTorSearchNetworkBridge[], nullable
    - `nickname` string, nullable
    - `or_addresses` string[], nullable
    - `flags` string[], nullable
    - `advertised_bandwidth` union
      - integer
      - number
    - `version` string, nullable
  - `_meta` AtlasMeta
    - `product` string, required — Always 'Sugra NetAtlas'.
    - `atlas_built_at` string, nullable — UTC ISO-8601 build time of the atlas snapshot that answered; null only when no connector can vouch for one.
    - `privacy_signal_version` string, required — Version of the privacy/default-route signal set.
    - `confidence` string, required — Confidence of the privacy/default-route signal: high, medium or low.
    - `accuracy` string, required — Accuracy class of the answer (e.g. public, city, country, unknown).
    - `sources` string[], required — Sugra-branded upstream families that contributed.
    - `data_time` string, nullable — When the DATA is from (UTC ISO-8601); null when nothing can vouch for it.
    - `response_time` string, required — When Sugra answered (UTC ISO-8601).
    - `partial` boolean, required — True when at least one upstream failed and the answer is incomplete.
    - `geo_confidence` string, nullable — IP-geo responses only: how trustworthy the resolved city/country is (downgrades for anycast/CDN).
    - `served_from` string, nullable — Where the answer came from (local atlas, live proxy, cache).
    - `fallback_reason` string, nullable — Why a fallback path served the answer, when one did.
    - `sources_coverage` unknown
    - `cached` boolean, nullable — True when the answer was served from the response cache (routes that cache whole answers).
    - `atlas_sha256` string, nullable — SHA-256 of the atlas snapshot (sources/coverage).
    - `endpoint_version` string, nullable — Endpoint contract version where a route declares one (sources/coverage: v1).

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

## Changes

- **2026-08-28** `560e8847c7b3` — 4 breaking
  - response property `bridges/anyOf[subschema #1]/items/flags/anyOf[subschema #1]/items/` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `bridges/anyOf[subschema #1]/items/or_addresses/anyOf[subschema #1]/items/` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `relays/anyOf[subschema #1]/items/flags/anyOf[subschema #1]/items/` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `relays/anyOf[subschema #1]/items/or_addresses/anyOf[subschema #1]/items/` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
- **2026-08-22** `914af3d38c7c` — 1 breaking, 5 info
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - added the optional property `_meta` to the response with the `200` status
  - added the optional property `bridge_count` to the response with the `200` status
  - added the optional property `bridges` to the response with the `200` status
  - …2 more
- …earlier changes not shown

[Full history](https://skmtc.dev/sugra/apis/sugra-api/changes/api/v1/network/tor/search/get.md)

---

[API](https://skmtc.dev/sugra/apis/sugra-api.md) · [All operations](https://skmtc.dev/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sugra/sugra-api/revisions/87582f2e0110/schema)