API Migration Guide: v3 to v4#

This guide details the breaking changes introduced in API v4 and provides instructions for migrating your existing v3 integration.

Endpoint: `/v4/completions`#

Summary of Changes#

Request parameters for date ranges have been renamed for specificity (e.g., start_date is now date_completion_start_min).
The region and sub_region parameters have been renamed to region_natgas and sub_region_natgas.
The pagination parameter has been removed and is no longer supported.
In the response, the api identifier is replaced by well_id, and completions_count is renamed to count.
Response field names have been updated for consistency (e.g., operator_name to operator).

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/completions`
v4	`POST` `/v4/completions`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`start_date`	`REMOVED`	This parameter is no longer supported. Use `date_completion_start_min` and `date_completion_start_max` instead.	Update your code to use the new date range parameters for completion start dates.
`end_date`	`REMOVED`	This parameter is no longer supported. Use `date_completion_end_min` and `date_completion_end_max` instead.	Update your code to use the new date range parameters for completion end dates.
`start_date_min`/`max`	`MODIFIED`	Renamed to `date_completion_start_min`/`max`.	Update parameter names in your request body.
`end_date_min`/`max`	`MODIFIED`	Renamed to `date_completion_end_min`/`max`.	Update parameter names in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.

Response Body Changes#

The response body fields have been renamed for clarity and consistency. The well_id is now used to identify wells instead of api.

v3 Response Structure:

{
  "api": 4900552885,
  "completion_class": "gas",
  "completions_count": 1,
  "county": "CAMPBELL",
  "end_date": "2023-01-20",
  "operator_name": "ABC OPERATING",
  "region": "west",
  "start_date": "2023-01-10",
  "state_ab": "WY",
  "sub_region": "Powder River",
  "wellpad_id": "123456"
}

v4 Response Structure:

{
  "well_id": "4900552885",
  "completion_class": "gas",
  "count": 1,
  "county": "CAMPBELL",
  "date_completion_end": "2023-01-20",
  "operator": "ABC OPERATING",
  "region_natgas": "west",
  "date_completion_start": "2023-01-10",
  "state_code": "WY",
  "sub_region_natgas": "Powder River",
  "wellpad_id": "123456"
}

Endpoint: `/v4/dailyfrackedfeet`#

Summary of Changes#

Date parameters start_date and end_date have been renamed to date_frac_min and date_frac_max.
The region and sub_region parameters have been renamed to region_natgas and sub_region_natgas.
The pagination parameter has been removed.
The response field date has been renamed to date_frac.

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/dailyfrackedfeet`
v4	`POST` `/v4/dailyfrackedfeet`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`start_date`	`MODIFIED`	Renamed to `date_frac_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_frac_max`.	Update parameter name in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.

Response Body Changes#

The response structure is largely the same, with minor field name changes for consistency.

v3 Response Structure:

{
  "date": "2023-05-10",
  "fracked_feet": 9500.5,
  "region": "east",
  "sub_region": "Haynesville"
}

v4 Response Structure:

{
  "date_frac": "2023-05-10",
  "fracked_feet": 9500.5,
  "region_natgas": "east",
  "sub_region_natgas": "Haynesville"
}

Endpoint: `/v4/dailyproduction`#

Summary of Changes#

Request parameters start_date and end_date are now date_prod_min and date_prod_max.
region and sub_region parameters are now region_natgas and sub_region_natgas.
The pagination parameter has been removed.
In the response, date is now date_prod, and dry_gas is now prod_dry_gas_bcf_day.

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/dailyproduction`
v4	`POST` `/v4/dailyproduction`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`start_date`	`MODIFIED`	Renamed to `date_prod_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_prod_max`.	Update parameter name in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.

Response Body Changes#

Response fields have been renamed to be more descriptive and consistent.

v3 Response Structure:

{
  "date": "2023-10-01",
  "dry_gas": 95.2,
  "region": "south",
  "sub_region": "Permian"
}

v4 Response Structure:

{
  "date_prod": "2023-10-01",
  "prod_dry_gas_bcf_day": 95.2,
  "region_natgas": "south",
  "sub_region_natgas": "Permian"
}

Endpoint: `/v4/ducsbyoperator`#

Summary of Changes#

Date parameters start_date and end_date are now date_observed_min and date_observed_max.
The region and sub_region parameters are now region_natgas and sub_region_natgas.
The pagination parameter has been removed.
Response field names have been updated for consistency (e.g., operator_name to operator, date to date_observed).
The count field in the response has been removed, as ducs_count provides the same information.

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/ducsbyoperator`
v4	`POST` `/v4/ducsbyoperator`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`start_date`	`MODIFIED`	Renamed to `date_observed_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_observed_max`.	Update parameter name in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.

