Enverus

Methods (15)

• getBasins

  read

  List oil and gas basin names used as catalog filters.

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• getWellsForRig

  read

  Wells tied to one named drilling rig. Needs rigName; not a general well search.

  Entitiesrig, well
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• listDatasets

  read

  List available oil and gas datasets in the data catalog.

  Entitiesdataset
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• getRegions

  read

  List geographic region names used as catalog filters.

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }

• getStateProvinces

  read

  List US state and Canadian province codes used as filters.

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }

• getWellHeaders

  read

  List well header records from the oil and gas catalog.

  Entitieswell
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• getAccessToken

  read

  Retrieve an API access token for authenticated data requests.

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• getTokenInfo

  read

  Return metadata and expiry for the current API access token.

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• count

  read

  Return a matching record count for a selected dataset.

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• docs

  unknown

  Return field documentation for a selected dataset table.

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• ddl

  unknown

  Return SQL schema definitions for a selected dataset table.

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• getWells

  read

  Search Enverus wells by operator, basin, state, API/UWI, or well id.

  Entitieswell
  Input schema

  {
    "type": "object",
    "properties": {
      "WellID": {
        "type": "string",
        "description": "Source-native Enverus well identifier."
      },
      "API_UWI_Unformatted": {
        "type": "string",
        "description": "Exact unformatted API/UWI filter."
      },
      "ENVBasin": {
        "type": "string",
        "description": "Enverus basin filter."
      },
      "StateProvince": {
        "type": "string",
        "description": "State or province filter."
      },
      "Operator": {
        "type": "string",
        "description": "Operator filter."
      },
      "pagesize": {
        "type": "number",
        "description": "Requested rows per upstream page."
      },
      "paging": {
        "type": "boolean",
        "description": "Follow Enverus Link-header continuation internally."
      },
      "maxPages": {
        "type": "number",
        "description": "Maximum Link-header pages to follow (1-25)."
      },
      "maxRecords": {
        "type": "number",
        "description": "Maximum rows across followed pages (1-5000)."
      },
      "select": {
        "type": "string",
        "description": "Select profile such as all."
      },
      "verbose": {
        "type": "boolean",
        "description": "Include verbose metadata."
      }
    },
    "additionalProperties": true
  }

  Paging follows Enverus Link headers; upstream has no numeric offsets.

• getProduction

  read

  Query production rows by operator, basin, or geography (Enverus).

  Entitiesproduction
  Input schema

  {
    "type": "object",
    "properties": {
      "WellID": {
        "type": "string",
        "description": "Well ID resolved through /wells before /production is queried."
      },
      "API_UWI_Unformatted": {
        "type": "string",
        "description": "Exact unformatted API/UWI production filter."
      },
      "ProducingOperator": {
        "type": "string",
        "description": "Producing operator filter."
      },
      "ENVBasin": {
        "type": "string",
        "description": "Enverus basin filter."
      },
      "StateProvince": {
        "type": "string",
        "description": "State or province filter."
      },
      "pagesize": {
        "type": "number",
        "description": "Maximum rows to return."
      },
      "maxPages": {
        "type": "number",
        "description": "Maximum Link-header pages to follow (1-25)."
      },
      "maxRecords": {
        "type": "number",
        "description": "Maximum rows across followed pages (1-5000)."
      },
      "select": {
        "type": "string",
        "description": "Select profile such as all."
      },
      "verbose": {
        "type": "boolean",
        "description": "Include verbose metadata."
      }
    },
    "additionalProperties": true
  }

• getRigs

  read

  Search Enverus rig records by operator, location, status, or rig name.

  Entitiesrig, operator, well
  Input schema

  {
    "type": "object",
    "properties": {
      "view": {
        "type": "string",
        "enum": [
          "search",
          "activity"
        ],
        "description": "Search supports full filters; activity returns the activity feed."
      },
      "operator": {
        "type": "string",
        "description": "Operator name; normalized to ENVOperator."
      },
      "ENVOperator": {
        "type": "string",
        "description": "Enverus operator filter."
      },
      "ENVBasin": {
        "type": "string",
        "description": "Enverus basin or region name."
      },
      "ENVRegion": {
        "type": "string",
        "description": "Enverus region filter."
      },
      "StateProvince": {
        "type": "string",
        "description": "State or province name/code."
      },
      "County": {
        "type": "string",
        "description": "County filter."
      },
      "ActiveStatus": {
        "type": "string",
        "description": "Optional client-side active-status filter."
      },
      "RigName_Number": {
        "type": "string",
        "description": "Rig name or number."
      },
      "ENVRigID": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "number"
          }
        ],
        "description": "Source-native Enverus rig identifier."
      },
      "pagesize": {
        "type": "number",
        "description": "Maximum rows to return."
      },
      "select": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ],
        "description": "Projection; minimal retains map coordinates."
      },
      "verbose": {
        "type": "boolean",
        "description": "Include verbose metadata."
      }
    },
    "additionalProperties": true
  }

• query

  read

  Generic dataset query for Enverus datasets.

  Required paramsdataset

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "dataset": {
        "type": "string",
        "description": "Dataset slug, e.g. wells, rigs, or production."
      },
      "params": {
        "type": "object",
        "description": "Dataset-specific query parameters."
      }
    },
    "additionalProperties": true,
    "required": [
      "dataset"
    ]
  }