List wells
Existing wells for a map: every matching well as parallel arrays (format=columns, the default), or a page of GeoJSON Points at each lateral's midpoint (format=geojson).
List wells
/wellsExisting wells for a map: every matching well as parallel arrays (format=columns, the default), or a page of GeoJSON Points at each lateral's midpoint (format=geojson).
Formats
format=columns includes names, operators and first year: about 0.6 MB gzipped for the whole basin. Both formats page with limit and cursor. fields keeps only the fields you name, and adds header fields and derived ones: per-ft completions, and 12-month BOE, oil and gas per 1,000 ft of lateral.
Filters
Filters combine. To find wells by name, key or operator without downloading the basin, send q or operator with format=geojson and a small limit. near keeps the wells within radius_mi, nearest first, each with its distance_mi. county and operators match exact names, keys wellbore keys; sort and order order the wells. GET /wells/facets counts wells by value, for pickers and range sliders.
Ranges
<field>_min and <field>_max are inclusive and compare the value as a response shows it, rounded; a well without the value never matches. Numbers are digits with an optional decimal, as 9000.5; dates are YYYY-MM-DD. A _min above its _max is a 400; a range on a field without one is ignored, as any unknown parameter is.
Applied
applied echoes how the server read sort, order, county, operators, the ranges and columns paging; absent when none is sent.
Parameters
Query parameters
formatstringOptionalDefault
"columns"Response layout.
"columns""geojson"formationstringOptionalOnly these formations: one name or a comma-separated list, case-insensitive, as
WOLFCAMP A,WOLFCAMP B.bboxstringOptionalOnly wells whose lateral midpoint is inside
west,south,east,north(degrees), as-102.05,31.9,-101.85,32.05.qstringOptionalup to 100 characters
Only wells whose name or wellbore key contains this text, ignoring case:
woodard trustmatches WOODARD TRUST 32-44 2WB. Leading and trailing spaces are ignored; up to 100 characters (400 past it).operatorstringOptionalup to 100 characters
Only wells whose operator contains this text, ignoring case; up to 100 characters (400 past it).
nearstringOptionalOnly wells within
radius_miof this point, nearest first, each with itsdistance_mi:lng,latin WGS 84 degrees, longitude first as inbbox.Distance is great-circle miles to each lateral's midpoint;
distance_mirounds it to 0.01 (a column withformat=columns, a property withformat=geojson). Ties at the exact distance go by wellbore key, socursorpages are stable. 400 unless it is two numbers within -180 to 180 and -90 to 90. Without it, wells come in wellbore key order.radius_minumberOptionalDefault
5> 0, ≤ 100With
near(400 without it): how far from it to look, in miles, a decimal greater than 0 and at most 100 written as digits (2 or 2.5); default 5.limitintegerOptionalDefault
100≥ 1, ≤ 10000Page size: with format=geojson, 1 to 1,000 wells (default 100); with format=columns, 1 to 10,000 (100 when only
cursoris sent), and the response addsnext_cursor. Withoutlimitorcursor, format=columns returns every matching well.cursorstringOptionalPage to read:
next_cursorfrom the previous page, in either format.fieldsstringOptionalOnly these fields, comma-separated; absent or empty, every field.
wellbore_keyis always kept, and the response keeps its own key order.Allowed: the columns or properties listed below, and
distance_miwithnear.Columns, with format=columns:
wellbore_key,well_name,operator,formation,mid_lon,mid_lat,shl_lon,shl_lat,heel_lon,heel_lat,bhl_lon,bhl_lat,cum_boe_12,first_year. Properties, with format=geojson:wellbore_key,well_name,operator,formation,first_prod,lateral_length,tvd_td,cum_boe_12,shl_lon,shl_lat,heel_lon,heel_lat,bhl_lon,bhl_lat.distance_miwithoutnearis a 400.Either format also takes
basin,subbasin,state,county,lateral_length,tvd_td,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,first_year,fluid_bbl_per_ft,proppant_lb_per_ft,cum_boe_12_per_1000_ft,cum_oil_12_per_1000_ft,cum_gas_12_per_1000_ft.These are GET /wells/{key}'s header fields,
first_year, per-ft completions, and 12-month BOE, oil (bbl) and gas (mcf) per 1,000 ft of lateral, after the default fields in that order.Coordinates are rounded to 5 decimals, volumes to whole units, per-ft values to 0.1, and dates are YYYY-MM-DD.
latandlonare the header's point; the map usesmid_lonandmid_lat.For example
well_name,formation,cum_boe_12.countandformat, or a feature'stype,idandgeometryand the page'snext_cursor, are always there.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.sortstringOptionalOrder the wells by this field: any name
fieldstakes except the coordinates, ordistance_miwithnear; an unknown name is a 400 withdetails.allowed.Wells without a value come last either way; ties go by wellbore key, so
cursorpages are stable. Withnear,sortreplaces the distance order and the radius still filters."wellbore_key""well_name""operator""formation""cum_boe_12""first_year""first_prod""lateral_length""tvd_td""basin""subbasin""state""county""last_prod""cum_oil_12""cum_gas_12""cum_oil_life""cum_gas_life""cum_boe_life""total_proppant"10 more values
"total_fluid""stage_count""frac_date""til_date""fluid_bbl_per_ft""proppant_lb_per_ft""cum_boe_12_per_1000_ft""cum_oil_12_per_1000_ft""cum_gas_12_per_1000_ft""distance_mi"orderstringOptionalDefault
"desc"With
sort(ignored without it):desc, largest or latest first, orasc."asc""desc"
Show all 58 parameters
countystringOptionalOnly wells in these counties: exact names, case-insensitive, comma-separated, at most 50.
operatorsarray of stringsOptionalup to 50 itemsItems up to 100 characters
Only wells of these operators: exact names, case-insensitive. Repeat the parameter for each name (
operators=A&operators=B), since operator names can contain commas; at most 50, each at most 100 characters (400 past either, withdetails.maxanddetails.count).operatorstays a substring match. GET /wells/facets lists the names.lateral_length_minnumberOptionalOnly wells whose
lateral_lengthis at least this, in ft.lateral_length_maxnumberOptionalOnly wells whose
lateral_lengthis at most this, in ft.tvd_td_minnumberOptionalOnly wells whose
tvd_tdis at least this, in ft.tvd_td_maxnumberOptionalOnly wells whose
tvd_tdis at most this, in ft.cum_oil_12_minnumberOptionalOnly wells whose
cum_oil_12is at least this, in bbl.cum_oil_12_maxnumberOptionalOnly wells whose
cum_oil_12is at most this, in bbl.cum_gas_12_minnumberOptionalOnly wells whose
cum_gas_12is at least this, in mcf.cum_gas_12_maxnumberOptionalOnly wells whose
cum_gas_12is at most this, in mcf.cum_boe_12_minnumberOptionalOnly wells whose
cum_boe_12is at least this, in BOE.cum_boe_12_maxnumberOptionalOnly wells whose
cum_boe_12is at most this, in BOE.cum_oil_life_minnumberOptionalOnly wells whose
cum_oil_lifeis at least this, in bbl.cum_oil_life_maxnumberOptionalOnly wells whose
cum_oil_lifeis at most this, in bbl.cum_gas_life_minnumberOptionalOnly wells whose
cum_gas_lifeis at least this, in mcf.cum_gas_life_maxnumberOptionalOnly wells whose
cum_gas_lifeis at most this, in mcf.cum_boe_life_minnumberOptionalOnly wells whose
cum_boe_lifeis at least this, in BOE.cum_boe_life_maxnumberOptionalOnly wells whose
cum_boe_lifeis at most this, in BOE.total_proppant_minnumberOptionalOnly wells whose
total_proppantis at least this, in lb.total_proppant_maxnumberOptionalOnly wells whose
total_proppantis at most this, in lb.total_fluid_minnumberOptionalOnly wells whose
total_fluidis at least this, in bbl.total_fluid_maxnumberOptionalOnly wells whose
total_fluidis at most this, in bbl.stage_count_minnumberOptionalOnly wells whose
stage_countis at least this, in stages.stage_count_maxnumberOptionalOnly wells whose
stage_countis at most this, in stages.first_year_minnumberOptionalOnly wells whose
first_yearis at least this, in years.first_year_maxnumberOptionalOnly wells whose
first_yearis at most this, in years.fluid_bbl_per_ft_minnumberOptionalOnly wells whose
fluid_bbl_per_ftis at least this, in bbl/ft.fluid_bbl_per_ft_maxnumberOptionalOnly wells whose
fluid_bbl_per_ftis at most this, in bbl/ft.proppant_lb_per_ft_minnumberOptionalOnly wells whose
proppant_lb_per_ftis at least this, in lb/ft.proppant_lb_per_ft_maxnumberOptionalOnly wells whose
proppant_lb_per_ftis at most this, in lb/ft.cum_boe_12_per_1000_ft_minnumberOptionalOnly wells whose
cum_boe_12_per_1000_ftis at least this, in BOE per 1,000 ft of lateral.cum_boe_12_per_1000_ft_maxnumberOptionalOnly wells whose
cum_boe_12_per_1000_ftis at most this, in BOE per 1,000 ft of lateral.cum_oil_12_per_1000_ft_minnumberOptionalOnly wells whose
cum_oil_12_per_1000_ftis at least this, in bbl per 1,000 ft of lateral.cum_oil_12_per_1000_ft_maxnumberOptionalOnly wells whose
cum_oil_12_per_1000_ftis at most this, in bbl per 1,000 ft of lateral.cum_gas_12_per_1000_ft_minnumberOptionalOnly wells whose
cum_gas_12_per_1000_ftis at least this, in mcf per 1,000 ft of lateral.cum_gas_12_per_1000_ft_maxnumberOptionalOnly wells whose
cum_gas_12_per_1000_ftis at most this, in mcf per 1,000 ft of lateral.first_prod_minstringOptionalFormat
dateOnly wells whose
first_prodis on or after this day, YYYY-MM-DD.first_prod_maxstringOptionalFormat
dateOnly wells whose
first_prodis on or before this day, YYYY-MM-DD.last_prod_minstringOptionalFormat
dateOnly wells whose
last_prodis on or after this day, YYYY-MM-DD.last_prod_maxstringOptionalFormat
dateOnly wells whose
last_prodis on or before this day, YYYY-MM-DD.frac_date_minstringOptionalFormat
dateOnly wells whose
frac_dateis on or after this day, YYYY-MM-DD.frac_date_maxstringOptionalFormat
dateOnly wells whose
frac_dateis on or before this day, YYYY-MM-DD.til_date_minstringOptionalFormat
dateOnly wells whose
til_dateis on or after this day, YYYY-MM-DD.til_date_maxstringOptionalFormat
dateOnly wells whose
til_dateis on or before this day, YYYY-MM-DD.keysstringOptionalOnly these wells: wellbore keys, exact, comma-separated, such as
SB329-01414,SB329-01415: a known list, such as a forecast's analogs, in one call.A repeated
keysadds its list, and a repeat counts once. At most 50 keys (400 namingkeyspast it, withdetails.maxanddetails.count). An emptykeys=means every well; a value with no key, such as,, is a 400. A key the dataset lacks matches nothing, so read the response for which wells came back.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
Matching wells.
formatstringRequiredAlways
"columns"Layout.
countintegerRequiredWells.
columnsobjectRequiredParallel arrays, one entry per well. With
fields, only the asked properties are present.ShowHide 41 child fields
wellbore_keyarray of stringsRequiredWellbore keys.
well_namearray of stringsOptionalWell names.
operatorarray of stringsOptionalCurrent operators.
formationarray of stringsOptionalFormations.
mid_lonarray of numbersOptionalLateral midpoint longitude.
mid_latarray of numbersOptionalLateral midpoint latitude.
shl_lonarray of numbersOptionalSurface hole longitude.
shl_latarray of numbersOptionalSurface hole latitude.
heel_lonarray of numbersOptionalHeel longitude (null when not reported).
heel_latarray of numbersOptionalHeel latitude.
bhl_lonarray of numbersOptionalBottom hole longitude.
bhl_latarray of numbersOptionalBottom hole latitude.
Show all 41 fields
cum_boe_12array of numbersOptionalFirst 12 months of production, BOE (gas at 6 mcf per bbl).
first_yeararray of integersOptionalYear of first production.
distance_miarray of numbersOptionalWith near only: great-circle miles from near to the lateral midpoint, rounded to 0.01; the wells come nearest first.
area_distance_ftarray of integersOptionalItems ≥ 0
POST /wells/search only: 0 inside the area or on its edge, else feet from it, rounded and at least 1.
basinarray of stringsOptionalBasin. Only when named in fields.
subbasinarray of stringsOptionalSub-basin. Only when named in fields.
statearray of stringsOptionalState. Only when named in fields.
countyarray of stringsOptionalCounty. Only when named in fields.
lateral_lengtharray of numbersOptionalLateral length, ft. Only when named in fields.
tvd_tdarray of numbersOptionalTVD, ft. Only when named in fields.
latarray of numbersOptionalThe header's latitude, the midpoint of the surface and bottom holes, to 5 decimals; the map uses mid_lat. Only when named in fields.
lonarray of numbersOptionalThe header's longitude, the midpoint of the surface and bottom holes, to 5 decimals; the map uses mid_lon. Only when named in fields.
first_prodarray of stringsOptionalFirst production, YYYY-MM-DD. Only when named in fields.
last_prodarray of stringsOptionalLast production, YYYY-MM-DD. Only when named in fields.
cum_oil_12array of numbersOptionalFirst 12 months oil, whole bbl. Only when named in fields.
cum_gas_12array of numbersOptionalFirst 12 months gas, whole mcf. Only when named in fields.
cum_oil_lifearray of numbersOptionalCumulative oil, whole bbl. Only when named in fields.
cum_gas_lifearray of numbersOptionalCumulative gas, whole mcf. Only when named in fields.
cum_boe_lifearray of numbersOptionalCumulative BOE, whole. Only when named in fields.
total_proppantarray of integersOptionalProppant, lb. Only when named in fields.
total_fluidarray of integersOptionalFluid, bbl. Only when named in fields.
stage_countarray of integersOptionalFrac stages. Only when named in fields.
frac_datearray of stringsOptionalFrac date, YYYY-MM-DD. Only when named in fields.
til_datearray of stringsOptionalTurn-in-line date, YYYY-MM-DD. Only when named in fields.
fluid_bbl_per_ftarray of numbersOptionalCompletion fluid per lateral ft, bbl/ft to 0.1: the header's novi_calc_fluid_per_length, the per-well value GET /completions/defaults and POST /units/summary take medians of. Only when named in fields.
proppant_lb_per_ftarray of numbersOptionalProppant per lateral ft, lb/ft to 0.1: the header's novi_calc_proppant_per_length, as fluid_bbl_per_ft. Only when named in fields.
cum_boe_12_per_1000_ftarray of numbersOptionalFirst 12 months of BOE per 1,000 ft of lateral (cum_boe_12 / lateral_length × 1,000, as POST /units/summary computes it), whole BOE. Only when named in fields.
cum_oil_12_per_1000_ftarray of numbersOptionalFirst 12 months of oil per 1,000 ft of lateral (cum_oil_12 / lateral_length × 1,000), whole bbl; null without a 12-month oil volume or a lateral. As cum_boe_12_per_1000_ft, for the oil or gas basis of a per-lateral comparison. Only when named in fields.
cum_gas_12_per_1000_ftarray of numbersOptionalFirst 12 months of gas per 1,000 ft of lateral (cum_gas_12 / lateral_length × 1,000), whole mcf; null without a 12-month gas volume or a lateral. As cum_boe_12_per_1000_ft, for the oil or gas basis of a per-lateral comparison. Only when named in fields.
next_cursorstring or nullOptionalWith limit or cursor: cursor for the next page, null on the last; count is still every matching well.
appliedobjectOptionalHow the server read
sort,order,county,operators, the_minand_maxranges and, when format=columns is paged,limitandcursor, as {"lateral_length_min": 9000, "sort": "cum_boe_12", "order": "desc"}. Absent when none of them was sent.ShowHide 2 variants in each value
Any of
number, string or boolean number, string or boolean or null
array of strings array of strings
304 Unchanged since the ETag in If-None-Match.Errors
Shared errors400401403500503What they mean