Tachyus Production Data API

Daily/monthly production records for a well.

OpenAPI Specification

tachyus-production-data-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Tachapps Production Data API
  version: v1
  description: REST API for the Tachyus Tachapps platform (Strateon, Aqueon, Aurion) — reservoir management, production analytics, and forecasting. The API is organized around Projects, Wells, and Production Data. All requests use HTTPS and JSON. Authentication is a Bearer API token issued from the Tachapps UI (Settings -> API Tokens). Breaking changes are introduced only in new major versions with advance notice.
  contact:
    name: Tachyus
    email: info@tachyus.com
    url: https://docs.tachyus.com/
servers:
- url: https://{organization}.tachyus.com/api/v1
  description: Per-organization production host
  variables:
    organization:
      default: your-organization
      description: Your Tachapps organization subdomain
security:
- bearerAuth: []
tags:
- name: Production Data
  description: Daily/monthly production records for a well.
paths:
  /projects/{projectId}/wells/{wellId}/production:
    parameters:
    - name: projectId
      in: path
      required: true
      schema:
        type: string
    - name: wellId
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getProductionData
      tags:
      - Production Data
      summary: Get production data for a well
      parameters:
      - name: from
        in: query
        required: true
        description: Start date (inclusive)
        schema:
          type: string
          format: date
      - name: to
        in: query
        required: true
        description: End date (inclusive)
        schema:
          type: string
          format: date
      - name: fields
        in: query
        description: Comma-separated list of fields to return
        schema:
          type: string
      - name: aggregation
        in: query
        description: Daily (default) or monthly aggregation
        schema:
          type: string
          enum:
          - daily
          - monthly
          default: daily
      responses:
        '200':
          description: Production data series
          content:
            application/json:
              schema:
                type: object
                properties:
                  wellId:
                    type: string
                  from:
                    type: string
                    format: date
                  to:
                    type: string
                    format: date
                  aggregation:
                    type: string
                  fields:
                    type: array
                    items:
                      type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProductionRecord'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    post:
      operationId: ingestProductionData
      tags:
      - Production Data
      summary: Ingest production records
      description: Existing records for the same date are upserted (replaced). For historical imports exceeding thousands of records, CSV import or bulk data migration is recommended.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - records
              properties:
                records:
                  type: array
                  items:
                    $ref: '#/components/schemas/ProductionRecord'
      responses:
        '200':
          description: Ingest result
          content:
            application/json:
              schema:
                type: object
                properties:
                  inserted:
                    type: integer
                  updated:
                    type: integer
                  total:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
    delete:
      operationId: deleteProductionData
      tags:
      - Production Data
      summary: Delete production records by date range
      parameters:
      - name: from
        in: query
        required: true
        description: Start of range to delete (inclusive)
        schema:
          type: string
          format: date
      - name: to
        in: query
        required: true
        description: End of range to delete (inclusive)
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Delete result
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleted:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    Forbidden:
      description: Token lacks required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Token missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit exceeded
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    ProductionRecord:
      type: object
      properties:
        date:
          type: string
          format: date
        oil_rate:
          type: number
        water_rate:
          type: number
        gas_rate:
          type: number
        bhp:
          type: number
        thp:
          type: number
        choke_size:
          type: number
        runtime:
          type: number
        gor:
          type: number
        watercut:
          type: number
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API token issued from the Tachapps UI (Settings -> API Tokens), sent as `Authorization: Bearer tach_live_...`. Tokens carry scopes (read:projects, read:wells, read:production, write:projects, write:wells, admin).'
x-apievangelist:
  generated: '2026-07-21'
  method: generated
  source: Faithfully transcribed from the published Tachapps API reference at https://docs.tachyus.com/api/ (introduction, authentication, projects, wells, production-data). No fields invented; only documented operations, parameters, and response fields are represented.