WellDatabase

Methods (73)

• getWellLifecycle

  read

  ⭐ ONE-CALL well dossier: completions+casings+stims+tests+spacing+cores+water+financial.

  Pass wellId (UUID) or api. include:{tests:false,...} trims sections.

• getOperatorProduction

  read

  ⭐ Wells + production summaries auto-joined in 2 calls. Use instead of looping per-well.

  Required paramsoperator

• getOperatorWells

  read

  Get wells by operator (headers only). Use getOperatorProduction if you also need production.

  Required paramsoperator

  Default pageSize 50. Preserve raw result when mapping with subsurface.

• searchWells

  read

  Search wells by operator/state/county/field/api (sortBy CumOil/CumGas); headers + trajectory.

  state+operator w/o a date filter scans all wells — add FirstCompletionDate.

• searchWellSummary

  read

  Search well summary data with aggregated metrics.

  Returns summary-level well information

• searchWellLocation

  read

  Search well locations with coordinates and surface hole data.

  Returns lat/long, surface location, and geographic data

• getWellProductionTimeseries

  read

  Monthly production timeseries for a SINGLE well. Never loop — use searchProductionSummary.

  Required paramsapi

• getWellDetails

  read

  Get full well details by API number.

  Required paramsapi

• searchProduction

  read

  Search monthly production records (oil, gas, water volumes).

  Monthly production data by well

• searchProductionSummary

  read

  ⭐ Batch production: cumOil, cumGas, EUR, IP, decline for many wells in ONE call.

  sortBy: "CumulativeOil"/"CumulativeGas", sortOrder: "desc" for top producers.

• searchProductionForecast

  read

  Search production forecast/decline curve data.

  Predicted future production based on decline analysis

• searchProductionForecastSummary

  read

  Get aggregated production forecast summaries.

  Summary of forecasted reserves and production

• getTopOilProducers

  read

  Top oil producers by cumulative oil. Supports isHorizontal and firstProdDateMin filters.

  isHorizontal:true + firstProdDateMin:"2015-01-01" filters legacy verticals.

• getTopGasProducers

  read

  Top gas producers by cumulative gas. Supports isHorizontal and firstProdDateMin filters.

  isHorizontal:true + firstProdDateMin:"2015-01-01" filters legacy verticals.

• searchCompletions

  read

  Search well completion records.

  Completion dates, intervals, and methods

• searchStimulations

  read

  Search well stimulation/frac data.

  Frac job details, proppant volumes, fluid volumes

• searchStimulationSummary

  read

  Get aggregated stimulation summary data.

  Summary of frac treatments by well

• searchFracStage

  read

  Search individual frac stage data.

  Per-stage details: pressures, rates, proppant, fluid

• searchFracIngredients

  read

  Search frac fluid ingredient/chemical data.

  Chemical additives and concentrations used in frac jobs

• searchCasings

  read

  Search casing string data (surface, intermediate, production).

  Casing sizes, weights, depths, cement data

• searchPerforations

  read

  Search perforation interval data.

  Perf depths, shot density, interval details

• searchPlugs

  read

  Search plug data (bridge plugs, frac plugs).

  Plug types, depths, and installation dates

• searchPlugAndAbandons

  read

  Search plug and abandonment records.

  P&A details, cement plugs, abandonment dates

• searchTubingAndPackers

  read

  Search tubing and packer data.

  Tubing sizes, packer depths, completion equipment

• searchDirectionals

  read

  Search directional survey data.

  MD, TVD, inclination, azimuth measurements

• searchDirectionalStepFormation

  read

  Search directional data with formation tops.

  Survey data correlated with formation entries

• searchBoreProfile

  read

  Search wellbore profile/trajectory data.

  Normalized wellbore path information

• searchBoreProfileReported

  read

  Search operator-reported bore profile data.

  Raw reported wellbore profiles

• searchFormations

  read

  Search formation/zone data.

  Formation names and IDs

• searchFormationsRecords

  read

  Search formation records via POST /formations/search.

  Use when you need filter/body-style formation queries from OpenAPI

• searchFormationsReported

  read

  Search operator-reported formation tops.

  Raw reported formation depths

• searchHorizon

  read

  Search horizon/target formation data.

  Target zones and landing points

• searchInterpretedFormation

  read

  Search interpreted/normalized formation data.

  Standardized formation assignments

