Endpoint

This endpoint provides a powerful, scalable solution for optimizing blockchain interactions by acting as a load balancer for RPC requests. It allows companies to send blockchain requests through multiple endpoints, ensuring better performance, reduced latency, and increased reliability. The endpoint handles API requests by:

Endpoint: /ep/{apiKey}

Summary

This section outlines the details for the primary API endpoint available for managing blockchain RPC requests and endpoint health. The endpoint handles API requests by:

• Validating API keys to ensure authorized usage.
• Distributing RPC requests across multiple endpoints to prevent bottlenecks and minimize downtime, improving overall system reliability.
• Reporting real-time endpoint latencies so that your application can adapt dynamically, ensuring the fastest and most efficient data retrieval.
• Providing updated details on available endpoints, so you can make informed decisions on which RPC nodes to use at any given time based on current performance and reliability.

By using this endpoint, teams can ensure that their blockchain applications scale efficiently, reducing dependency on any single RPC node. This improves transaction throughput, enhances resilience, and mitigates the risk of downtime or failures caused by network congestion or node unavailability.

Method: POST

Path Parameters:

• apiKey (string) [Required]
  The API key used for authenticating the request.

Request Body:

The request body should be in JSON format with the following fields:

• rpcMethod (string) [Required]
  The RPC method to call for selecting an endpoint.
  Example: "getVersion"

• endpointId (string) [Optional]
  The ID of the endpoint being reported (used when reporting latency or downtime).
  Example: "******-4914-42de-a071-********"

• errorCode (number) [Optional]
  The error code associated with the endpoint. If reporting downtime or latency, this field is required.
  Example: 429, 503

• latency (number) [Optional]
  The latency of the endpoint, in milliseconds.
  Example: 120

Example Request for an Endpoint

{
  "rpcMethod": "getVersion"
}

Example Request to update an Endpoint

{
  "rpcMethod": "getVersion",
  "endpointId": "******-4914-42de-a071-********",
  "errorCode": 429,
  "latency": 120
}

Response Body:

{
  "dateTime": "2024-12-09T12:00:00Z",
  "endpointId": "******-4914-42de-a071-********",
  "endpoint": "https://this-hardworking-service.solanamainnet.quiknode.pro/*************",
  "chain": "solana",
  "network": "mainnet"
}

A successful response returns the following fields:

• dateTime (string) [Required]
  The UTC timestamp when the response is generated (ISO 8601 format).
  Example: "2024-12-09T12:00:00Z"

• endpointId (string) [Required]
  The ID of the selected or reported endpoint.
  Example: "******-4914-42de-a071-********"

• endpoint (string) [Required]
  The URL of the selected endpoint for making blockchain calls. This endpoint is selected by the Load Balancer Example: "https://winter-hardworking-county.solanamainnet.quiknode.pro/*************"

• chain (string) [Required]
  The blockchain network connected to the endpoint.
  Example: "solana"

• network (string) [Required]
  The network of the blockchain (e.g., mainnet, testnet).
  Example: "mainnet"