Presearch Docs
Presearch WebsiteNode SetupKeyword StakingSupport
  • Presearch Project
    • 🏠Welcome to Presearch πŸ‘‹
    • πŸͺ™Tokenomics
      • Contract Security
      • Liquidity Providing Uniswap
      • Liquidity Providing Aerodrome
    • πŸ’°PRE Purchasing Options
      • How to Buy PRE Tokens in the United States Using USD: A Comprehensive Guide
      • Supported Exchanges
      • Buy with Credit Card
      • How to Swap PRE in Trust Wallet
      • How to Swap PRE in Metamask Wallet
      • How to buy PRE in AhoraCrypto.com
    • πŸ—ΊοΈRoadmap
    • πŸ›‘οΈWeb3 - Safety, Troubleshooting & Best practices
    • ❓General FAQ
      • Which blockchain do PRE Tokens operate on?
      • How many tokens can I buy?
      • When I buy tokens, how do I pay?
      • When will I receive my tokens?
      • What can I use my tokens for?
      • How to withdraw tokens from Presearch?
      • What Wallets accept PRE?
      • Referral Program
      • How can I help promoting Presearch?
      • How can I contact the support team?
      • Who do I contact for marketing / promotional offers?
      • Presearch vision paper
  • Presearch Engine
    • ⭐What is Presearch Engine?
    • ❓Presearch Engine FAQ
      • How to set Presearch as the Default Search Engine on Desktop
      • How to Set Presearch as Your Default Search Engine on the Chrome App in iOS
      • How to Set Presearch as Your Default Search Engine on the Chrome App in Android
      • Am I tracked when I use Presearch?
      • How to use the Maps
      • How to Change the Color of the Search Engine
      • How to use the Testnet/Presearch engine
      • Why are my reward tokens not increasing when I search?
      • What is 'Authentic Search'?
      • What is Rewards Verification?
      • How to use AI
      • How to Add New Search Providers to your Presearch Dashboard
      • How to Change Password
      • How to Update profile
    • πŸ”ŽMetaSearch
    • NSFW Spicy Mode
  • PreGPT AI
    • ⭐What is PreGPT 2.0?
    • πŸ€–How to use PreGPT 2.0
    • ❓PreGPT FAQ
      • General usage
      • Subscription
      • Service operation
      • AI model limitations
      • Roadmap & Improvements
      • Policy
  • Nodes
    • ⭐What is a Node?
      • Hardware and system requirements
    • βš™οΈNode Setup Instructions
      • Generic installation instructions
      • Node Configuration Parameters
      • Individual Setup for various VPS providers
        • Running a node on FluxOS
          • Flux Node Grandfathering
        • Running a node on Akash
        • Running a node on ThreeFold
        • Running a Node on AWS
        • Running a Node on Racknerd
        • Running a node on Microsoft Azure
        • Running a node on Linux VPS
        • Running a node on Stack OS
      • Setup Nodes on Raspberry Pi
    • πŸ”§Troubleshooting and maintenance
      • Backing Up and Migrating Nodes
      • Alternative to Backing up nodes
      • Backup method with Docker Desktop for Windows
      • Backup method for Linux
    • πŸŽ‡Node Rewards
    • πŸ” API Access
    • 🫐Preberry
    • ❓Nodes FAQ
      • Can I already run a Presearch node?
      • Is Docker required to run a Presarch node?
      • Is there a node network explorer or some kind of overview page?
      • Will there be IPv6 support for Presearch nodes?
      • Can I run Presearch node besides Flux node?
      • IOS application to view node statistics
  • Keyword Staking
    • ⭐What is Keyword Staking?
    • 🀝Strategy for Staking PRE
    • πŸ“¦Ads Pricing - How much does it cost to advertise on Presearch?
    • ❓Keywords FAQ
      • How can I see keywords traffic?
      • How to report bogus/abusive ADs from Keyword staking?
  • Search Staking and Usage Rewards
    • ⭐What are Usage rewards?
      • How do PRE rewards work
      • How to claim search rewards
    • ❓Search Staking FAQ
      • How to use Search staking?
      • How to use the calculator for Search Stake
  • AD-FREE SEARCH FEATURE
    • How to use the Ad-Free Search Feature
  • Support
    • πŸ†˜Presearch Support
    • πŸ—žοΈPresearch News
    • πŸ“Press Release
  • NFTs
    • πŸ›£οΈ"The Road to Mainnet"
    • πŸ’»Supported Wallets
  • Community
    • πŸ› οΈCommunity Projects
    • πŸ§‘β€πŸ«Community Tutorials
      • Intense Investor
      • Martin Valk
      • Your Friend Andy
      • Keith Laye
      • Passive Aggressive Income
      • Lefty Chris - How to Create a Presearch Node
      • Crypto Laymen
      • Modo Tech
      • Mechanic Joe
      • TheNodeCatcher
  • apps
    • πŸ“±iOS
    • πŸ€–Android Browser