• searchCores

  read

  Search core sample data.

  Core intervals, recovery, and analysis data

• searchInjection

  read

  Search injection records (water, CO2, gas injection wells).

  Monthly injection data for disposal/injection wells

• searchInjectionSummary

  read

  Get cumulative injection summary data.

  Aggregate injection volumes

• searchWaterChemicals

  read

  Search water chemistry/analysis data.

  Produced water chemistry data

• searchWaterSummary

  read

  Get water production summary data.

  Aggregate water production volumes

• searchTests

  read

  Search well test data (DST, production tests).

  Drill stem tests, production tests, formation tests

• searchPermits

  read

  Search drilling permit data.

  Permit numbers, dates, proposed depths, operators

• getPermitsGeoJSON

  read

  Drilling permits as a GeoJSON FeatureCollection for the map viewer.

  Uses permit filters and joined well coordinates; skips records without.

• searchDisposition

  read

  Search well disposition/status change data.

  Status changes and regulatory dispositions

• searchDispositionSummary

  read

  Search aggregated disposition summary records.

  OpenAPI /dispositionSummary/search endpoint

• searchSpacing

  read

  Search well spacing unit data.

  Spacing orders, unit configurations

• searchRigs

  read

  Search active rig data.

  Rig locations, operators, target formations

• searchEnvironmentalIncident

  read

  Search environmental incident reports.

  Spills, releases, and environmental events

• searchEnvironmentalIncidentComment

  read

  Search comments on environmental incidents.

  Additional incident details and notes

• searchEnvironmentalIncidentSubstance

  read

  Search substances involved in environmental incidents.

  Spilled materials, volumes, and types

• searchFiles

  read

  Search well files and documents.

  Attached documents, reports, images

• searchFileTags

  read

  Search file tags/categories.

  Document classification and tagging

• searchHistory

  read

  Search well history/event records.

  Chronological well events and activities

• searchDeletedItems

  read

  Search deleted/removed records.

  Audit trail of removed data

• searchCounties

  read

  Lookup county IDs by name.

  Required paramsname

• searchStates

  read

  Lookup state IDs and information.

  State codes and FIPS IDs

• searchStateCounties

  read

  Get counties within a state.

  List counties by state ID

• searchCountry

  read

  Lookup country information.

  Country codes and IDs (US, Canada)

• searchBasin

  read

  Search basin/play data.

  Sedimentary basins and sub-basins

• searchOperatorAliased

  read

  Search normalized/aliased operator names.

  Standardized operator identification

• searchOperatorReported

  read

  Search raw reported operator names.

  Operator names as reported to regulators

• searchFieldAliased

  read

  Search normalized field names.

  Standardized field identification

• searchFieldReported

  read

  Search raw reported field names.

  Field names as reported to regulators

• searchGatherer

  read

  Search gas gatherer/pipeline data.

  Gathering systems and transporters

• searchStatusAliased

  read

  Search normalized well status values.

  Standardized status codes (Active, Shut-in, P&A, etc.)

• searchStatusReported

  read

  Search raw reported well status values.

  Status as reported to regulators

• searchTypeAliased

  read

  Search normalized well type values.

  Standardized types (Oil, Gas, Injection, etc.)

• searchTypeReported

  read

  Search raw reported well type values.

  Well types as reported to regulators

• searchLease

  read

  Search lease information.

  Lease names and IDs

• searchShalePlay

  read

  Search shale play/formation data.

  Major shale plays (Permian, Eagle Ford, Bakken, etc.)

• searchResource

  read

  Generic POST /{resource}/search handler for full OpenAPI coverage.

  Required paramsresource

  Use when no specific helper exists. Pass resource segment, e.g. permits, files.

• aggregateResource

  read

  Generic POST /{resource}/aggregate handler for OpenAPI coverage.

  Required paramsresource

  Currently production is the supported aggregate resource.

• getResource

  read

  Generic GET /{resource} handler for top-level lookup resources.

  Required paramsresource

  Resources: apistate, apicounty, basin, operator, formations, shaleplay.

• getResourceById

  read

  Generic GET /{resource}/{id} handler for top-level lookup resources.

  Required paramsresourceid

• getNestedResource

  read

  Generic GET /{entityType}/{entityId}/{resource} handler for nested lookups.

  Required paramsentityTypeentityIdresource

  E.g. apistate/{id}/production, basin/{id}/operators, formations/{id}/counties.