Response Body Changes#

Response fields have been renamed, and the redundant count field was removed.

v3 Response Structure:

{
  "count": 10,
  "county": "MIDLAND",
  "date": "2023-11-01",
  "ducs_count": 10,
  "operator_name": "PIONEER NATURAL RESOURCES",
  "region": "south",
  "state_ab": "TX",
  "sub_region": "Permian"
}

v4 Response Structure:

{
  "county": "MIDLAND",
  "date_observed": "2023-11-01",
  "ducs_count": 10,
  "operator": "PIONEER NATURAL RESOURCES",
  "region_natgas": "south",
  "state_code": "TX",
  "sub_region_natgas": "Permian"
}

Endpoint: `/v4/glossary`#

Summary of Changes#

This single v4 endpoint replaces and consolidates the functionality of three v3 endpoints: /v3/dropdownfilters, /v3/exl_dropdownselection, and /v3/glossary/{path}/{filter_field}.
The request method is now POST instead of GET for the old glossary endpoint.
The request body has been simplified into a single, consistent structure, removing path parameters used in the old /v3/glossary endpoint.
The response provides a simple object with fields for each filter type, making it easier to parse than the previous list-based responses.

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/exl_dropdownselection` (and others)
v4	`POST` `/v4/glossary`

Input Parameter Changes#

The v4 request body consolidates the various filtering parameters from the three old v3 endpoints into a single, more intuitive structure. Instead of separate endpoints or path parameters, you now specify the target_function and filter_type you want values for, along with any dependent filters.

Parameter	Change Type	Description of Change	Action Required
(Path Params)	`REMOVED`	The `/v3/glossary/{path}/{filter_field}` endpoint’s path parameters are now part of the v4 request body (`target_function`, `filter_type`).	Move path parameter logic into the request body of the `POST /v4/glossary` call.
`pagination`	`REMOVED`	Pagination is no longer supported for glossary lookups.	Remove any pagination logic from your calls.
`search_term`	`ADDED`	A new parameter to perform a text search on the filter values.	Optionally add search functionality to your filter dropdowns.

Response Body Changes#

The v4 response is a single object with potential keys for all filterable fields, whereas the v3 responses were arrays of objects with a single value field.

v3 Response Structure (``/v3/dropdownfilters``):

[
  {
    "filter_type": "sub_region",
    "table_update_timestamp": "2023-11-20T12:00:00Z",
    "target_function": "shorttermforecast",
    "value": "Haynesville - TX"
  },
  {
    "filter_type": "sub_region",
    "table_update_timestamp": "2023-11-20T12:00:00Z",
    "target_function": "shorttermforecast",
    "value": "Permian - Midland"
  }
]

v4 Response Structure:

[
  {
    "county": "MIDLAND",
    "state_code": "TX",
    "operator": "PIONEER NATURAL RESOURCES",
    "region_natgas": "south",
    "sub_region_natgas": "Permian - Midland",
    "service_company": null,
    "completion_class": "oil",
    "rig_class": null,
    "frac_class": null,
    "date_forecast_run": "2024-01-01",
    "category": null,
    "source": null
  }
]

Endpoint: `/v4/fraccrews`#

Summary of Changes#

Date parameters are renamed from start_date/end_date to date_frac_min/max.
region and sub_region are renamed to region_natgas and sub_region_natgas.
The pagination parameter is removed.
Response field names have been updated for consistency, and frac_crews_count has been renamed to count.

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/fraccrews`
v4	`POST` `/v4/fraccrews`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`start_date`	`MODIFIED`	Renamed to `date_frac_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_frac_max`.	Update parameter name in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.

Response Body Changes#

Field names in the response have been standardized.

v3 Response Structure:

{
  "county": "SUSQUEHANNA",
  "date": "2023-09-15",
  "frac_class": "gas",
  "frac_crews_count": 2,
  "lat": 41.8,
  "long": -75.8,
  "operator_name": "CABOT OIL & GAS",
  "region": "east",
  "service_company": "HALLIBURTON",
  "state_ab": "PA",
  "sub_region": "Marcellus",
  "wellpad_id": "654321"
}

