Sign up
All data sources

WellOps

API keywellops

WellOps (Mi4) oil & gas production data connector. Provides access to company, field, well, and daily production data from WellOps. CRITICAL USAGE RULES: 1. Use getCompanies() first to discover company IDs before other operations. 2. All endpoints except getCompanies() require a companyId parameter. 3. getWells() can be filtered by fieldId and date. 4. getWellDailyProduction() supports date range filtering with startDate/endDate. 5. Use getWellStatusOptions() to get valid well status values for interpreting well data. IMPORTANT FOR PRODUCTION DATA: - Always provide wellId OR fieldId to avoid timeouts - Company-wide queries (no wellId/fieldId) will timeout - Use startDate/endDate to limit results: 'YYYY-MM-DD' format API Version: 1 (current) Authentication: X-Api-Key header

oil-and-gas
Get this contract as JSONConnect this source →

Provenance

PublisherWellOps
API basehttps://api.wellops.com/

Freshness & coverage

FreshnessFreshness not declared
GeographicNot declared
TemporalNot declared
AuthenticationCredentials required (API key)

Methods (5)

  • getCompanies

    read

    Get all companies accessible to the authenticated user. Use this first to discover company IDs.

    Entitiescompany
    Input schema
    {
  "type": "object",
  "properties": {
    "version": {
      "type": "number"
    }
  },
  "additionalProperties": false
}

  • getFields

    read

    Get all fields within a specified company.

    Required paramscompanyId
    Entitiesfield
    Input schema
    {
  "type": "object",
  "properties": {
    "companyId": {
      "type": "number",
      "examples": [
        339
      ]
    },
    "page": {
      "type": "number"
    },
    "version": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "companyId"
  ]
}

  • getWells

    read

    Get wells from a company with optional filtering by field and date.

    Required paramscompanyId
    Entitieswell
    Input schema
    {
  "type": "object",
  "properties": {
    "companyId": {
      "type": "number",
      "examples": [
        339
      ]
    },
    "fieldId": {
      "type": "number",
      "examples": [
        123
      ]
    },
    "date": {
      "type": "string"
    },
    "page": {
      "type": "number"
    },
    "version": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "companyId"
  ]
}

    Optional filters: fieldId, date (YYYY-MM-DD), page

  • getWellStatusOptions

    read

    Get valid well status options for a company (Active, Shut-In, P&A, etc.).

    Required paramscompanyId
    Entitieswell
    Input schema
    {
  "type": "object",
  "properties": {
    "companyId": {
      "type": "number",
      "examples": [
        339
      ]
    },
    "page": {
      "type": "number"
    },
    "version": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "companyId"
  ]
}

  • getWellDailyProduction

    read

    Get daily production data for wells. IMPORTANT: Always provide wellId OR fieldId to avoid timeouts.

    Required paramscompanyId
    Entitiesproduction, well
    Input schema
    {
  "type": "object",
  "properties": {
    "companyId": {
      "type": "number",
      "examples": [
        339
      ]
    },
    "fieldId": {
      "type": "number",
      "examples": [
        123
      ]
    },
    "wellId": {
      "type": "number"
    },
    "startDate": {
      "type": "string",
      "examples": [
        "2024-01-01"
      ]
    },
    "endDate": {
      "type": "string",
      "examples": [
        "2024-12-31"
      ]
    },
    "page": {
      "type": "number"
    },
    "version": {
      "type": "number"
    }
  },
  "additionalProperties": false,
  "required": [
    "companyId"
  ]
}

    MUST provide wellId OR fieldId. Optional: startDate, endDate (YYYY-MM-DD), page.