Get a well
A well's header: operator, location, formation, lateral, TVD, completions, dates and cumulative production.
Get a well
/wells/{key}A well's header: operator, location, formation, lateral, TVD, completions, dates and cumulative production. Send fields to skip the header fields you don't need, and include=floors to learn which values may start at the dataset's first production month rather than at the well's own start.
Parameters
Path parameters
keystringRequiredWellbore key, as SB329-01414. GET /wells/facets, /wells/search, /wells/typecurve and /wells/production are paths, not wells: keys are API numbers or SBnnn-nnnnn, so no well is shadowed.
Query parameters
fieldsstringOptionalOnly these fields, comma-separated; absent or empty, every field.
wellbore_keyis always kept, and the response keeps its own key order.Allowed: any of the well's header fields listed below.
Header fields:
wellbore_key,well_name,operator,basin,subbasin,state,county,formation,lateral_length,tvd_td,shl_lat,shl_lon,bhl_lat,bhl_lon,heel_lat,heel_lon,lat,lon,first_prod,last_prod,cum_oil_12,cum_gas_12,cum_boe_12,cum_oil_life,cum_gas_life,cum_boe_life,total_proppant,total_fluid,stage_count,frac_date,til_date.For example
well_name,tvd_td.fieldsis checked before the well is looked up, so a bad name is a 400 whatever the key.Names are top-level only (no dots), case-sensitive and never empty; one not allowed here is a 400 with the allowed names in
details.allowed.includestringOptionalfloorsaddsfloored: the names of this answer's fields whose value may start at the dataset's first production month, not at the well's own start.The record starts in that month (GET /dataset
first_production), so a well whose first production falls in it may have produced earlier, unless itstil_dateis in that month too (the ruleexclude_flooruses on POST /wells/typecurve). Such a well'sfirst_prodis the floor month, and itscum_*_12andcum_*_lifecount only from it: show them as "before <month>" or "since <month>", not as facts. The values don't change.flooredlists only fields this answer has (withfields, those asked), is[]for a well that isn't floored, and is absent withoutinclude; an empty value is the same as none. Any other nonempty value, or one named twice, is a 400 with details.field include, checked before the well is looked up."floors"model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
The model set to answer from, an
idfrom GET /model-sets. Absent: the set GET /model-sets names asdefault, the base dataset unless the server answers from a published set.model_set=defaultreaches the base dataset; once the server retires it, a 400 naming the set answering instead.- An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in
details.allowed(published sets only oncedefaultis retired); a set that can't load, a 503 with the reason. - Plans and exports stay in their set: a call naming them (by path,
plan,ids,source.plan, a scenario'splan.id, or a comparison'sa.planandb.plan, also undersource.comparison) reaches it withoutmodel_set. - An explicit
model_setwins; naming resources of two sets in one request is a 400.
Responses
200 OK
The well.
wellbore_keystringRequiredWellbore key.
well_namestring or nullOptionalWell name.
operatorstring or nullOptionalCurrent operator.
basinstring or nullOptionalBasin.
subbasinstring or nullOptionalSub-basin.
statestring or nullOptionalState.
countystring or nullOptionalCounty.
formationstring or nullOptionalLanding formation.
lateral_lengthnumber or nullOptionalLateral length, ft.
tvd_tdnumber or nullOptionalTrue vertical depth, ft.
shl_latnumber or nullOptionalSurface hole latitude.
shl_lonnumber or nullOptionalSurface hole longitude.
Show all 32 fields
bhl_latnumber or nullOptionalBottom hole latitude.
bhl_lonnumber or nullOptionalBottom hole longitude.
heel_latnumber or nullOptionalHeel latitude.
heel_lonnumber or nullOptionalHeel longitude.
latnumber or nullOptionalHeader latitude.
lonnumber or nullOptionalHeader longitude.
first_prodstring or nullOptionalFormat
dateFirst production.
last_prodstring or nullOptionalFormat
dateLast production.
cum_oil_12number or nullOptionalFirst 12 months oil, whole bbl.
cum_gas_12number or nullOptionalFirst 12 months gas, whole mcf.
cum_boe_12number or nullOptionalFirst 12 months, whole BOE.
cum_oil_lifenumber or nullOptionalCumulative oil, whole bbl.
cum_gas_lifenumber or nullOptionalCumulative gas, whole mcf.
cum_boe_lifenumber or nullOptionalCumulative BOE, whole.
total_proppantnumber or nullOptionalProppant, whole lb.
total_fluidnumber or nullOptionalFluid, whole bbl.
stage_countinteger or nullOptionalFrac stages.
frac_datestring or nullOptionalFormat
dateFrac date.
til_datestring or nullOptionalFormat
dateTurn-in-line date.
flooredarray of stringsOptionalWith include=floors only: the fields here whose value may start at the dataset's first production month rather than at the well's own start (
first_prodis then that floor month; 12-month and to-date volumes count only from it). Empty for a well that isn't floored."first_prod""cum_oil_12""cum_gas_12""cum_boe_12""cum_oil_life""cum_gas_life""cum_boe_life"
304 Unchanged since the ETag in If-None-Match.Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
Shared errors400401403500503What they mean