Anyone Docs
  • 🔷The Documentation For Anyone
    • About
    • FAQ
  • 🔷Relay Setup
    • Get Started
    • Installation and Usage
      • Setting Your Environment
        • Virtualization on Windows
        • Virtualization on macOS
        • Install Ubuntu Server 22.04
        • Server management with SSH in Windows and macOS
      • Install Anon on Linux
      • Install Anon using the apt repository
      • Update Anon and accept terms and conditions
      • Install Anon in Docker
      • Configure SOCKS5 Proxy for Anyone
      • Install Anyone Exit Relay
    • Troubleshooting Common Issues
      • Diagnosing CGNAT and Public IPv4
      • Confirm ORPort Reachability
    • Firewall and Network Configurations
      • Router Port Forwarding
      • Install and Configure Firewall
    • Advanced Configuration and Troubleshooting
      • Configure IPv4 and IPv6
      • DoS mitigation parameters
    • Relay Operator Standards
    • Exit Relay Guidelines
  • 🔷Hardware Setup
    • Setup Guide
    • Description and Specifications
    • Relay Control Panel
      • Home
      • Network Settings
      • Relay Settings
      • Relay Family
      • Proxy Settings BETA
      • Change Password
      • Logs
      • Update
    • Update (Using USB)
    • Update to WEB 3.2.0 (Using UI)
    • Troubleshooting and additional configuration
      • Router Port Forwarding
      • Diagnosing CGNAT and Public IPv4
    • Router Setup
  • 🔷Security and Privacy
    • VPS Hardening
  • 🔷Rewards Dashboard
    • Registering to the Rewards Program
    • Accessing the Rewards Dashboard
    • Using the Rewards Dashboard
    • Rewards Status
  • 🔷Anyone SDK
    • NPM SDK
      • Install NPM Package
      • Run as Library
        • Anon
        • AnonSocksClient
        • AnonControlClient
      • Run from CLI
      • Tutorials
        • Hello Anon World I
        • Hello Anon World II
        • Circuit Control I
        • Circuit Control II
    • Native SDK
      • Anyone Client Releases
      • MAN - Anon Manual
      • Tutorials
        • Anyone Services I
        • Anyone Services II
    • iOS SDK [Beta]
      • Manual Install - CocoaPods
  • 🔷Connect to Anyone
    • Connecting to Linux
      • [Beta] One-Click Linux Setup
    • Connecting to macOS
      • macOS with NPM
      • [Beta] One-Click macOS Setup
    • Connecting to Windows
      • [Beta] One-Click Windows Setup
    • Individual Applications with Anyone
    • Connect Through Hardware
  • 🔷Tokenomics
    • Introduction
    • Token Distribution
      • Token Outflow
      • Other Tokens
    • Relay Rewards
      • Lock Requirement
      • Lock Adjustments
      • Reward Multipliers
    • Additional Roles
      • Authorities and Staking
      • Governance Voting
    • Premium Circuits
      • Premium Circuits
      • Premium Circuits: Metrics
    • Summary
      • Value Accrual Summary
      • Rewards Case Study
    • Appendix
      • M Derivation
      • Risk Equation Derivation
  • 🔷Resources
    • Community and Customer Support
    • Links
    • Token
    • Whitepaper
    • Roadmap
    • API
      • REST
      • [Future] GraphQL
Powered by GitBook
On this page
  • API Specification
  • Network-Wide API
  • Per-User Search
  • POST APIs
  • Other Environments

Was this helpful?

  1. Resources
  2. API

REST

PreviousAPINext[Future] GraphQL

Last updated 7 months ago

Was this helpful?

The Anyone Network comes with a series of public REST APIs accessible by anyone who wants to investigate the live status of the network or their specific relay. This API complements the older Arweave metrics dumps that can be investigated by GraphQL requests (section coming soon).

The official domain for our technical endpoints is https://anyone.tech

And the API is accessible at https://api.ec.anyone.tech

API Specification

Network-Wide API

Total Active Relays (Latest)

{
all: Total number of relays visible in latest consensus file,
offline: Relays recently running but currently offline,
online: Relays currently online
}

Total Active Relays (Over Time)

{
all[]: Total relays in latest consensus file over time (hourly),
offline[]:  Total relays recently offline over time (hourly),
online[]:  Total relays online over time (hourly)
}
{
all: Sum of observed bandwidth for all relays in consensus file.
offline: Sum of observed bandwidth for all recently offline relays.
online: Sum of observed bandwidth for all offline relays
}
{
all: Sum of observed bandwidth for all relays in consensus file over time.
offline: Sum of observed bandwidth for all recently offline relays over time.
online: Sum of observed bandwidth for all offline relays over time. 
}

Additional parameters to be appended at the end of the query

from: T – start time (s, m, d)
to: T – end time (s, m, d)
interval: interval 

Example: https://api-dev.dmz.ator.dev/total-relays?from=3d&to=now&interval=12h
[ // list of all relays as H3 datapoints 
    {
    "index: Unique H3 Hex ID
    "relayCount": Number of relays situated in the area of this cell
    "geo": Center of cell coordinates
    "boundary"[]: Cell boundary coordinates
    },
]

Per-User Search

{
"fingerprint": fingerprint of the relay,
"running": whether the relay is running,
"consensus_weight": Consensus weight score 
}
{
isAnon: Whether the un
IP: Your IP address visible to external sites
}
(Visual) Tells you whether you have routed through Anon.

POST APIs

Other Environments

Total Network Bandwidth

Total Network Bandwidth (Over Time)

Relay Map

Relay Lookup

Anon Check (API)

Anon Check (UI)

Hardware Authentication Endpoint

To search for your relay in the stage environment: 🔗

🔷
https://api.ec.anyone.tech/total-relays-latest
https://api.ec.anyone.tech/total-relays
https://api.ec.anyone.tech/total-observed-bandwidth-latest
https://api.ec.anyone.tech/total-observed-bandwidth
https://api.ec.anyone.tech/relay-map
https://api.ec.anyone.tech/relays/
https://check.en.anyone.tech/
api/ip
https://check.en.anyone.tech
https://api.ec.anyone.tech/relays
https://api-stage.ec.anyone.tech