What you can ask
- “What does WellDatabase have for the area or asset I'm working on?”
- “Pull the most recent WellDatabase records and put them in a table.”
- “What does WellDatabase cover, and how fresh is the data?”
About this source
Oil/gas wells. Prefer searchWells wellId. - getOperatorProductionTrend({operator,state,fluid}) — ⭐ compact monthly trend; oil default. - aggregateProduction({state|county|basin|field,...}) — area or filtered-set trend. - getOperatorProduction({operator,state}) — per-well cumulative/peak summaries. - searchProductionSummary({operator,state}) — batch cumulative production. - getWellProductionTimeseries({wellId|api|uwi}) — one well only. - searchWells({sortBy:"CumOil"}) — ranked production + trajectory headers. Never loop per-well timeseries or auto-map. Map only on explicit request using coordinatesJson: JSON.stringify(result). getOperatorWells/searchWells include trajectory LINESTRING, depth, lateralLength, and surface/heel/KOP/BH. pageSize 50; page through totals.
Connector ID welldatabase
Provenance
Freshness & coverage
Caveats
- ⚠ API access requires a valid WellDatabase subscription key.
› Methods (61)
Technical detail for developers: parameters, pagination, units, and freshness per method.
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: percent- ⚠ 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 wellIdEntitieswellPaginationnonePass 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: bbl- ⚠ 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: bbl- ⚠ 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, operatorPaginationnonePer-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)Default pageSize 50. Preserve raw result when mapping with subsurface.
searchWells
readSearch well headers by well name, operator, API, state, county, or field.
EntitieswellPaginationoffset (offsetField: pageOffset, limitField: pageSize)Combine known identity fields before asking for another identifier.
searchWellSummary
readSearch well summary data with aggregated metrics.
EntitieswellPaginationoffset (offsetField: pageOffset, limitField: pageSize)Returns summary-level well information.
searchWellLocation
readSearch well locations with coordinates and surface hole data.
EntitieswellPaginationoffset (offsetField: pageOffset, limitField: pageSize)Returns lat/long, surface location, and geographic data.
searchRigs
readSearch WellDatabase rig-on-well history via POST /api/v2/rig/search.
Entitiesrig, operator, wellPaginationoffset (offsetField: pageOffset, limitField: pageSize)- ⚠ 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, wellPaginationnoneOne well only. Prefer wellId; never loop across wells.
getWellDetails
readGet full well details by API number.
Required paramsapi or wellId or uwiEntitieswellPaginationnonesearchProduction
readSearch raw production records by well.
EntitiesproductionPaginationoffset (offsetField: pageOffset, limitField: pageSize)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, wellPaginationoffset (offsetField: pageOffset, limitField: pageSize)Cumulative/peak metrics only; not chronological buckets.
searchProductionForecast
readSearch production forecast/decline curve data.
EntitiesproductionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Predicted future production based on decline analysis
searchProductionForecastSummary
readGet aggregated production forecast summaries (WellDatabase).
EntitiesproductionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Summary of forecasted reserves and production
searchCompletions
readSearch well completion records (WellDatabase).
EntitiescompletionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Completion dates, intervals, and methods.
searchStimulations
readSearch well stimulation/frac data.
Entitiesfrac_job, completionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Frac job details, proppant volumes, fluid volumes
searchStimulationSummary
readGet aggregated stimulation summary data.
Entitiesfrac_job, completionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Summary of frac treatments by well
searchFracStage
readSearch individual frac stage data.
Entitiesfrac_job, completionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Per-stage details: pressures, rates, proppant, fluid
searchFracIngredients
readSearch frac fluid ingredient/chemical data.
Entitiesfrac_job, completionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Chemical additives and concentrations used in frac jobs
searchCasings
readSearch casing string data (surface, intermediate, production).
EntitiescompletionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Casing sizes, weights, depths, cement data
searchPerforations
readSearch perforation interval data.
EntitiescompletionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Perf depths, shot density, interval details
searchPlugs
readSearch plug data (bridge plugs, frac plugs).
EntitiescompletionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Plug types, depths, and installation dates
searchPlugAndAbandons
readSearch plug and abandonment records.
EntitiescompletionPaginationoffset (offsetField: pageOffset, limitField: pageSize)P&A details, cement plugs, abandonment dates
searchTubingAndPackers
readSearch tubing and packer data.
EntitiescompletionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Tubing sizes, packer depths, completion equipment
searchDirectionals
readSearch directional survey data (WellDatabase).
Entitiestrajectory, wellPaginationoffset (offsetField: pageOffset, limitField: pageSize)MD, TVD, inclination, azimuth measurements
getOffsetWellClearance
readScreen nearby offset wells for anti-collision using ISCWSA separation factor.
EntitieswellPaginationnonewellId|api; bTotal, dip, declination; offsets = name family + offsetWellIds.
searchDirectionalStepFormation
readSearch directional data with formation tops.
Entitiesformation, trajectory, wellPaginationoffset (offsetField: pageOffset, limitField: pageSize)Survey data correlated with formation entries
searchDirectionalSurvey
readSearch WellDatabase directional survey headers, not individual survey stations.
Entitiestrajectory, well, surveyPaginationoffset (offsetField: pageOffset, limitField: pageSize)Use searchDirectionals for measured-depth survey points.
searchFormationsRecords
readSearch formation records via POST /formations/search.
EntitiesformationPaginationoffset (offsetField: pageOffset, limitField: pageSize)Use when you need filter/body-style formation queries from the provider API.
searchInterpretedFormation
readSearch interpreted/normalized formation data.
EntitiesformationPaginationoffset (offsetField: pageOffset, limitField: pageSize)Standardized formation assignments
searchCores
readSearch core sample data.
EntitiescompletionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Core intervals, recovery, and analysis data
searchCoreAnalysis
readSearch WellDatabase laboratory core-analysis measurements and results.
EntitiescompletionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Core analysis records, distinct from physical core inventory.
searchInjection
readSearch injection records (water, CO2, gas injection wells).
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Monthly injection data for disposal/injection wells
searchInjectionSummary
readGet cumulative injection summary data.
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Aggregate injection volumes
searchWaterChemicals
readSearch water chemistry/analysis data.
Entitiesfrac_job, completionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Produced water chemistry data
searchWaterSummary
readWater volume production summary by well (WellDatabase water disposal and production).
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Aggregate water production volumes
searchTests
readSearch well test data (DST, production tests) (WellDatabase).
EntitiescompletionPaginationoffset (offsetField: pageOffset, limitField: pageSize)Drill stem tests, production tests, formation tests
searchPermits
readSearch drilling permit data (WellDatabase).
EntitiespermitPaginationoffset (offsetField: pageOffset, limitField: pageSize)Permit numbers, dates, proposed depths, operators
searchDisposition
readSearch well disposition/status change data.
EntitiesleasePaginationoffset (offsetField: pageOffset, limitField: pageSize)Status changes and regulatory dispositions
searchDispositionSummary
readSearch aggregated disposition summary records.
EntitiesleasePaginationoffset (offsetField: pageOffset, limitField: pageSize)Provider /dispositionSummary/search endpoint.
searchRegulatoryOrders
readSearch WellDatabase regulatory-order records linked to wells and jurisdictions.
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Structured order metadata from /regulatoryOrders/search.
searchRegulatoryOrderText
readSearch WellDatabase regulatory-order text records and document content.
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Text records from /regulatoryOrderText/search.
searchSpacing
readSearch well spacing unit data.
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Spacing orders, unit configurations
searchEnvironmentalIncident
readSearch environmental incident reports.
EntitiesincidentPaginationoffset (offsetField: pageOffset, limitField: pageSize)Spills, releases, and environmental events
searchEnvironmentalIncidentComment
readSearch comments on environmental incidents.
EntitiesincidentPaginationoffset (offsetField: pageOffset, limitField: pageSize)Additional incident details and notes
searchEnvironmentalIncidentSubstance
readSearch substances involved in environmental incidents.
EntitiesincidentPaginationoffset (offsetField: pageOffset, limitField: pageSize)Spilled materials, volumes, and types
searchFiles
readSearch scanned files and document attachments linked to well records.
EntitiesdocumentPaginationoffset (offsetField: pageOffset, limitField: pageSize)Attached documents, reports, images
searchFileTags
readSearch file tags/categories.
EntitiesdocumentPaginationoffset (offsetField: pageOffset, limitField: pageSize)Document classification and tagging
searchHistory
readSearch well history/event records.
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Chronological well events and activities
searchDeletedItems
readSearch deleted/removed records.
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Audit trail of removed data
searchContacts
readSearch WellDatabase contact records associated with wells and organizations.
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Contact records from /contacts/search.
searchOwners
readSearch WellDatabase mineral, lease, and working-interest owner records.
EntitiesownershipPaginationoffset (offsetField: pageOffset, limitField: pageSize)Ownership records from /owners/search.
searchWellFinancial
readSearch WellDatabase well-level financial and economic records.
EntitieswellPaginationoffset (offsetField: pageOffset, limitField: pageSize)Financial records from /wellfinancial/search.
searchLeaseProductionVolumes
readSearch WellDatabase production volumes reported at the lease level.
Entitiesproduction, leasePaginationoffset (offsetField: pageOffset, limitField: pageSize)Supports record IDs and dates, not well, API, operator, or lease-name filters.
searchGatherer
readSearch gas gatherer/pipeline data.
EntitiesrecordPaginationoffset (offsetField: pageOffset, limitField: pageSize)Gathering systems and transporters
downloadFiles
readDownload selected WellDatabase well-file binaries to a private signed link.
Entitieswell filePaginationnonePass exact file UUIDs; provider bytes never enter model text.
getResource
readList one exact WellDatabase reference resource selected by its provider identifier.
Required paramsresourceEntitiesreference dataPaginationoffset (offsetField: pageOffset, limitField: pageSize)Select a resource enum value; paginate with pageSize and pageOffset.
getResourceById
readGet one exact WellDatabase reference-resource record by its provider ID.
Required paramsresourceidEntitiesreference dataPaginationoffset (offsetField: pageOffset, limitField: pageSize)getNestedResource
readList one exact documented relationship from a WellDatabase reference entity.
Required paramsentityTypeentityIdresourceEntitiesreference relationshipPaginationoffset (offsetField: pageOffset, limitField: pageSize)The pinned API help supports every declared entityType and nested-resource pair.