v4 Response Structure:

{
  "county": "SUSQUEHANNA",
  "date_frac": "2023-09-15",
  "frac_class": "gas",
  "count": 2,
  "lat": 41.8,
  "long": -75.8,
  "operator": "CABOT OIL & GAS",
  "region_natgas": "east",
  "service_company": "HALLIBURTON",
  "state_code": "PA",
  "sub_region_natgas": "Marcellus",
  "wellpad_id": "654321"
}

Endpoint: `/v4/longtermforecast`#

Summary of Changes#

Request parameters for dates, region, and sub-region have been renamed for consistency (start_date -> date_prod_min, etc.).
The pagination parameter has been removed.
Response fields have been renamed to be more descriptive (date -> date_prod, gas_daily -> prod_dry_gas_bcf_day).

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/longtermforecast`
v4	`POST` `/v4/longtermforecast`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`start_date`	`MODIFIED`	Renamed to `date_prod_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_prod_max`.	Update parameter name in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.

Response Body Changes#

Response fields now have more specific and consistent names.

v3 Response Structure:

{
  "date": "2026-01-01",
  "gas_daily": 102.5,
  "oil_daily": 12.1,
  "region": "south",
  "sub_region": "Permian"
}

v4 Response Structure:

{
  "date_prod": "2026-01-01",
  "prod_dry_gas_bcf_day": 102.5,
  "prod_oil_bbl_day": 12.1,
  "region_natgas": "south",
  "sub_region_natgas": "Permian"
}

Endpoint: `/v4/operatorclassification`#

Summary of Changes#

The endpoint is now a GET request and no longer accepts a request body.
The response field operator_name has been renamed to operator for consistency.

Endpoint & Method#

Version	HTTP Method & Path
v3	`GET` `/v3/operatorclassification`
v4	`GET` `/v4/operatorclassification`

Input Parameter Changes#

No changes to input parameters; this endpoint does not accept any.

Response Body Changes#

A minor field name change was made for consistency.

v3 Response Structure:

{
  "operator_name": "CHESAPEAKE ENERGY",
  "public_or_private": "Public",
  "ticker": "CHK"
}

v4 Response Structure:

{
  "operator": "CHESAPEAKE ENERGY",
  "public_or_private": "Public",
  "ticker": "CHK"
}

Endpoint: `/v4/productionbywell`#

Summary of Changes#

The api and apistring request parameters have been replaced by a single well_id parameter.
Date and region parameters have been renamed (start_date -> date_prod_min, region -> region_natgas, etc.).
The pagination parameter has been removed.
New min/max parameters have been added for production_month filtering (production_month_min, production_month_max).
All response fields have been renamed for consistency and clarity (e.g., gas_daily -> prod_wet_gas_mcf_day, api -> well_id).

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/productionbywell`
v4	`POST` `/v4/productionbywell`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`api`	`REMOVED`	Replaced by the `well_id` parameter.	Update your code to use the new `well_id` parameter.
`apistring`	`REMOVED`	This parameter is no longer supported.	Remove this parameter from API calls.
`start_date`	`MODIFIED`	Renamed to `date_prod_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_prod_max`.	Update parameter name in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.
`well_id`	`ADDED`	This new parameter replaces `api` for identifying wells.	Use this parameter to specify wells.
`production_month_min`/`max`	`ADDED`	New parameters for filtering by a range of production months.	Use these for more flexible production month queries instead of listing individual months.

Response Body Changes#

The response body has been significantly updated with new, more descriptive field names.

v3 Response Structure:

{
  "api": 4212345678,
  "county": "WELD",
  "date": "2023-06-30",
  "gas_daily": 1200,
  "gas_monthly": 36000,
  "oil_daily": 80,
  "oil_monthly": 2400,
  "operator_name": "CIVITAS RESOURCES",
  "production_month": 6,
  "region": "west",
  "state_ab": "CO",
  "sub_region": "DJ Basin",
  "water_daily": 150,
  "water_monthly": 4500,
  "well_name": "WILDCAT 1H"
}

v4 Response Structure:

