Get Multiple Wells

GET

https://data.onxecta.com/api/production/wells

This operation offers an optional paging facility if desired.

Query Parameters

offsetinteger<int32>
Format
int32
limitinteger<int32>
Format
int32

Responses

200OK

Well[]
- xidstring<uuid>required
  Format
  uuid
- sourceIdstringrequired
- uwistringrequired
- namestringrequired
- group1string
  Description
  Group 1 - used for primary group navigation in the application
- group2string
  Description
  Warning: Deprecated
  Group 2 - used for secondary sorting in the well tree and grouping in the application NOTE: This field has been deprecated and will be removed in January 2026. Please use area, centralFacility, tankBattery, route, pad, platform to organize the well.
- group3string
  Description
  Warning: Deprecated
  Group 3 - used for secondary sorting in the well tree and grouping in the application NOTE: This field has been deprecated and will be removed in January 2026. Please use area, centralFacility, tankBattery, route, pad, platform to organize the well.
- areastring
  Description
  Sub-area of a field/asset defined by group1
- centralFacilitystring
  Description
  Central facility into which the well flows
- tankBatterystring
  Description
  Tank battery into which the well flows
- routestring
  Description
  Route on which the well is located
- padstring
  Description
  Pad (if applicable) on which the well is located
- platformstring
  Description
  Platform (if applicable) to which the well flows
- heritagestring
  Description
  Heritage of the well
- responsibleEngineerstring
  Description
  Engineer responsible for the well
- typeWellType
  Description
  Well type: PRODUCER, INJECTOR
  Default
  PRODUCER
- fluidFluidType
  Default
  OIL
- liftTypeLiftType
  Description
  Current lift type of the well: NATURAL_FLOW, GAS_LIFT, ROD_PUMP, ESP, PLUNGER_LIFT, PLUNGER_ASSISTED_GAS_LIFT, GAS_ASSISTED_PLUNGER_LIFT, ANNULAR_NATURAL_FLOW, ANNULAR_GAS_LIFT, PCP, DUAL_NATURAL_FLOW
  Default
  NATURAL_FLOW
- latnumber<double>required
  Format
  double
- lonnumber<double>required
  Format
  double
- mudLinenumber<double>
  Format
  double
- middleLatnumber<double>
  Description
  Optional middle coordinate (for maps). Frequently the lateral heel coordinates.
  Format
  double
- middleLonnumber<double>
  Description
  Optional middle coordinate (for maps). Frequently the lateral heel coordinates.
  Format
  double
- statusWellStatus
- timezonestring
- bottomholeLatnumber<double>
  Format
  double
- bottomholeLonnumber<double>
  Format
  double

curl

curl --request GET \
     --url https://data.onxecta.com/api/production/wells \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://data.onxecta.com/api/production/wells", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://data.onxecta.com/api/production/wells"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

csharp

var options = new RestClientOptions("https://data.onxecta.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/api/production/wells", Method.Get);
request.AddHeader("accept", "application/json");
request.AddHeader("content-type", "application/json");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://data.onxecta.com/api/production/wells")
   .method("GET", body)
   .addHeader("accept", "application/json")
   .addHeader("content-type", "application/json")
   .build();
Response response = client.newCall(request).execute();

200

// OK
[
  {
    "xid": "",
    "sourceId": "",
    "uwi": "",
    "name": "",
    "group1": "",
    "group2": "",
    "group3": "",
    "area": "",
    "centralFacility": "",
    "tankBattery": "",
    "route": "",
    "pad": "",
    "platform": "",
    "heritage": "",
    "responsibleEngineer": "",
    "type": "",
    "fluid": "",
    "liftType": "",
    "lat": "",
    "lon": "",
    "mudLine": "",
    "middleLat": "",
    "middleLon": "",
    "status": "",
    "timezone": "",
    "bottomholeLat": "",
    "bottomholeLon": ""
  }
]