Requests #

• GET https://onionoo.torproject.org/summary returns a Summary Document
• GET https://onionoo.torproject.org/details returns a Detail Document
• GET https://onionoo.torproject.org/bandwidth demo returns a Bandwidth Document
• GET https://onionoo.torproject.org/weights demo returns a Weights Document

Summary Document # example request

• required string relays_published

  UTC timestamp (YYYY-MM-DD hh:mm:ss) when the last known relay network status consensus started being valid. Indicates how recent the relay weights documents in this document are.

• required array relays

  Array of objects representing relay weights documents. Each array object contains the following key-value pairs

  • optional string n

    Relay nickname consisting of 1-19 alphanumerical characters. Omitted if the relay nickname is "Unnamed".

  • required string f

    Relay fingerprint consisting of 40 upper-case hexadecimal characters.

  • required array a

    Array of IPv4 or IPv6 addresses where the relay accepts onion-routing connections or which the relay used to exit to the Internet in the past 24 hours. The first address is the primary onion-routing address that the relay used to register in the network, subsequent addresses are in arbitrary order. IPv6 hex characters are all lower-case.

  • required string r

    Boolean field saying whether this relay was listed as running in the last relay network status consensus.

• required string bridges_published

  UTC timestamp (YYYY-MM-DD hh:mm:ss) when the last known bridge network status was published. Indicates how recent the bridge summaries in this document are.

• required array bridges

  Array of objects representing bridge summaries. Each array object contains the following key-value pairs

  • optional string n

    Bridge nickname consisting of 1-19 alphanumerical characters. Omitted if the bridge nickname is "Unnamed".

  • required string h

    SHA-1 hash of the bridge fingerprint consisting of 40 upper-case hexadecimal characters.

  • required string r

    Boolean field saying whether this bridge was listed as running in the last bridge network status.

Detail Document #

• required string relays_published
• optional array relays Relay Detail
• required string bridges_published
• optional array bridges Bridge Detail

Bridge Summary#

used in: Summary Document

Bridge Detail#

used in: Detail Document

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Deleniti, incidunt.

• required string nickname
• required string hashed_fingerprint
• required array or_addresses Address
• required string last_seen
• required string first_seen
• required boolean running
• optional array flags Flag
• optional string last_restarted
• optional number advertised_bandwidth
• optional string platform
• optional string pool_assignment

Relay Summary#

used in: Summary Document

• optional string n
• required string f
• required array a Address
• required string r

Relay Detail#

used in: Detail Document

• required string nickname
• required string hashed_fingerprint
• required array or_addresses Address
• optional array exit_addresses Address
• optional array dir_addresses Address
• required string last_seen
• required string last_changed_address_or_port
• required string first_seen
• required boolean running
• optional array flags Flag
• optional string country
• optional string country_name
• optional string city_name
• optional number latitude
• optional number longitude
• optional string as_name
• optional string as_number
• required number consensus_weight
• optional string host_name
• optional string last_restarted
• optional number bandwidth_rate
• optional number bandwidth_burst
• optional number observed_bandwidth
• optional number advertised_bandwidth
• optional array exit_policy Exit Policy
• optional array exit_policy_summary Exit Policy Summary
• optional string contact
• optional string platform
• optional array family Fingerprint or Nickname
• optional string pool_assignment