Skip to main content
GET
/
wells
List Wells
curl --request GET \
  --url https://v1.api.flux-os.com/wells \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": [
    {
      "uwi": "<string>",
      "location_exception": "<string>",
      "event_sequence": "<string>",
      "lsd": 123,
      "section": 123,
      "township": 123,
      "range": 123,
      "meridian": "<string>",
      "licensee": "<unknown>",
      "regulator_id": "<string>",
      "id": "<string>",
      "name": null,
      "latitude": null,
      "longitude": null,
      "jurisdiction": "ALBERTA",
      "license_status": "ABANDONED",
      "license_type": "WELL",
      "license_number": null,
      "license_issued": null,
      "regulator_system": "PETRINEX"
    }
  ],
  "meta": {
    "current_page": 123,
    "total_pages": 123,
    "total_items": 123,
    "per_page": 123
  }
}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
jurisdiction
enum<string>

Jurisdiction

Available options:
ALBERTA,
SASKATCHEWAN
license_issued
string<date>

License issue date

regulator_id
string

Regulator ID

section
integer

Section

event_sequence
string

Event sequence number

location_exception
string

Location exception

lsd
integer

Legal subdivision

meridian
string

Meridian

name
string

Well name

range
integer

Range

township
integer

Township

uwi
string

Unique Well Identifier

license_status
string

License status

Response

A list of wells.

data
object[]
meta
object