Provenance
PublisherWellDatabase
API basehttps://app.welldatabase.com/
Freshness & coverage
FreshnessFreshness not declared
GeographicNot declared
TemporalNot declared
AuthenticationCredentials required (API key)
Methods (77)
getWellAnalysisBundle
readFetch selected well datasets and join them by stable WellDatabase well ID.
Entitieswell, pad, trajectory, formation, spacing, perforation, frac_job, production, forecastPaginationnoneUnitstotalProppantPounds: lb · perforatedFeet: ft · proppantPoundsPerPerforatedFoot: lb/ft · drainageRadiusFeet: ft · percentEurProduced: percentInput schema
{ "type": "object", "properties": { "wellId": { "type": "array", "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 50 } ], "description": "One or more stable WellDatabase well UUIDs from an earlier result." }, "api": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 50 } ], "description": "One or more API/UWI well identifiers." }, "wellName": { "type": "string", "minLength": 1, "description": "Pad, unit, lease, or well-name text." }, "operator": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "number" } ], "description": "Optional operator name or WellDatabase operator ID." }, "state": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "number" } ], "description": "State name/code or WellDatabase state ID." }, "county": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "number" } ], "description": "County name or WellDatabase county ID." }, "datasets": { "type": "array", "items": { "type": "string", "enum": [ "directionals", "interpretedFormations", "spacing", "perforations", "stimulations", "productionSummary", "productionForecastSummary" ] }, "minItems": 1, "uniqueItems": true, "description": "Child datasets needed for this analysis. Defaults to directionals, perforations, and stimulations." }, "maxWells": { "type": "integer", "minimum": 1, "maximum": 50, "description": "Maximum matched wells to join; defaults to 25." }, "formationName": { "type": "string", "minLength": 1, "description": "Optional interpreted formation-name filter." }, "drainageRadiusFeet": { "type": "number", "exclusiveMinimum": 0, "maximum": 10000, "description": "User-requested visualization radius in feet. Returned as an explicit assumption, not a source measurement." } }, "additionalProperties": false, "anyOf": [ { "required": [ "wellId" ] }, { "required": [ "api" ] }, { "required": [ "wellName" ] }, { "required": [ "operator" ] } ] }- ⚠ A child dataset can be not requested, empty, partial, unknown, or fail independently; inspect coverage before claiming completeness.
- ⚠ Completion intensity is a derived completion metric, not frac geometry or frac size.
- ⚠ Drainage radius is a user-supplied visualization assumption, not a WellDatabase measurement.
Returns per-dataset coverage; incomplete child data keeps the bundle partial.
getWellLifecycle
read⭐ ONE-CALL well dossier: completions+casings+stims+tests+spacing+cores+water+financial.
Required paramsapi or wellIdEntitieswellInput schema
{ "type": "object", "properties": { "api": { "type": "string" }, "wellId": { "type": "string", "examples": [ "<uuid-from-searchWells>" ] }, "include": { "type": "object", "properties": { "summary": { "type": "boolean" }, "completions": { "type": "boolean" }, "stimulations": { "type": "boolean" }, "tests": { "type": "boolean" }, "spacing": { "type": "boolean" }, "cores": { "type": "boolean" }, "water": { "type": "boolean" }, "financial": { "type": "boolean" } }, "additionalProperties": false }, "pageSize": { "type": "number" }, "maxPages": { "type": "number" }, "sequential": { "type": "boolean" } }, "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "api" ] }, { "required": [ "wellId" ] } ] } ] }Pass wellId (UUID) or api. include:{tests:false,...} trims sections.
getOperatorProductionTrend
read⭐ One-call operator trend: trailing-two-year monthly volume and direction for one fluid.
Required paramsoperatorEntitiesproduction, operator, wellPaginationnoneUnitsoil: bbl · gas: mcf · water: bblInput schema
{ "type": "object", "properties": { "operator": { "type": "string", "examples": [ "Mitsui E&P Texas" ], "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "number" } ], "description": "Operator name or WellDatabase operator ID." }, "state": { "type": "string", "examples": [ "TX" ], "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "number" } ], "description": "State name/code or WellDatabase state ID." }, "startDate": { "type": "string", "description": "Optional inclusive production start date (YYYY-MM-DD); when both bounds are omitted, defaults to the first day of this month two years ago." }, "endDate": { "type": "string", "description": "Optional inclusive production end date (YYYY-MM-DD); when both bounds are omitted, defaults to today (UTC)." }, "granularity": { "type": "string", "enum": [ "daily", "monthly", "quarterly", "yearly", "annual", "total" ], "description": "Aggregation interval; defaults to monthly." }, "fluid": { "type": "string", "examples": [ "oil" ], "enum": [ "oil", "gas", "water" ], "description": "Production fluid returned by each bucket; defaults to oil." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 200, "description": "Well-discovery page size." } }, "additionalProperties": false, "required": [ "operator" ] }- ⚠ Scans at most 500 wells and fetches at most 100 well timeseries; inspect partial, truncated, and warnings.
Oil defaults to 2 years. Check coverage and partial flags.
aggregateProduction
readMonthly/quarterly/yearly oil, gas, and water totals across a filtered multi-well set.
Entitiesproduction, operator, wellPaginationnoneUnitsoil: bbl · gas: mcf · water: bblInput schema
{ "type": "object", "properties": { "operator": { "type": "string", "examples": [ "Mitsui E&P Texas" ], "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "number" } ], "description": "Operator name or WellDatabase operator ID." }, "state": { "type": "string", "examples": [ "TX" ], "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "number" } ], "description": "State name/code or WellDatabase state ID." }, "county": { "type": "string", "minLength": 1 }, "basin": { "type": "string", "minLength": 1 }, "field": { "type": "string", "minLength": 1 }, "api": { "type": "string", "minLength": 1 }, "apis": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 }, "startDate": { "type": "string", "examples": [ "2024-07-01" ], "description": "Optional inclusive production start date (YYYY-MM-DD)." }, "endDate": { "type": "string", "examples": [ "2026-07-24" ], "description": "Optional inclusive production end date (YYYY-MM-DD)." }, "granularity": { "type": "string", "examples": [ "monthly" ], "enum": [ "daily", "monthly", "quarterly", "yearly", "annual", "total" ], "description": "Aggregation interval; defaults to monthly." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 200, "description": "Well-discovery page size." } }, "additionalProperties": false, "anyOf": [ { "required": [ "operator" ] }, { "required": [ "state" ] }, { "required": [ "county" ] }, { "required": [ "basin" ] }, { "required": [ "field" ] }, { "required": [ "api" ] }, { "required": [ "apis" ] } ] }- ⚠ Operator/area aggregation scans at most 500 wells and fetches at most 100 well timeseries; inspect partial, truncated, and warnings.
Use for area/API-list trends; prefer getOperatorProductionTrend for operators.
getOperatorProduction
readPer-well cumulative and peak production summaries auto-joined with well headers in 2 calls.
Required paramsoperatorEntitiesproduction, operatorInput schema
{ "type": "object", "properties": { "operator": { "type": "string", "examples": [ "Mitsui" ], "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "state": { "type": "string", "examples": [ "Texas" ], "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "type": "string" }, "pageSize": { "type": "number", "examples": [ 100 ] }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] } }, "additionalProperties": false, "required": [ "operator" ] }Per-well summaries only; use getOperatorProductionTrend for time buckets.
getOperatorWells
readGet wells by operator (headers only). Use getOperatorProduction if you also need production.
Required paramsoperatorEntitiesoperator, wellPaginationoffset (offsetField: pageOffset, limitField: pageSize)Input schema
{ "type": "object", "properties": { "operator": { "type": "string", "examples": [ "Mitsui" ], "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "integer", "minimum": 1 } ], "description": "Reported/normalized operator name or WellDatabase operator ID." }, "state": { "type": "string", "examples": [ "TX" ], "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "integer", "minimum": 1 } ], "description": "Optional state name, abbreviation, or WellDatabase state ID." }, "pageSize": { "type": "integer", "examples": [ 100 ], "minimum": 1, "maximum": 1000, "default": 100 }, "pageOffset": { "type": "integer", "minimum": 0, "default": 0 } }, "additionalProperties": false, "required": [ "operator" ] }Default pageSize 50. Preserve raw result when mapping with subsurface.
searchWells
readSearch well headers by well name, operator, API, state, county, or field.
EntitieswellInput schema
{ "type": "object", "properties": { "query": { "type": "string" }, "wellName": { "type": "string", "examples": [ "MANDALORE A 1H" ], "minLength": 1, "description": "Full or partial well name.", "x-patchops-inference": "literal-search-term" }, "wellNames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 50, "description": "Batch of full or partial well names. Common well_names casing is normalized automatically; every name is searched independently and unmatched or ambiguous names are disclosed." }, "operator": { "type": "string", "examples": [ "FW EAGLE FORD I, LLC" ], "minLength": 1, "description": "Reported or normalized operator name." }, "api": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1 } ], "description": "One formatted/unformatted API number, or an API-number batch." }, "state": { "type": "string", "examples": [ "TX" ], "minLength": 1, "description": "State name or abbreviation." }, "county": { "type": "string", "minLength": 1, "description": "County or parish name." }, "field": { "type": "string", "minLength": 1, "description": "Field name." }, "pageSize": { "type": "integer", "examples": [ 50 ], "minimum": 1, "maximum": 1000, "default": 50 }, "pageOffset": { "type": "integer", "minimum": 0, "default": 0 } }, "additionalProperties": true }Combine known identity fields before asking for another identifier.
searchWellSummary
readSearch well summary data with aggregated metrics.
EntitieswellInput schema
{ "type": "object", "properties": { "query": { "type": "string" } }, "additionalProperties": true }Returns summary-level well information
searchWellLocation
readSearch well locations with coordinates and surface hole data.
EntitieswellInput schema
{ "type": "object", "properties": { "wellId": { "type": "number" }, "api": { "type": "string" }, "uwi": { "type": "string" }, "SimpleIds": { "type": "array", "items": { "type": "number" } }, "InfinityIds": { "type": "array", "items": { "type": "number" } }, "Ids": { "type": "array", "items": { "type": "number" } }, "PageSize": { "type": "number" }, "PageOffset": { "type": "number" } }, "additionalProperties": true }Returns lat/long, surface location, and geographic data
searchRigs
readSearch WellDatabase rig-on-well history via POST /api/v2/rig/search.
Entitiesrig, operator, wellInput schema
{ "type": "object", "properties": { "query": { "type": "string" }, "operator": { "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "number" } ], "description": "Reported or aliased operator name/ID. Names resolve before rig search." }, "operatorName": { "type": "string", "minLength": 1 }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "reportDateMin": { "type": "string", "description": "Earliest rig report date (inclusive)." }, "reportDateMax": { "type": "string", "description": "Latest rig report date (inclusive)." }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 10000 }, "pageOffset": { "type": "integer", "minimum": 0 }, "sortBy": { "type": "string" }, "sortDirection": { "type": "string", "enum": [ "Ascending", "Descending" ] }, "Filters": { "type": "object", "additionalProperties": true, "description": "Advanced rig filter envelope. Well-header criteria belong under HeaderFilters." } }, "additionalProperties": true }- ⚠ Rig Records are historical observations associated with wells; use Enverus for current rig fleet/activity questions.
Historical rig-on-well records; operator/well criteria use HeaderFilters.
getWellProductionTimeseries
readMonthly production for one well by wellId, API, or UWI.
Required paramswellId or api or uwiEntitiesproduction, wellInput schema
{ "type": "object", "properties": { "wellId": { "type": "string", "examples": [ "<uuid-from-searchWells>" ], "oneOf": [ { "type": "string", "minLength": 1 }, { "type": "number", "minimum": 1 } ], "description": "WellDatabase well UUID/id returned by searchWells." }, "api": { "type": "string", "minLength": 1, "description": "Exact unformatted API number." }, "uwi": { "type": "string", "minLength": 1, "description": "Exact UWI." }, "startDate": { "type": "string", "description": "Optional inclusive production start date." }, "endDate": { "type": "string", "description": "Optional inclusive production end date." }, "granularity": { "oneOf": [ { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "daily" ] } ], "type": "string", "enum": [ "monthly", "daily" ], "description": "Production interval; defaults to monthly." } }, "additionalProperties": false, "oneOf": [ { "required": [ "wellId" ] }, { "required": [ "api" ] }, { "required": [ "uwi" ] } ], "allOf": [ { "anyOf": [ { "required": [ "wellId" ] }, { "required": [ "api" ] }, { "required": [ "uwi" ] } ] } ] }One well only. Prefer wellId; never loop across wells.
getWellDetails
readGet full well details by API number.
Required paramsapi or wellId or uwiEntitieswellInput schema
{ "type": "object", "properties": { "api": { "type": "string" }, "wellId": { "type": "number" }, "uwi": { "type": "string" } }, "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "api" ] }, { "required": [ "wellId" ] }, { "required": [ "uwi" ] } ] } ] }searchProduction
readSearch raw production records by well.
EntitiesproductionInput schema
{ "type": "object", "properties": { "query": { "type": "string" } }, "additionalProperties": true }Raw well records only; no cross-well aggregation.
searchProductionSummary
read⭐ Batch cumulative production: cumOil, cumGas, EUR, IP, decline for many wells in ONE call.
Entitiesproduction, wellInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "basin": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "field": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operatorId": { "oneOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ] }, "operatorName": { "type": "string" }, "isHorizontal": { "type": "boolean" }, "isVertical": { "type": "boolean" }, "firstProdDateMin": { "type": "string" }, "firstProdDateMax": { "type": "string" }, "cumulativeOilMin": { "type": "number" }, "cumulativeOilMax": { "type": "number" }, "cumulativeGasMin": { "type": "number" }, "cumulativeGasMax": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true }, "HeaderFilters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Cumulative/peak metrics only; not chronological buckets.
searchProductionForecast
readSearch production forecast/decline curve data.
EntitiesproductionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Predicted future production based on decline analysis
searchProductionForecastSummary
readGet aggregated production forecast summaries (WellDatabase).
EntitiesproductionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Summary of forecasted reserves and production
getTopOilProducers
readTop oil producers by cumulative oil. Supports isHorizontal and firstProdDateMin filters.
Entitiesoperator, productionInput schema
{ "type": "object", "properties": { "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "limit": { "type": "number" }, "isHorizontal": { "type": "boolean" }, "firstProdDateMin": { "type": "string" } }, "additionalProperties": false }isHorizontal:true + firstProdDateMin:"2015-01-01" filters legacy verticals.
getTopGasProducers
readTop gas producers by cumulative gas. Supports isHorizontal and firstProdDateMin filters.
Entitiesoperator, productionInput schema
{ "type": "object", "properties": { "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "limit": { "type": "number" }, "isHorizontal": { "type": "boolean" }, "firstProdDateMin": { "type": "string" } }, "additionalProperties": false }isHorizontal:true + firstProdDateMin:"2015-01-01" filters legacy verticals.
searchCompletions
readSearch well completion records (WellDatabase).
EntitiescompletionInput schema
{ "type": "object", "properties": { "query": { "type": "string" } }, "additionalProperties": true }Completion dates, intervals, and methods
searchStimulations
readSearch well stimulation/frac data.
Entitiesfrac_job, completionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "treatmentDateMin": { "type": "string" }, "treatmentDateMax": { "type": "string" }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Frac job details, proppant volumes, fluid volumes
searchStimulationSummary
readGet aggregated stimulation summary data.
Entitiesfrac_job, completionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Summary of frac treatments by well
searchFracStage
readSearch individual frac stage data.
Entitiesfrac_job, completionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "stimulationId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Per-stage details: pressures, rates, proppant, fluid
searchFracIngredients
readSearch frac fluid ingredient/chemical data.
Entitiesfrac_job, completionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "stimulationId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "ingredientName": { "type": "string" }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Chemical additives and concentrations used in frac jobs
searchCasings
readSearch casing string data (surface, intermediate, production).
EntitiescompletionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Casing sizes, weights, depths, cement data
searchPerforations
readSearch perforation interval data.
EntitiescompletionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "completionId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Perf depths, shot density, interval details
searchPlugs
readSearch plug data (bridge plugs, frac plugs).
EntitiescompletionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Plug types, depths, and installation dates
searchPlugAndAbandons
readSearch plug and abandonment records.
EntitiescompletionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "plugDateMin": { "type": "string" }, "plugDateMax": { "type": "string" }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }P&A details, cement plugs, abandonment dates
searchTubingAndPackers
readSearch tubing and packer data.
EntitiescompletionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "completionId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Tubing sizes, packer depths, completion equipment
searchDirectionals
readSearch directional survey data (WellDatabase).
Entitiestrajectory, wellInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }MD, TVD, inclination, azimuth measurements
getOffsetWellClearance
readScreen nearby offset wells for anti-collision using ISCWSA separation factor.
EntitieswellInput schema
{ "type": "object", "properties": { "wellId": { "type": "string", "examples": [ "<uuid>" ] }, "api": { "type": "string" }, "offsetWellIds": { "type": "array", "items": { "type": "string" } }, "includeLease": { "type": "boolean" }, "radiusMiles": { "type": "number" }, "maxOffsets": { "type": "number" }, "bTotal": { "type": "number", "examples": [ 48919 ] }, "dip": { "type": "number", "examples": [ 61.9 ] }, "declination": { "type": "number", "examples": [ 3.2 ] }, "errorModel": { "type": "string" } }, "additionalProperties": false, "required": [ "bTotal", "dip", "declination" ] }wellId|api; bTotal, dip, declination; offsets = name family + offsetWellIds.
searchDirectionalStepFormation
readSearch directional data with formation tops.
Entitiesformation, trajectory, wellInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Survey data correlated with formation entries
searchBoreProfile
readSearch wellbore profile/trajectory data.
EntitieswellInput schema
{ "type": "object", "properties": { "name": { "type": "string" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" } }, "additionalProperties": false }Normalized wellbore path information
searchBoreProfileReported
readSearch operator-reported bore profile data.
Entitiesdocument, wellInput schema
{ "type": "object", "properties": { "name": { "type": "string" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" } }, "additionalProperties": false }Raw reported wellbore profiles
searchFormations
readSearch formation/zone data.
EntitiesformationInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Formation names and IDs
searchFormationsRecords
readSearch formation records via POST /formations/search.
EntitiesformationInput schema
{ "type": "object", "properties": {}, "additionalProperties": true }Use when you need filter/body-style formation queries from OpenAPI
searchFormationsReported
readSearch operator-reported formation tops.
Entitiesdocument, formationInput schema
{ "type": "object", "properties": { "name": { "type": "string" }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" } }, "additionalProperties": false }Raw reported formation depths
searchHorizon
readSearch horizon/target formation data.
EntitiesformationInput schema
{ "type": "object", "properties": { "name": { "type": "string" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" } }, "additionalProperties": false }Target zones and landing points
searchInterpretedFormation
readSearch interpreted/normalized formation data.
EntitiesformationInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "formationName": { "type": "string" }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Standardized formation assignments
searchCores
readSearch core sample data.
EntitiescompletionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Core intervals, recovery, and analysis data
searchInjection
readSearch injection records (water, CO2, gas injection wells).
EntitiesrecordInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "reportDateMin": { "type": "string" }, "reportDateMax": { "type": "string" }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Monthly injection data for disposal/injection wells
searchInjectionSummary
readGet cumulative injection summary data.
EntitiesrecordInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Aggregate injection volumes
searchWaterChemicals
readSearch water chemistry/analysis data.
Entitiesfrac_job, completionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "sampleDateMin": { "type": "string" }, "sampleDateMax": { "type": "string" }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Produced water chemistry data
searchWaterSummary
readWater volume production summary by well (WellDatabase water disposal and production).
EntitiesrecordInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Aggregate water production volumes
searchTests
readSearch well test data (DST, production tests) (WellDatabase).
EntitiescompletionInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "testDateMin": { "type": "string" }, "testDateMax": { "type": "string" }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Drill stem tests, production tests, formation tests
searchPermits
readSearch drilling permit data (WellDatabase).
EntitiespermitInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "permitNumber": { "type": "string" }, "permitDateMin": { "type": "string" }, "permitDateMax": { "type": "string" }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Permit numbers, dates, proposed depths, operators
getPermitsGeoJSON
readDrilling permits as a GeoJSON FeatureCollection for the map viewer.
EntitiespermitInput schema
{ "type": "object", "properties": { "useBottomHole": { "type": "boolean" }, "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "permitNumber": { "type": "string" }, "permitDateMin": { "type": "string" }, "permitDateMax": { "type": "string" }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "operator": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Uses permit filters and joined well coordinates; skips records without.
searchDisposition
readSearch well disposition/status change data.
EntitiesleaseInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Status changes and regulatory dispositions
searchDispositionSummary
readSearch aggregated disposition summary records.
EntitiesleaseInput schema
{ "type": "object", "properties": {}, "additionalProperties": true }OpenAPI /dispositionSummary/search endpoint
searchSpacing
readSearch well spacing unit data.
EntitiesrecordInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Spacing orders, unit configurations
searchEnvironmentalIncident
readSearch environmental incident reports.
EntitiesincidentInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "incidentDateMin": { "type": "string" }, "incidentDateMax": { "type": "string" }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Spills, releases, and environmental events
searchEnvironmentalIncidentComment
readSearch comments on environmental incidents.
EntitiesincidentInput schema
{ "type": "object", "properties": { "incidentId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Additional incident details and notes
searchEnvironmentalIncidentSubstance
readSearch substances involved in environmental incidents.
EntitiesincidentInput schema
{ "type": "object", "properties": { "incidentId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Spilled materials, volumes, and types
searchFiles
readSearch scanned files and document attachments linked to well records.
EntitiesdocumentInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fileName": { "type": "string" }, "fileType": { "type": "string" }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Attached documents, reports, images
searchFileTags
readSearch file tags/categories.
EntitiesdocumentInput schema
{ "type": "object", "properties": { "tagName": { "type": "string" }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Document classification and tagging
searchHistory
readSearch well history/event records.
EntitiesrecordInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "eventType": { "type": "string" }, "eventDateMin": { "type": "string" }, "eventDateMax": { "type": "string" }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Chronological well events and activities
searchDeletedItems
readSearch deleted/removed records.
EntitiesrecordInput schema
{ "type": "object", "properties": { "entityType": { "type": "string" }, "deletedDateMin": { "type": "string" }, "deletedDateMax": { "type": "string" }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Audit trail of removed data
searchCounties
readLookup county IDs by name.
EntitiesrecordInput schema
{ "type": "object", "properties": { "name": { "type": "string" }, "PageSize": { "type": "number" }, "PageOffset": { "type": "number" } }, "additionalProperties": true }searchStates
readLookup state IDs and information.
EntitiesrecordInput schema
{ "type": "object", "properties": { "name": { "type": "string" }, "PageSize": { "type": "number" }, "PageOffset": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "includeWellCounts": { "type": "boolean" } }, "additionalProperties": true }State codes and FIPS IDs
searchStateCounties
readGet counties within a state.
EntitiesrecordInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "pageOffset": { "type": "number" }, "pageSize": { "type": "number" }, "stateId": { "type": "number" }, "countyId": { "type": "number" } }, "additionalProperties": true, "required": [ "id" ] }List counties by state ID
searchCountry
readLookup country information.
EntitiesrecordInput schema
{ "type": "object", "properties": { "name": { "type": "string" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "stateId": { "type": "number" }, "countyId": { "type": "number" } }, "additionalProperties": true, "required": [ "name" ] }Country codes and IDs (US, Canada)
searchBasin
readSearch basin/play data.
EntitiesrecordInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Sedimentary basins and sub-basins
searchOperatorAliased
readSearch normalized/aliased operator names.
EntitiesoperatorInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Standardized operator identification
searchOperatorReported
readSearch raw reported operator names.
Entitiesdocument, operatorInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Operator names as reported to regulators
searchFieldAliased
readSearch normalized field names.
EntitiesfieldInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Standardized field identification
searchFieldReported
readSearch raw reported field names.
Entitiesdocument, fieldInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Field names as reported to regulators
searchGatherer
readSearch gas gatherer/pipeline data.
EntitiesrecordInput schema
{ "type": "object", "properties": { "api": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "wellId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "gathererName": { "type": "string" }, "state": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "county": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "PageSize": { "type": "number" }, "pageOffset": { "type": "number" }, "PageOffset": { "type": "number" }, "SortBy": { "type": "string" }, "SortDirection": { "oneOf": [ { "type": "string", "enum": [ "Ascending" ] }, { "type": "string", "enum": [ "Descending" ] } ] }, "Filters": { "type": "object", "properties": {}, "additionalProperties": true } }, "additionalProperties": false }Gathering systems and transporters
searchStatusAliased
readSearch normalized well status values.
EntitiesrecordInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Standardized status codes (Active, Shut-in, P&A, etc.)
searchStatusReported
readSearch raw reported well status values.
EntitiesdocumentInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Status as reported to regulators
searchTypeAliased
readSearch normalized well type values.
EntitiesrecordInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Standardized types (Oil, Gas, Injection, etc.)
searchTypeReported
readSearch raw reported well type values.
EntitiesdocumentInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Well types as reported to regulators
searchLease
readSearch lease information.
EntitiesleaseInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Lease names and IDs
searchShalePlay
readSearch shale play/formation data.
EntitiesrecordInput schema
{ "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "stateId": { "type": "number" }, "countyId": { "type": "number" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true }Major shale plays (Permian, Eagle Ford, Bakken, etc.)
searchResource
readGeneric POST /{resource}/search handler for full OpenAPI coverage.
Required paramsresourceEntitiesrecordInput schema
{ "type": "object", "properties": { "resource": { "type": "string" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true, "required": [ "resource" ] }Use when no specific helper exists. Pass resource segment, e.g. permits, files.
aggregateResource
readGeneric POST /{resource}/aggregate handler for OpenAPI coverage.
Required paramsresourceEntitiesrecordInput schema
{ "type": "object", "properties": { "resource": { "type": "string" } }, "additionalProperties": true, "required": [ "resource" ] }Currently production is the supported aggregate resource.
getResource
readGeneric GET /{resource} handler for top-level lookup resources.
Required paramsresourceEntitiesrecordInput schema
{ "type": "object", "properties": { "resource": { "type": "string" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true, "required": [ "resource" ] }Resources: apistate, apicounty, basin, operator, formations, shaleplay.
getResourceById
readGeneric GET /{resource}/{id} handler for top-level lookup resources.
Required paramsresourceidEntitiesrecordInput schema
{ "type": "object", "properties": { "resource": { "type": "string" }, "id": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": true, "required": [ "resource", "id" ] }getNestedResource
readGeneric GET /{entityType}/{entityId}/{resource} handler for nested lookups.
Required paramsentityTypeentityIdresourceEntitiesrecordInput schema
{ "type": "object", "properties": { "entityType": { "type": "string" }, "entityId": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "resource": { "type": "string" }, "pageSize": { "type": "number" }, "pageOffset": { "type": "number" } }, "additionalProperties": false, "required": [ "entityType", "entityId", "resource" ] }E.g. apistate/{id}/production, basin/{id}/operators, formations/{id}/counties.