{
  "well_id": "4212345678",
  "county": "WELD",
  "date_prod": "2023-06-30",
  "prod_wet_gas_mcf_day": 1200,
  "prod_wet_gas_mcf_month": 36000,
  "prod_oil_bbl_day": 80,
  "prod_oil_bbl_month": 2400,
  "operator": "CIVITAS RESOURCES",
  "production_month": 6,
  "region_natgas": "west",
  "state_code": "CO",
  "sub_region_natgas": "DJ Basin",
  "prod_water_bbl_day": 150,
  "prod_water_bbl_month": 4500,
  "well_name": "WILDCAT 1H"
}

Endpoint: `/v4/regions`#

Summary of Changes#

This endpoint has changed from a GET request that could accept a request body (via a POST method in v3) to a simple GET request with no parameters.
The response fields have been renamed for consistency (state_ab -> state_code, region -> region_natgas, etc.).

Endpoint & Method#

Version	HTTP Method & Path
v3	`GET` `/v3/regions` (and a `POST` at `/v3/filter_regions`)
v4	`GET` `/v4/regions`

Input Parameter Changes#

The v4 endpoint is a simple GET request and does not accept any input parameters. The filtering capability of the v3 POST /v3/filter_regions endpoint has been removed.

Response Body Changes#

Field names in the response have been updated to match the new API standard.

v3 Response Structure:

{
  "county": "WELD",
  "region": "west",
  "state_ab": "CO",
  "sub_region": "DJ Basin"
}

v4 Response Structure:

{
  "county": "WELD",
  "region_natgas": "west",
  "state_code": "CO",
  "sub_region_natgas": "DJ Basin"
}

Endpoint: `/v4/rigs`#

Summary of Changes#

Date parameters have been renamed from start_date/end_date to date_observed_min/max.
Region parameters have been renamed (region -> region_natgas, etc.).
The pagination parameter has been removed.
In the response, rigs_count is now count, date is date_observed, and other fields have been renamed for consistency.

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/rigs`
v4	`POST` `/v4/rigs`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`start_date`	`MODIFIED`	Renamed to `date_observed_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_observed_max`.	Update parameter name in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.

Response Body Changes#

Response fields have been updated to align with the new API naming conventions.

v3 Response Structure:

{
  "county": "MIDLAND",
  "date": "2023-11-20",
  "lat": 32.0,
  "long": -102.0,
  "operator_name": "PIONEER NATURAL RESOURCES",
  "region": "south",
  "rig_class": "oil",
  "rigs_count": 5,
  "state_ab": "TX",
  "sub_region": "Permian",
  "wellpad_id": "987654"
}

v4 Response Structure:

{
  "county": "MIDLAND",
  "date_observed": "2023-11-20",
  "lat": 32.0,
  "long": -102.0,
  "operator": "PIONEER NATURAL RESOURCES",
  "region_natgas": "south",
  "rig_class": "oil",
  "count": 5,
  "state_code": "TX",
  "sub_region_natgas": "Permian",
  "wellpad_id": "987654"
}

Endpoint: `/v4/shorttermforecast`#

Summary of Changes#

The endpoint path is now /v4/shorttermforecast.
Several request parameters have been renamed for consistency (e.g., start_date is now date_prod_min).
The api and apistring parameters have been removed and replaced by the new well_id parameter.
Pagination is no longer supported in the request body.
All fields in the response body have been renamed to follow a more consistent naming convention (e.g., gas_daily is now prod_dry_gas_mcf_day).
The api field in the response has been replaced with well_id.

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/shorttermforecast`
v4	`POST` `/v4/shorttermforecast`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`start_date`	`MODIFIED`	Renamed to `date_prod_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_prod_max`.	Update parameter name in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`api`	`REMOVED`	This parameter is no longer supported. Use `well_id` instead.	Remove this parameter and use the new `well_id` parameter to specify wells.
`apistring`	`REMOVED`	This parameter is no longer supported.	Remove this parameter from all API calls.
`pagination`	`REMOVED`	Pagination is no longer supported for this endpoint.	Remove the `pagination` object from your request body.
`well_id`	`ADDED`	This new `string array` parameter is used to filter by well identifier.	Use this parameter instead of the deprecated `api` parameter.

Response Body Changes#

The response body fields have been renamed to improve consistency and clarity across the API. The fundamental data structure remains flat.

v3 Response Structure:

{
  "api": 1234567890,
  "county_name": "WELD",
  "date": "2025-01-31",
  "forecast_run_date": "2024-12-01",
  "gas_daily": 1500.5,
  "gas_monthly": 46515.5,
  "oil_daily": 120.2,
  "oil_monthly": 3726.2,
  "operator_name": "XYZ OPERATOR",
  "region": "west",
  "state_ab": "CO",
  "sub_region": "DJ Basin"
}

