v2

latestOpenAPI 3.0.4Commercial License2026-08-0718678294.5 KB
Well Lifecycle

Well lifecycle state availability

Returns customer-safe lifecycle availability statuses by state. This endpoint classifies states as available, partial, repair_required, or unavailable so clients do not mistake missing lifecycle coverage for valid zero data.

get/v1/well-lifecycle/states

Query parameters

statesstring

Comma-separated two-letter state codes. Defaults to promoted lifecycle states; pass states explicitly to inspect unavailable or repair-gated states.

api_limitinteger
Example:100

Maximum permit APIs analyzed per state for bounded online validation. Defaults to 1 for the no-param overview and 1000 for explicit state requests.

include_samplesboolean

Include diagnostic sample rows in list responses.

Response

Lifecycle state availability list

statusstring

Example response

{
  "status": "success",
  "data": {
    "states": [
      {
        "state": "TX",
        "status": "repair_required",
        "validation_status": "research_required",
        "success": true,
        "reasons": [
          "duplicate_source_records_need_state_policy"
        ],
        "summary": {
          "status": "summary_available",
          "summary_wells": 12450,
          "production_window": {
            "first_production_month": "2019-01-01",
            "latest_production_month": "2026-04-01"
          },
          "cumulative": {
            "oil_bbl": 1850000,
            "gas_mcf": 4250000,
            "water_bbl": 3100000,
            "boe": 2558333.33
          },
          "coverage_statuses": {
            "full_chain": 11890,
            "permit_spud_production_no_completion": 560
          },
          "frac_focus": {
            "matched_wells": 10420,
            "match_rate_pct": 83.7,
            "latest_job_start_date": "2026-07-10"
          }
        }
      }
    ]
  }
}