Get a well's spacing neighbors
The well's spacing: its node (azimuth, heel, pad) and each neighbor with position (lateral, stack, stagger), cone, parent or nonparent, signed and minimum offsets in ft, overlap and the neighbor's location.
Get a well's spacing neighbors
/wells/{key}/spacingThe well's spacing: its node (azimuth, heel, pad) and each neighbor with position (lateral, stack, stagger), cone, parent or nonparent, signed and minimum offsets in ft, overlap and the neighbor's location. Offsets are from this well: xy + is right of it looking heel to toe, TVD + is deeper. node is null for wells spacing couldn't place (no location, TVD or date).
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
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
Spacing node and neighbors.
wellbore_keystringRequiredWellbore key.
nodeobject or nullRequiredThe well's spacing node, or null.
ShowHide 7 child fields
wellbore_keystringRequiredWellbore key.
azimuthnumber or nullRequiredLateral azimuth, degrees.
heel_is_virtualboolean or nullRequiredHeel estimated from the pad.
heel_lonnumber or nullRequiredHeel longitude.
heel_latnumber or nullRequiredHeel latitude.
pad_idinteger or nullRequiredPad id.
pad_wellsintegerRequiredWells on the pad.
neighborsarray of objectsRequiredNeighbors, closest (mintangent) first.
ShowHide 19 child fields in each item
neighborstringRequiredNeighbor wellbore key, or DRAWN-<index> for another drawn well.
positionstringRequiredlateral, stack or stagger.
well_namestring or nullOptionalNeighbor name.
operatorstring or nullOptionalNeighbor operator.
formationstring or nullOptionalNeighbor formation.
first_prodstring or nullOptionalFormat
dateNeighbor first production.
heel_lonnumber or nullOptionalNeighbor heel longitude.
heel_latnumber or nullOptionalNeighbor heel latitude.
bhl_lonnumber or nullOptionalNeighbor bottom hole longitude.
bhl_latnumber or nullOptionalNeighbor bottom hole latitude.
conestring or nullOptionalCone, as leftstaggerbelow.
categorystring or nullOptionalparent or nonparent.
Show all 19 fields
signedxynumber or nullOptionalHorizontal offset, ft (+ right looking heel to toe).
signedtvdnumber or nullOptionalVertical offset, ft (+ deeper).
minxynumber or nullOptionalMinimum horizontal distance, ft.
mintvdnumber or nullOptionalMinimum vertical distance, ft.
mintangentnumber or nullOptionalMinimum 3D distance, ft.
overlapnumber or nullOptionalFraction of the lateral the neighbor overlaps.
edge_datestring or nullOptionalFormat
dateDate the edge applies from.
304 Unchanged since the ETag in If-None-Match.Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
Shared errors400401403500503What they mean