Powered by GitBook
On this page
  • Node Status API
  • API Request Rate Limits:

Was this helpful?

Edit on GitHub
  1. Nodes

API Access

PreviousNode RewardsNextPreberry

Last updated 1 year ago

Was this helpful?

Your API key can be found at the bottom of the node dashboard page for any of your nodes:

Node Status API

GET https://nodes.presearch.com/api/nodes/status/:api_key

Return the current status of all your nodes as well as (optionally) aggregated data for those nodes. Notes: * The connected and disconnected parameters cannot both be set to "false". In this case the default (connected only) will be used. * Replace :api_key with your API key. For example: /api/nodes/status/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Path Parameters

Name
Type
Description

api_key

string

Your personal Node API key (this can be found at the bottom of the node dashboard page for any of your nodes: https://nodes.presearch.org/dashboard

Query Parameters

Name
Type
Description

public_keys

string

A comma-separated list of node public keys. If this parameter is specified, only those nodes will be returned. This parameter overrides the connected, disconnected, and include_inactive parameters (ie: if the specified nodes are found they will be returned regardless of their current status).

start_date

string

UTC date/time in ANSI format (Y-m-d H:i) - Start of reporting period for any node activity and stats. (Default: 24 hours before current time)

end_date

string

UTC date/time in ANSI format (Y-m-d H:i) - End of reporting period for any node activity and stats. (Default: current time)

stats

boolean

true|false - Whether or not to include aggregated historical stats for the nodes returned. Dates to aggregate between are specified with the start_date and end_date parameters. (Default: false)

connected

boolean

true|false - Currently connected nodes should be included in the returned list (Default: true)

disconnected

boolean

true|false - Currently disconnected nodes should be included in the returned list (Default: true)

include_inactive

boolean

true|false - whether to also include nodes that haven't been active during the specified timeframe set by start_date and end_date (Default: false)

{
    success: true,
    start_at: "2021-01-01T00:00:00Z",
    end_at: "2021-12-31T23:59:59Z",
    nodes: {
        <node public key>: {
            meta: {
                description: "your description",
                url: "your external url",
                server_description: "description provided during connect",
                server_url: "external url provided during connect",
                gateway_pool: "production",
                remote_addr: "127.0.0.1",
                version: "9.9.9"            
            },
            status: {
                connected: true,
                blocked: false,
                in_current_state_since: "2021-01-01T00:00:00Z",
                minutes_in_current_state: 999
            },
            period: {
                period_start_date: "2021-01-01T00:00:00Z",
                period_end_date: "2021-12-31T23:59:59Z",
                period_seconds: 525600,
                connections: {
                    num_connections: 99,
                    most_recent_connection: "2021-01-01T00:00:00Z"
                },
                disconnections: {
                    num_disconnections: 99,
                    most_recent_disconnection: "2021-12-31T23:59:59Z"
                },
                total_uptime_seconds: 999,
                uptime_percentage: 99,
                avg_uptime_score: 99,
                avg_latency_ms: 99,
                avg_latency_score: 99,
                total_requests: 999,
                avg_success_rate: 99,
                avg_success_rate_score: 99,
                avg_reliability_score: 99,
                avg_staked_capacity_percent: 99,
                avg_utilization_percent: 99,
                total_pre_earned: 99.9999
            }
        }
    }
}
{
    // Response
}

API Request Rate Limits:

The node status API enforces the following request rate limits PER NODE to ensure reasonable use of the API by node operators:

Requests without stats (default, stats=false): Up to 4 requests per minute Requests with stats (stats=true): Up to 4 requests per hour

If you request status for any node more frequently than this your API will be temporarily blocked.

πŸ” 
https://nodes.presearch.com/dashboard