Skip to content
Developers
Get an API token

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

GET/wells/{key}/spacing

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. 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).

Send a Novi API token as a bearer token on every request. Authentication

Parameters

Path parameters

  • keystringRequired

    Wellbore 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_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches 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 once default is 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's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; naming resources of two sets in one request is a 400.

Responses

200 OK

Spacing node and neighbors.

  • wellbore_keystringRequired

    Wellbore key.

  • nodeobject or nullRequired

    The well's spacing node, or null.

    ShowHide 7 child fields
    • wellbore_keystringRequired

      Wellbore key.

    • azimuthnumber or nullRequired

      Lateral azimuth, degrees.

    • heel_is_virtualboolean or nullRequired

      Heel estimated from the pad.

    • heel_lonnumber or nullRequired

      Heel longitude.

    • heel_latnumber or nullRequired

      Heel latitude.

    • pad_idinteger or nullRequired

      Pad id.

    • pad_wellsintegerRequired

      Wells on the pad.

  • neighborsarray of objectsRequired

    Neighbors, closest (mintangent) first.

    ShowHide 19 child fields in each item
    • neighborstringRequired

      Neighbor wellbore key, or DRAWN-<index> for another drawn well.

    • positionstringRequired

      lateral, stack or stagger.

    • well_namestring or nullOptional

      Neighbor name.

    • operatorstring or nullOptional

      Neighbor operator.

    • formationstring or nullOptional

      Neighbor formation.

    • first_prodstring or nullOptional

      Format date

      Neighbor first production.

    • heel_lonnumber or nullOptional

      Neighbor heel longitude.

    • heel_latnumber or nullOptional

      Neighbor heel latitude.

    • bhl_lonnumber or nullOptional

      Neighbor bottom hole longitude.

    • bhl_latnumber or nullOptional

      Neighbor bottom hole latitude.

    • conestring or nullOptional

      Cone, as leftstaggerbelow.

    • categorystring or nullOptional

      parent or nonparent.

    Show all 19 fields
    • signedxynumber or nullOptional

      Horizontal offset, ft (+ right looking heel to toe).

    • signedtvdnumber or nullOptional

      Vertical offset, ft (+ deeper).

    • minxynumber or nullOptional

      Minimum horizontal distance, ft.

    • mintvdnumber or nullOptional

      Minimum vertical distance, ft.

    • mintangentnumber or nullOptional

      Minimum 3D distance, ft.

    • overlapnumber or nullOptional

      Fraction of the lateral the neighbor overlaps.

    • edge_datestring or nullOptional

      Format date

      Date the edge applies from.

Conditional requests 304 Unchanged since the ETag in If-None-Match.

Errors

StatusWhen
404

No such well, grid, plan or route.

Shared errors400401403500503What they mean