v4 Response Structure:

{
  "well_id": "1234567890",
  "county": "WELD",
  "date_prod": "2025-01-31",
  "date_forecast_run": "2024-12-01",
  "prod_dry_gas_mcf_day": 1500.5,
  "prod_dry_gas_mcf_month": 46515.5,
  "prod_oil_bbl_day": 120.2,
  "prod_oil_bbl_month": 3726.2,
  "operator": "XYZ OPERATOR",
  "region_natgas": "west",
  "state_code": "CO",
  "sub_region_natgas": "DJ Basin"
}

Endpoint: `/v4/shorttermforecastdeclines`#

Summary of Changes#

The api and apistring parameters have been replaced by the well_id parameter.
All date and region parameters have been renamed for consistency (e.g., start_date -> date_prod_min).
The pagination parameter has been removed.
New min/max range parameters were added for production_month.
All response fields have been renamed for consistency (e.g., gas_daily -> prod_wet_gas_mcf_day), and num_records is now count.

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/shorttermforecastdeclines`
v4	`POST` `/v4/shorttermforecastdeclines`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`api`	`REMOVED`	Replaced by the `well_id` parameter.	Update your code to use the new `well_id` parameter.
`apistring`	`REMOVED`	This parameter is no longer supported.	Remove this parameter from API calls.
`start_date`	`MODIFIED`	Renamed to `date_prod_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_prod_max`.	Update parameter name in your request body.
`first_production_month_start`/`end`	`MODIFIED`	Renamed to `first_production_month_min`/`max`.	Update parameter names in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.
`well_id`	`ADDED`	This new parameter replaces `api` for identifying wells.	Use this parameter to specify wells.
`production_month_min`/`max`	`ADDED`	New parameters for filtering by a range of production months.	Use these for more flexible production month queries.

Response Body Changes#

The response body has been updated with standardized field names.

v3 Response Structure:

{
  "api": 4212345678,
  "county_name": "WELD",
  "date": "2023-06-30",
  "first_production_month": "2023-01-01",
  "gas_daily": 1200,
  "num_records": 1,
  "oil_daily": 80,
  "operator_name": "CIVITAS RESOURCES",
  "production_month": 6,
  "region": "west",
  "state_ab": "CO",
  "sub_region": "DJ Basin"
}

v4 Response Structure:

{
  "well_id": "4212345678",
  "county": "WELD",
  "date_prod": "2023-06-30",
  "first_production_month": "2023-01-01",
  "prod_wet_gas_mcf_day": 1200,
  "count": 1,
  "prod_oil_bbl_day": 80,
  "operator": "CIVITAS RESOURCES",
  "production_month": 6,
  "region_natgas": "west",
  "state_code": "CO",
  "sub_region_natgas": "DJ Basin"
}

Endpoint: `/v4/shorttermforecasthistory`#

Summary of Changes#

The api request parameter is replaced by well_id.
Date and region parameters have been renamed (start_date -> date_prod_min, etc.).
The required forecast_run_date parameter is now named date_forecast_run.
The pagination parameter is removed.
All response fields are renamed for consistency (api -> well_id, gas_daily -> prod_wet_gas_mcf_day, etc.).

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/shorttermforecasthistory`
v4	`POST` `/v4/shorttermforecasthistory`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`api`	`REMOVED`	Replaced by the `well_id` parameter.	Update your code to use the new `well_id` parameter.
`forecast_run_date`	`MODIFIED`	Renamed to `date_forecast_run` and remains a required field.	Update parameter name in your request body.
`start_date`	`MODIFIED`	Renamed to `date_prod_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_prod_max`.	Update parameter name in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.
`well_id`	`ADDED`	This new parameter replaces `api` for identifying wells.	Use this parameter to specify wells.

Response Body Changes#

All response fields have been renamed to align with the new v4 naming conventions.

v3 Response Structure:

{
  "api": 4212345678,
  "county_name": "WELD",
  "date": "2023-06-30",
  "forecast_run_date": "2023-07-01",
  "gas_daily": 1150,
  "oil_daily": 75,
  "operator_name": "CIVITAS RESOURCES",
  "region": "west",
  "state_ab": "CO",
  "sub_region": "DJ Basin"
}

v4 Response Structure:

{
  "well_id": "4212345678",
  "county": "WELD",
  "date_prod": "2023-06-30",
  "date_forecast_run": "2023-07-01",
  "prod_wet_gas_mcf_day": 1150,
  "prod_oil_bbl_day": 75,
  "operator": "CIVITAS RESOURCES",
  "region_natgas": "west",
  "state_code": "CO",
  "sub_region_natgas": "DJ Basin"
}

Endpoint: `/v4/shorttermforecasthistorydates`#

Summary of Changes#

This endpoint remains a GET request with no parameters.
The field in the response object has been renamed from forecast_run_date to date_forecast_run for consistency.

Endpoint & Method#

Version	HTTP Method & Path
v3	`GET` `/v3/shorttermforecasthistorydates`
v4	`GET` `/v4/shorttermforecasthistorydates`

Input Parameter Changes#

No changes to input parameters; this endpoint does not accept any.

Response Body Changes#

A minor field name change was made for consistency.

v3 Response Structure:

{
  "forecast_run_date": "2023-11-01"
}

v4 Response Structure:

{
  "date_forecast_run": "2023-11-01"
}

Endpoint: `/v4/stfaggregatedhistory`#

Summary of Changes#

All request parameters have been renamed for consistency (start_date -> date_prod_min, forecast_run_date -> date_forecast_run, etc.).
The pagination parameter has been removed.
All response fields have been renamed to be more descriptive and consistent (date -> date_prod, gas_daily -> prod_dry_gas_bcf_day, etc.).

Endpoint & Method#

Version	HTTP Method & Path
v3	`POST` `/v3/stfaggregatedhistory`
v4	`POST` `/v4/stfaggregatedhistory`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`forecast_run_date`	`MODIFIED`	Renamed to `date_forecast_run`.	Update parameter name in your request body.
`start_date`	`MODIFIED`	Renamed to `date_prod_min`.	Update parameter name in your request body.
`end_date`	`MODIFIED`	Renamed to `date_prod_max`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.

Response Body Changes#

Response fields have been updated to the new v4 standard.

v3 Response Structure:

{
  "date": "2023-10-01",
  "forecast_run_date": "2023-11-01",
  "gas_daily": 15.5,
  "oil_daily": 2.1,
  "sub_region": "Haynesville"
}

v4 Response Structure:

{
  "date_prod": "2023-10-01",
  "date_forecast_run": "2023-11-01",
  "prod_dry_gas_bcf_day": 15.5,
  "prod_oil_mbbl_day": 2.1,
  "sub_region_natgas": "Haynesville"
}

Endpoint: `/v4/tils`#

Summary of Changes#

This endpoint replaces /v3/tils and /v3/dtils. It is a simple GET request with no parameters.
Response fields have been renamed to align with v4 standards (frac_end -> date_frac_end, bcfd -> prod_wet_gas_bcf_day).

Endpoint & Method#

Version	HTTP Method & Path
v3	`GET` `/v3/tils` (and `/v3/dtils`)
v4	`GET` `/v4/tils`

Input Parameter Changes#

No changes to input parameters; this endpoint does not accept any.

Response Body Changes#

Field names in the response have been updated to be more descriptive and consistent.

v3 Response Structure:

{
  "bcfd": 1.2,
  "frac_end": "2023-10-20",
  "operator_name": "EQT PRODUCTION",
  "sub_region": "Marcellus",
  "til_date": "2023-11-15",
  "wellpad_id": "112233",
  "wells": 3
}

v4 Response Structure:

{
  "prod_wet_gas_bcf_day": 1.2,
  "date_frac_end": "2023-10-20",
  "operator": "EQT PRODUCTION",
  "sub_region_natgas": "Marcellus",
  "date_til": "2023-11-15",
  "wellpad_id": "112233",
  "wells": 3
}

Endpoint: `/v4/wells`#

Summary of Changes#

The apistring parameter has been removed.
Date, region, and depth/length range parameters have been renamed for clarity and consistency (e.g., start_date -> date_spud_min, depth_min -> depth_tvd_min).
New filter parameters for date_first_production, lat/lon ranges, well_id, and wellpad_id have been added.
The pagination parameter is removed.
The response has been streamlined; api is replaced by well_id, and several fields have been renamed (completion_date -> date_completion, long -> lon_surface).

Endpoint & Method#

