API Integration

This document provides a high-level overview for developers seeking to integrate with the Noderr Protocol's suite of Application Programming Interfaces (APIs). A comprehensive understanding of these interfaces is essential for building robust and efficient applications on top of the Noderr ecosystem.

Available APIs

Noderr exposes three distinct APIs, each designed to serve specific use cases:

  • GraphQL API: Recommended for applications that require flexible and efficient data querying. This API allows developers to request precisely the data they need, reducing over-fetching and improving application performance.

  • REST API: A standardized, resource-based interface for applications that require conventional, stateless interactions with the protocol. It is ideal for retrieving or modifying specific resources, such as asset prices or protocol statistics.

  • WebSocket API: Designed for applications that require real-time data streaming. This API enables developers to subscribe to live data feeds, such as price updates, governance votes, and network status changes.

Common Use Cases

The following provides a non-exhaustive list of common use cases for each API:

GraphQL API

  • Fetching historical performance data for one or more yield vaults.
  • Querying the details, status, and voting results of governance proposals.
  • Retrieving comprehensive portfolio information for a specific user account.

REST API

  • Obtaining the current market price for a specific asset.
  • Checking the operational status and performance metrics of a node operator.
  • Retrieving basic, high-level statistics about the protocol.

WebSocket API

  • Subscribing to a real-time price feed for one or more assets.
  • Receiving live updates on the status and voting activity of governance proposals.
  • Monitoring the real-time health and status of the Noderr network.

API Documentation

For detailed technical documentation, including endpoint specifications, data schemas, and illustrative code examples, please refer to the comprehensive API Documentation section.

results matching ""

    No results matching ""