API Documentation Changelog#

All notable changes to the Hyperion API Documentation will be documented in this file.

This project adheres to Semantic Versioning 2.0.0.

[1.3.6] - Jan 31, 2024#

Added#

  • New reference for endpoint: pipelinescrapestatus

  • Added link to Excel Addin documentation in nav menu

[1.3.5] - Jan 18, 2024#

Added#

  • New reference for endpoint: pipelinescrapes

[1.3.4] - Dec 14, 2023#

  • Updated unit for gas_daily output parameter from BCF/day to MCF/day: productionbywell

[1.3.3] - Nov 16, 2023#

Added#

  • New query parameter completion_class: completions

  • New query parameter frac_class: fraccrews

  • New query parameter rig_class: rigs

  • New output parameter completion_class: completions

  • New output parameter frac_class: fraccrews

  • New output parameter rig_class: rigs

  • Updated function arguments: completions, fraccrews, rigs

  • Glossary entry for Gas-to-oil ratio

[1.3.2] - Jul 6, 2023#

Added#

  • Aggregation by county, date, end_date, operator, region, state_code, sub_region: completions

Updated#

  • Description for completions

  • Fixed incorrect county aggregation output: rigs

[1.3.1] - Jun 22, 2023#

Changed#

  • Updated function name: longtermforecast

[1.3] - Jun 9, 2023#

Added#

  • Requirement for pydantic

  • county query parameter: completions, ducsbyoperator, fraccrews, productionbywell, rigs, shorttermforecasthistory, shorttermforecast, wells

  • Aggregation by county: ducsbyoperator, fraccrews, productionbywell, rigs, shorttermforecasthistory, shorttermforecast

  • region query parameter and output parameter: longtermforecast

  • oil_daily output parameters: longtermforecast, shorttermforecast, shorttermforecasthistory

  • oil_monthly output parameter: shorttermforecast, shorttermforecasthistory

  • service_company query parameter, aggregation parameter, and output parameter: fraccrews

  • operator_name, region, state_ab, sub_region output parameters: shorttermforecasthistory

  • Description for aggregation: all endpoints supporting aggregation

  • UI: header buttons, new theme

Changed#

  • Deprecated endpoint: productionbycountyandoperator

  • Sample responses and aggregated responses: all endpoints

  • Updated requirements, examples: Getting Started page

  • Updated query parameters (except dates) to take arrays/lists

  • Updated default payload: all endpoints

  • Sorted all sample payload queries alphabetically

  • Description: production_month

[1.2.8] - May 23, 2023#

Added#

  • What’s New section

  • Note on row limits to /productionbycountyandoperator, /productionbywell, /shorttermforecasthistory

[1.2.7] - May 22, 2023#

Added#

  • New aggregation parameter for /dailyproduction: date

Changed#

  • Replaced state_code with sub_region in setup parameters

[1.2.6] - May 03, 2023#

Added#

  • aggregated_by query parameter, aggregated response examples, note on using Excel Add-in to /dailyproduction, /ducsbyoperator, /fraccrews, /productionbycountyandoperator, /productionbywell, /rigs, /shorttermforecast, /shorttermforecasthistory

  • Normal output example to /operatorclassification

[1.2.5] - Apr 20, 2023#

Added#

  • Glossary entry on WGS 84/EPSG:4326 Coordinate System

Changed#

  • Definition of lat and long output parameters

  • Definition of start_date in /completions

[1.2.4] - Apr 17, 2023#

Added#

  • API Changelog

  • API Documentation Changelog

Changed#

  • Definition of end_date in /completions

[1.2.3] - Apr 13, 2023#

Added#

  • state_code, gas_daily, oil_daily, water_daily to the output parameters of /productionbycountyandoperator and /productionbywell

  • gas_daily to the output parameters of /shorttermforecast and /shorttermforecasthistory

  • api query parameter to /productionbywell

  • region, sub_region, start_date, end_date query parameters to /dailyfrackedfeet

  • sub_region, start_date, end_date query parameters to /longtermforecast