Version	HTTP Method & Path
v3 \| `POST` `/v3/wells`
v4 \| `POST` `/v4/wells`

Input Parameter Changes#

Parameter	Change Type	Description of Change	Action Required
`apistring`	`REMOVED`	This parameter is no longer supported.	Remove this parameter from your API calls.
`start_date`	`MODIFIED`	Replaced by more specific date filters like `date_spud_min` and `date_first_production_min`.	Update your logic to use the new, more specific date filters.
`end_date`	`MODIFIED`	Replaced by `date_spud_max` and `date_first_production_max`.	Update your logic to use the new, more specific date filters.
`depth_min`/`max`	`MODIFIED`	Renamed to `depth_tvd_min`/`max`.	Update parameter names in your request body.
`region`	`MODIFIED`	Renamed to `region_natgas`.	Update parameter name in your request body.
`sub_region`	`MODIFIED`	Renamed to `sub_region_natgas`.	Update parameter name in your request body.
`pagination`	`REMOVED`	This parameter is no longer supported.	Remove the `pagination` object from your request body.
`date_spud_min`/`max`	`ADDED`	New specific filter for well spud date range.	Use these parameters to filter by spud date.
`date_first_production_min`/`max`	`ADDED`	New specific filter for first production date range.	Use these parameters to filter by first production date.
`lat_surface_min`/`max`	`ADDED`	New filter for surface latitude range.	Use for geospatial queries on well location.
`lon_surface_min`/`max`	`ADDED`	New filter for surface longitude range.	Use for geospatial queries on well location.
`well_id`	`ADDED`	New parameter to filter by specific well IDs.	Use this for direct well lookups.
`wellpad_id`	`ADDED`	New parameter to filter by specific wellpad IDs.	Use this to find all wells on a specific pad.

Response Body Changes#

The response body has been updated to use the new well_id identifier and standardized field names.

v3 Response Structure:

{
  "api": 4212345678,
  "completion_date": "2023-01-15",
  "county": "WELD",
  "horizontal_length": 9800,
  "lat": 39.8,
  "long": -104.5,
  "measured_depth": 19500,
  "operator_name": "CIVITAS RESOURCES",
  "production_first_date": "2023-02-01",
  "region": "west",
  "state_ab": "CO",
  "sub_region": "DJ Basin",
  "total_vertical_depth": 9700,
  "wellpad_id": "778899"
}

v4 Response Structure:

{
  "well_id": "4212345678",
  "date_completion": "2023-01-15",
  "county": "WELD",
  "horizontal_length": 9800,
  "lat_surface": 39.8,
  "lon_surface": -104.5,
  "depth_measured": 19500,
  "operator": "CIVITAS RESOURCES",
  "date_first_production": "2023-02-01",
  "region_natgas": "west",
  "state_code": "CO",
  "sub_region_natgas": "DJ Basin",
  "depth_tvd": 9700,
  "wellpad_id": "778899"
}

Batch Schedule

V4 Endpoints References

API Migration Guide: v3 to v4#

Endpoint: /v4/completions#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/dailyfrackedfeet#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/dailyproduction#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/ducsbyoperator#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/glossary#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/fraccrews#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/longtermforecast#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/operatorclassification#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/productionbywell#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/regions#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/rigs#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/shorttermforecast#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/shorttermforecastdeclines#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/shorttermforecasthistory#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/shorttermforecasthistorydates#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Response Body Changes#

Endpoint: /v4/stfaggregatedhistory#

Summary of Changes#

Endpoint & Method#

Input Parameter Changes#

Endpoint: `/v4/completions`#

Endpoint: `/v4/dailyfrackedfeet`#

Endpoint: `/v4/dailyproduction`#

Endpoint: `/v4/ducsbyoperator`#

Endpoint: `/v4/glossary`#

Endpoint: `/v4/fraccrews`#

Endpoint: `/v4/longtermforecast`#

Endpoint: `/v4/operatorclassification`#

Endpoint: `/v4/productionbywell`#

Endpoint: `/v4/regions`#

Endpoint: `/v4/rigs`#

Endpoint: `/v4/shorttermforecast`#

Endpoint: `/v4/shorttermforecastdeclines`#

Endpoint: `/v4/shorttermforecasthistory`#

Endpoint: `/v4/shorttermforecasthistorydates`#

Endpoint: `/v4/stfaggregatedhistory`#

Endpoint: `/v4/tils`#

Endpoint: `/v4/wells`#