Hyperion API Documentation

This tutorial will guide you through the basics of installing and using the Hyperion API client. Subscribe to SynMax youtube channel to receive regular updates on SynMax Hyperion.

Warning

Deprecation Notice for Hyperion API v3 - We are deprecating Hyperion API v3 to concentrate on the improved functionality of newer versions. V3 will no longer receive new features or enhancements.

New Integrations: Please use Hyperion API v4.

Existing v3 Users: We encourage you to migrate to v4.

SynMax will provide migration guides and proactive support to assist with your transition.

---

Explore the Docs

Table of Contents

Getting Started

• What is Hyperion?
• Installation
• Get Started & Usage
• Authentication
• Errors
• Terms of Use
• Data Update Frequency
• Batch Schedule
• API Migration Guide: v3 to v4

API References V4

• V4 Endpoints References
  • /completions
  • /dailyfrackedfeet
  • /dailyproduction
  • /drygasfactors
  • /ducsbyoperator
  • /filterregions
  • /fraccrews
  • /glossary
  • /longtermforecast
  • /lower_48_total_stf
  • /operatorclassification
  • /productionbywell
  • /regions
  • /rigs
  • /shorttermforecast
  • /shorttermforecastdeclines
  • /shorttermforecasthistory
  • /shorttermforecasthistorydates
  • /stfaggregatedhistory
  • /tils
  • /wellinitialproductionrates
  • /wells
  • /beta/complete_report_date
  • /beta/dark_oil/imagery
  • /beta/dark_oil/terminals
  • /beta/dark_oil/transactions
  • /beta/dark_oil/volumes

API References V3

• V3 Endpoints References
  • /completions
  • /dailyfrackedfeet
  • /dailyproduction
  • /ducsbyoperator
  • /fraccrews
  • /longtermforecast
  • /operatorclassification
  • /pipelinescrapes
  • /pipelinescrapestatus
  • /productionbywell
  • /regions
  • /rigs
  • /shorttermforecast
  • /shorttermforecastdeclines
  • /shorttermforecasthistory
  • /shorttermforecasthistorydates
  • /stfaggregatedhistory
  • /TILs
  • /wells

Production Studio

• Overview
  • Setup
  • Running Pipelines
  • Inputs & Outputs

—

Snowflake References

• Tables
  • Completions
  • Daily Production
  • DUCs by Operator
  • Frac Crews
  • Long Term Forecast Oil
  • Long Term Forecast
  • Operator Classification
  • Production By Well
  • Regions
  • Rigs
  • Short Term Forecast
  • Short Term Forecast Declines
  • Pipeline Scrapes
  • TILs
  • Wells

Glossary

• Glossary

Index

• Index

Note

This project is under active development.