Changed#

  • /dailyfrackedfeet and /longtermforecast from GET to POST request

  • All date query and output parameter examples from YYYY-M-DD format to YYYY-MM-DD format

[1.2.2] - Apr 12, 2023#

Added#

  • Note on output value of dry_gas

Changed#

  • Endpoint descriptions for /fraccrews, /longtermforecast, /productionbycountyandoperator

  • lat / long descriptions (removed mention of “frac crews”)

[1.2.1] - Feb 20, 2023#

Added#

  • An unsynced tag to unsynced dates

  • A note that explains the discrepancy in the data and actual reporting times under Output Parameters for affected endpoints

Fixed#

  • Parameter definitions for horizontal_length, measured_depth, total_vertical_depth, wellbore_type

[1.2.0] - Feb 16, 2023#

Added#

  • /dailyfrackedfeet endpoint

Changed#

  • sub_region parameter description

[1.1.2] - Jan 17, 2023#

Added#

  • Configuration for Jupyter Notebooks (Installation page)

[1.1.1] - Dec 19, 2022#

Added#

  • Responses for new endpoints

  • New column names for /shorttermforecast

Fixed#

  • Function names for /longtermforecast, /operatorclassification endpoints

  • Endpoint type for /longtermforecast, /operatorclassification, /regions pages set to GET

  • Numbering in /regions page; removed payload

  • Setup sections for endpoints that take no input: /regions, /longtermforecast, /operatorclassification

[1.1.0] - Dec 17, 2022#

Added#

  • New endpoints: /operatorclassification, /longtermforecast, /dailyproduction

  • New query parameters for /rigs, /fraccrews, /productionbycountryandoperator, /productionbywell, /wellcompletions, /wells, /shorttermforecast, /ducsbyoperator,: operator, state_code, region, sub_region, start_date, end_date

  • New query parameters for /shorttermforecasthistory: start_date, end_date

  • New query parameters for /dailyproduction: region, sub_region, start_date, end_date

[1.0.4] - Oct 9, 2022#

Added#

  • Glossary entry on forecasting

  • Links from /shorttermforecast and /shorttermforecasthistory endpoint pages to the glossary entry

[1.0.3] - Oct 8, 2022#

Added#

  • New endpoints: /shorttermforecast and /shorttermforecasthistory

  • aioretry requirement for client

[1.0.2] - Sept 11, 2022#

Added#

  • Copy button to code blocks

  • Note on optimizing API performance with queries

  • Links to DataFrame I/O documentation

Changed#

  • Errors page

  • Layout of endpoint pages

[1.0.1] - Sept 4, 2022#

Changed#

  • Rewrote the Getting Started page

  • T&C and Errors pages

Removed#

  • Pagination section from the Getting Started page

[1.0.0] [Public release] - Aug 27, 2022#

Added#

  • wheel, pandas, and tqdm module requirements for client

  • Output parameters for /completions

Changed#

  • Specified each parameter as optional

  • Specified /regions endpoint does not accept parameters

  • Description of /ducsbyoperator

Fixed#

  • Inconsistencies between “access token” and “access key”

[0.2.3] - Aug 17, 2022#

Added#

  • Terms of Use page

Changed#

  • Authentication page

  • Errors page has been updated with Attribute and Type Error descriptions

[0.2.2] - Aug 10, 2022#

Added#

  • Authentication, Errors pages

Changed#

  • /regions endpoint

  • Page and folder names

Removed#

  • “Publish package” section from the Installation page

[0.2.1] - Aug 3, 2022#

Added#

  • Configuration of the Hyperion client to each endpoint page

  • More links between endpoint pages and the glossary

Changed#

  • Updated Glossary

Fixed#

  • Inconsistencies in variable and function names

[0.2.0] - Jul 28, 2022#

Added#

  • Endpoint reference pages: /productionbycountyandoperator, /productionbywell, /regions, /rigs

  • CSS

  • Search and indexing

[0.1.0] - Jul 22, 2022#

Added#

  • Introduction, Installation pages

  • Endpoint reference pages: /completions, /ducsbyoperator, /fraccrews, /wells