Introduction
Welcome to GORBIO Powerhouse documentation. Our platform provides real-time blockchain analytics with a focus on power usage and sustainability metrics.
What is GORBIO?
GORBIO is a comprehensive blockchain analytics platform that helps track and optimize blockchain energy consumption. Our platform uses advanced machine learning algorithms to provide accurate insights and predictions.
This documentation is regularly updated. Make sure you're viewing the latest version.
Key Features
- Real-time power usage tracking
- Machine learning-based predictions
- Sustainability scoring system
- Comprehensive API access
Code Example
// Fetch power usage from GORBIO API
async function getPowerUsage(blockchainName) {
const response = await fetch(`https://gor.bio/api?blockchain_name=${blockchainName}`);
const data = await response.json();
console.log(data.currentWattage);
}
// Example usage with Ethereum
getPowerUsage('ethereum');
Quick Start
Get up and running with GORBIO in minutes.
Prerequisites
- Node.js v14 or higher
- Basic JavaScript knowledge
Installation
Make a simple API call from any environment:
fetch('https://gor.bio/api?blockchain_name=ethereum')
.then(response => response.json())
.then(data => console.log(data));
Next Steps
After verifying the basic connection works, explore:
- API Endpoints for more functionality
- Integration Guide for production setup
- Rate Limits for usage guidelines
Blockchain Analytics
Understand how GORBIO analyzes blockchain networks.
Data Sources
We aggregate data from:
- Public blockchain nodes
- Mining pool statistics
- Energy market data
Analytics Features
- Transaction volume analysis
- Network hashrate monitoring
- Energy consumption patterns
Power Usage
Track and analyze blockchain power consumption in real-time.
Measurement Methodology
Power usage is calculated using:
- Hardware efficiency metrics
- Network difficulty
- Regional energy data
Data Format
{
"currentWattage": 156000000, // watts
"timestamp": "2025-04-05T12:00:00Z",
"trend": "stable"
}
Sustainability Metrics
Evaluate blockchain environmental impact.
Metrics Provided
- Carbon footprint (tons CO2e)
- Renewable energy percentage
- Efficiency score (0-100)
Example Response
{
"carbonFootprint": 85000,
"renewablePercent": 45.5,
"efficiencyScore": 82
}
Authentication
The GORBIO API is publicly accessible and requires no authentication.
Access
Anyone can make GET requests to our API endpoints. Simply use the endpoint URLs as described in the Endpoints section.
While no authentication is required, please respect our rate limits to ensure fair access for all users.
Endpoints
Available API endpoints for GORBIO.
Power Usage
GET /api?blockchain_name={name}
Parameters:
- blockchain_name (required): The name of the blockchain to query. See supported blockchains below.
Supported Blockchains
The following blockchains are currently supported by the Power Usage endpoint:
Blockchain Name | Parameter Value | Description |
---|---|---|
Bitcoin | bitcoin |
The original cryptocurrency using SHA-256 Proof-of-Work. |
Ethereum | ethereum |
Leading smart contract platform (post-merge, Proof-of-Stake). |
Etica | eticacoin |
A blockchain focused on medical research using Etchash. |
Ethereum Classic | ethereumclassic |
The original Ethereum chain, still using Etchash Proof-of-Work. |
Ravencoin | ravencoin |
A blockchain for asset tokenization using KawPow. |
Ergo | ergo |
A smart contract platform using Autolykos Proof-of-Work. |
Conflux | conflux |
A high-throughput blockchain using Octopus algorithm. |
Use the exact Parameter Value
in the blockchain_name
query parameter. Case-insensitive.
Sustainability
GET /api/sustainability?blockchain_name={name}
Note: Sustainability data availability may vary by blockchain.
Rate Limits
API usage restrictions to prevent excessive requests from single IPs.
Limits
- 100 requests/minute per IP
- 10,000 requests/day per IP
Response Headers
When approaching or exceeding limits, check these headers:
- X-Rate-Limit-Limit: Maximum requests allowed
- X-Rate-Limit-Remaining: Remaining requests in period
- X-Rate-Limit-Reset: Time when limit resets (UTC epoch seconds)
Handling Limits
async function fetchWithRateLimit(url) {
const response = await fetch(url);
if (response.status === 429) {
const retryAfter = response.headers.get('Retry-After') || 60;
console.log(`Rate limited. Retrying after ${retryAfter} seconds`);
await new Promise(resolve => setTimeout(resolve, retryAfter * 1000));
return fetchWithRateLimit(url);
}
return response.json();
}
// Usage
fetchWithRateLimit('https://gor.bio/api?blockchain_name=ethereum')
.then(data => console.log(data));
Integration Guide
Steps for production integration.
Best Practices
- Cache responses when possible
- Implement rate limit handling
- Use error handling for 429 responses
Best Practices
Optimize your GORBIO integration.
Recommendations
- Use exponential backoff for retries
- Batch requests when possible
- Respect rate limits
- Validate data before processing
Examples
Practical implementation examples.
Full Integration
class GorbioClient {
constructor() {
this.baseUrl = 'https://gor.bio/api';
}
async getPowerUsage(blockchainName) {
const url = `${this.baseUrl}?blockchain_name=${blockchainName}`;
const response = await fetch(url);
if (response.status === 429) {
const retryAfter = response.headers.get('Retry-After') || 60;
await new Promise(resolve => setTimeout(resolve, retryAfter * 1000));
return this.getPowerUsage(blockchainName);
}
return response.json();
}
}
const client = new GorbioClient();
client.getPowerUsage('eticacoin')
.then(data => console.log(data.currentWattage));