Skip to content
Developers
Get an API token

Get a grid's points

A grid's lattice points as parallel lng, lat and val arrays, its value range (with 2nd and 98th percentiles for color ramps) and, when the points sit on a regular lng/lat lattice, its origin, steps and size.

Get a grid's points

GET/subsurface/grids/{feature_name}

A grid's lattice points as parallel lng, lat and val arrays, its value range (with 2nd and 98th percentiles for color ramps) and, when the points sit on a regular lng/lat lattice, its origin, steps and size. Points outside the formation's footprint are left out, so rebuild the lattice from lattice and treat missing points as no data.

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

Parameters

Path parameters

  • feature_namestringRequired

    Grid name from GET /subsurface, as novi_structuraldepth_wolfcamp_a.

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

Grid points.

  • feature_namestringRequired

    Grid name.

  • formationstringRequired

    Formation.

  • rock_propertystringRequired

    Property.

  • unitstring or nullRequired

    ft or fraction.

  • countintegerRequired

    Points.

  • rangeobjectRequired

    Value range.

    ShowHide 4 child fields
    • minnumber or nullRequired

      Minimum.

    • p02number or nullRequired

      2nd percentile.

    • p98number or nullRequired

      98th percentile.

    • maxnumber or nullRequired

      Maximum.

  • latticeobject or nullRequired

    The regular lattice under the points, or null.

    ShowHide 6 child fields
    • lng0numberRequired

      Westmost column longitude.

    • lat0numberRequired

      Southmost row latitude.

    • step_lngnumberRequired

      Column step, degrees.

    • step_latnumberRequired

      Row step, degrees.

    • nxintegerRequired

      Columns.

    • nyintegerRequired

      Rows.

  • lngarray of numbersRequired

    Point longitudes.

  • latarray of numbersRequired

    Point latitudes.

  • valarray of numbersRequired

    Point values.

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