API GHI – Documentation Officielle
1. Présentation générale
Le Global HashCost Index (GHI) fournit une API professionnelle permettant d’accéder aux modèles institutionnels de coût de production du Bitcoin. L’API est conçue pour les équipes d’investissement, d’analyse quantitative, de gestion du risque, de conformité et d’infrastructures data.
La documentation API regroupe l’ensemble des normes GHI, les cycles de version, la stabilité contractuelle, et les garanties de compatibilité nécessaires à un usage institutionnel. Toutes les données du Sandbox Engine sont offertes en accès libre ; des éditions premium (données enrichies, historiques étendus, granularité plus fine) seront disponibles via un contrat institutionnel.
2. Versions disponibles
Deux versions stables sont maintenues pour les besoins de continuité opérationnelle :
| Version | Statut | Description | Lien |
|---|---|---|---|
| API v1.1 | Active (stable) | Nouvelle structure de données unifiée, endpoints supplémentaires, métadonnées enrichies. | Documentation |
| API v1.0 | Supportée (legacy) | Version historique ; maintenue pour compatibilité des intégrations existantes. | Documentation |
Les nouvelles intégrations doivent utiliser API v1.1.
3. Garanties de stabilité (Institutionnel)
La politique de stabilité GHI garantit :
- aucune rupture de structure entre versions mineures (1.x) ;
- un préavis de dépréciation pour tout élément modifié ou retiré ;
- une compatibilité ascendante pour les usages institutionnels ;
- une volumétrie stable et des formats strictement définis ;
- une documentation synchronisée à chaque release officielle.
Ces engagements sont adaptés aux environnements dépendants de pipelines automatiques (ETL, ingestion temps-réel, back-tests quantitatifs, SI bancaire).
4. Panorama des endpoints
Les endpoints suivants sont fournis en accès stable. Les détails complets sont disponibles dans les pages dédiées (API Reference et API v1.1).
| Endpoint | Description | Version |
|---|---|---|
/v1/ghi/snapshot |
Vue globale et régionale des coûts de production. | v1.0 / v1.1 |
/v1/ghi/history |
Données temporelles agrégées (synthétiques). | v1.0 / v1.1 |
/v1/ghi/regions |
Régions couvertes par le modèle GHI. | v1.1 |
/v1/ghi/metadata |
Informations sur l’API et le moteur. | v1.1 |
/v1/ghi/network |
Métriques réseau synthétiques (beta). | v1.1 |
/v1/ghi/forecast |
Prévision de coût moyen (beta). | v1.1 |
5. Cycle de vie et gouvernance des versions
Le cycle de vie des versions suit les règles suivantes :
- Support actif : dernière version stable (actuellement v1.1)
- Support étendu : versions legacy mineures (ex. v1.0)
- Dépréciation : annoncée publiquement dans le changelog + GitHub
- Suppression : jamais sans préavis institutionnel
Les évolutions du standard sont supervisées par la gouvernance GHI (prochainement ouverte aux partenaires institutionnels).
GHI API – Official Documentation
1. Overview
The Global HashCost Index (GHI) provides a professional-grade API exposing institutional Bitcoin production-cost models. It is designed for investment teams, quant desks, risk management, compliance, and enterprise data platforms.
This page outlines the official API versions, lifecycle guarantees, compatibility rules, and stability commitments expected by institutional users.
2. Available versions
| Version | Status | Description | Link |
|---|---|---|---|
| API v1.1 | Active (stable) | Unified response format, enriched metadata, additional endpoints. | Documentation |
| API v1.0 | Supported (legacy) | Historical version maintained for migration needs. | Documentation |
3. Stability commitments
GHI guarantees:
- no breaking changes within minor versions (1.x);
- clear deprecation notices and migration paths;
- backward compatibility for institutional integrations;
- predictable data structures and volumes;
- fully synchronized documentation for each release.
4. Endpoint overview
| Endpoint | Description | Version |
|---|---|---|
/v1/ghi/snapshot |
Regional production costs + global statistics. | v1.0 / v1.1 |
/v1/ghi/history |
Synthetic aggregated time series. | v1.0 / v1.1 |
/v1/ghi/regions |
GHI regional definitions. | v1.1 |
/v1/ghi/metadata |
API and engine metadata. | v1.1 |
/v1/ghi/network |
Synthetic network metrics. | v1.1 |
/v1/ghi/forecast |
Cost forecast (beta). | v1.1 |
5. Version lifecycle & governance
- Active support: last stable version (currently v1.1)
- Extended support: legacy versions (e.g. v1.0)
- Deprecation: published in changelog & GitHub versions
- Removal: never without formal institutional notice
Version governance is coordinated by GHI and will be opened to qualified institutional partners for future extensions.