SynMax (Leviaton) API

openapi: 3.1.0
info:
  title: SynMax (Leviaton) API
  version: '2026-11-09'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-09: 10 operation(s) read from 10 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; SynMax (Leviaton) has published no machine-readable
    contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 5
    pages-with-code: 5
    pages-read: 10
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-09'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://apidocs.synmax.com/v3/rigs.html
  - https://apidocs.synmax.com/v3/tils.html
  - https://apidocs.synmax.com/v4/rigs.html
  - https://apidocs.synmax.com/v4/tils.html
  - https://apidocs.synmax.com/v3/wells.html
  - https://apidocs.synmax.com/v4/wells.html
  - https://apidocs.synmax.com/v3/regions.html
  - https://apidocs.synmax.com/v4/regions.html
  - https://apidocs.synmax.com/v4/glossary.html
  - https://apidocs.synmax.com/v3/fraccrews.html
servers:
- url: https://hyperion.api.synmax.com
paths:
  /v3/fraccrews:
    post:
      operationId: post_v3_fraccrews
      tags:
      - Fraccrews
      summary: This endpoint provides users with frac crew location specific to a wellpad and its operating dates.
      description: Returns frac crew locations by wellpad and date. Object returned is a pandas DataFrame.
      x-source: https://apidocs.synmax.com/v3/fraccrews.html
      parameters:
      - name: aggregate_by
        in: query
        required: false
        schema:
          type: array
        description: Aggregate data by a list of parameters.
      - name: county
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of counties.
      - name: end_date
        in: query
        required: false
        schema:
          type: string
        description: Limit search to an end date. Date formatting - [“YYYY-MM-DD”]
      - name: frac_class
        in: query
        required: false
        schema:
          type: string
        description: Limit search to either oil or gas wells based on the GOR definition from the EIA.
      - name: operator
        in: query
        required: false
        schema:
          type: array
        description: Limit search to a list of well operators.
      - name: region
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of regions (clusters of multiple major producing basins).
      - name: service_company
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of companies contracted by the operator to perform the frac job.
      - name: start_date
        in: query
        required: false
        schema:
          type: string
        description: Limit search to a start date. Date formatting - [“YYYY-MM-DD”]
      - name: state_code
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of state codes.
      - name: sub_region
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of subregions (clusters of several counties forming a major producing basin).
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV3FraccrewsResponse'
      x-evidence:
        kind: documentation
  /v3/regions:
    get:
      operationId: get_v3_regions
      tags:
      - Regions
      summary: This endpoint returns data on regions.
      description: Returns data county, subregion, region, and state. This function takes no parameters. Object returned is a pandas DataFrame.
      x-source: https://apidocs.synmax.com/v3/regions.html
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV3RegionsResponse'
      x-evidence:
        kind: documentation
  /v3/rigs:
    post:
      operationId: post_v3_rigs
      tags:
      - Rigs
      summary: This endpoint provides users with rig location specific to a wellpad and its operating dates.
      description: Returns rig locations by wellpad and date. Object returned is a pandas DataFrame.
      x-source: https://apidocs.synmax.com/v3/rigs.html
      parameters:
      - name: aggregate_by
        in: query
        required: false
        schema:
          type: array
        description: Aggregate data by a list of parameters.
      - name: county
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of counties.
      - name: end_date
        in: query
        required: false
        schema:
          type: string
        description: Limit search to an end date. Date formatting - [“YYYY-MM-DD”]
      - name: operator
        in: query
        required: false
        schema:
          type: array
        description: Limit search to a list of well operators.
      - name: region
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of regions (clusters of multiple major producing basins).
      - name: rig_class
        in: query
        required: false
        schema:
          type: string
        description: Limit search to either oil or gas wells based on the GOR definition from the EIA.
      - name: start_date
        in: query
        required: false
        schema:
          type: string
        description: Limit search to a start date. Date formatting - [“YYYY-MM-DD”]
      - name: state_code
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of state codes.
      - name: sub_region
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of subregions (clusters of several counties forming a major producing basin).
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV3RigsResponse'
      x-evidence:
        kind: documentation
  /v3/tils:
    get:
      operationId: get_v3_tils
      tags:
      - Tils
      summary: This endpoint returns status of wellpads which are being monitored for Turn-In-Line (TIL) events.
      description: Returns number of DTIL wells on a wellpad, the operator name, frac job date and the til_date. This function takes no parameters.
        Object returned is a pandas DataFrame.
      x-source: https://apidocs.synmax.com/v3/tils.html
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV3TilsResponse'
      x-evidence:
        kind: documentation
  /v3/wells:
    post:
      operationId: post_v3_wells
      tags:
      - Wells
      summary: Returns well-level data derived from all available sources organized by date.
      description: This endpoint returns well-level data.
      x-source: https://apidocs.synmax.com/v3/wells.html
      parameters:
      - name: aggregate_by
        in: query
        required: false
        schema:
          type: array
        description: Aggregate data by a list of parameters.
      - name: apistring
        in: query
        required: false
        schema:
          type: boolean
        description: Boolean to decide whether the API should be returned as a string or integer.
      - name: county
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of counties.
      - name: depth_max
        in: query
        required: false
        schema:
          type: integer
        description: Returns the maximum recorded depth of a well.
      - name: depth_min
        in: query
        required: false
        schema:
          type: integer
        description: Returns the minimum recorded depth of a well.
      - name: operator
        in: query
        required: false
        schema:
          type: array
        description: Limit search to a list of well operators.
      - name: end_date
        in: query
        required: false
        schema:
          type: string
        description: Limit search to an end date. Date formatting - [“YYYY-MM-DD”].
      - name: horizontal_length_max
        in: query
        required: false
        schema:
          type: number
        description: Maximum horizontal drilling length of a well.
      - name: horizontal_length_min
        in: query
        required: false
        schema:
          type: number
        description: Minimum horizontal drilling length of a well.
      - name: region
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of regions (clusters of multiple major producing basins).
      - name: sub_region
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of subregions (clusters of several counties forming a major producing basin).
      - name: start_date
        in: query
        required: false
        schema:
          type: string
        description: Limit search to a start date. Date formatting - [“YYYY-MM-DD”].
      - name: state_code
        in: query
        required: false
        schema:
          type: array
        description: Limit search by a list of state codes.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV3WellsResponse'
      x-evidence:
        kind: documentation
  /v4/glossary:
    post:
      operationId: post_v4_glossary
      tags:
      - Glossary
      summary: POST /v4/glossary
      x-source: https://apidocs.synmax.com/v4/glossary.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV4GlossaryRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Synmax Python Client PowerShell curl -X POST \"https://hyperion.api.synmax.com/v4/glossary\"  -H \"Content-Type: application/json\"\
          \  -H \"Access-Key: $API_TOKEN \"  -d '{\"target_function\": \"completions\", \"filter_type\": \"region_natgas\"}' \n from synmax.hyperion.v4\
          \ import HyperionApiClient \n SYNMAX_ACCESS_TOKEN = \"<YOUR_API_TOKEN>\" \n hyperion_api_client = HyperionApiClient ( access_token =\
          \ SYNMAX_ACCE"
  /v4/regions:
    get:
      operationId: get_v4_regions
      tags:
      - Regions
      summary: GET /v4/regions
      x-source: https://apidocs.synmax.com/v4/regions.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Synmax Python Client PowerShell curl -X GET \"https://hyperion.api.synmax.com/v4/regions\"  -H \"Access-Key: $API_TOKEN\
          \ \" \n from synmax.hyperion.v4 import HyperionApiClient \n SYNMAX_ACCESS_TOKEN = \"<YOUR_API_TOKEN>\" \n hyperion_api_client = HyperionApiClient\
          \ ( access_token = SYNMAX_ACCESS_TOKEN ) \n fetch_regions_resp = hyperion_api_client . fetch_regions () \n fetch_regions_df = fetch_regions_resp"
  /v4/rigs:
    post:
      operationId: post_v4_rigs
      tags:
      - Rigs
      summary: POST /v4/rigs
      x-source: https://apidocs.synmax.com/v4/rigs.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Synmax Python Client PowerShell curl -X POST \"https://hyperion.api.synmax.com/v4/rigs\"  -H \"Content-Type: application/json\"\
          \  -H \"Access-Key: $API_TOKEN \"  -d '{}' \n from synmax.hyperion.v4 import HyperionApiClient \n SYNMAX_ACCESS_TOKEN = \"<YOUR_API_TOKEN>\"\
          \ \n hyperion_api_client = HyperionApiClient ( access_token = SYNMAX_ACCESS_TOKEN ) \n rigs_resp = hyperion_api_client . rigs () \n\
          \ rigs_df = r"
  /v4/tils:
    get:
      operationId: get_v4_tils
      tags:
      - Tils
      summary: GET /v4/tils
      x-source: https://apidocs.synmax.com/v4/tils.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Synmax Python Client PowerShell curl -X GET \"https://hyperion.api.synmax.com/v4/tils\"  -H \"Access-Key: $API_TOKEN \"\
          \ \n from synmax.hyperion.v4 import HyperionApiClient \n SYNMAX_ACCESS_TOKEN = \"<YOUR_API_TOKEN>\" \n hyperion_api_client = HyperionApiClient\
          \ ( access_token = SYNMAX_ACCESS_TOKEN ) \n fetch_tils_resp = hyperion_api_client . fetch_tils () \n fetch_tils_df = fetch_tils_resp\
          \ . df () \n fetc"
  /v4/wells:
    post:
      operationId: post_v4_wells
      tags:
      - Wells
      summary: POST /v4/wells
      x-source: https://apidocs.synmax.com/v4/wells.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Synmax Python Client PowerShell curl -X POST \"https://hyperion.api.synmax.com/v4/wells\"  -H \"Content-Type: application/json\"\
          \  -H \"Access-Key: $API_TOKEN \"  -d '{}' \n from synmax.hyperion.v4 import HyperionApiClient \n SYNMAX_ACCESS_TOKEN = \"<YOUR_API_TOKEN>\"\
          \ \n hyperion_api_client = HyperionApiClient ( access_token = SYNMAX_ACCESS_TOKEN ) \n wells_resp = hyperion_api_client . wells () \n\
          \ wells_df"
components:
  schemas:
    PostV3FraccrewsResponse:
      type: object
      properties:
        county:
          type: string
          description: County in the state where the well is located.
        date:
          type: string
          description: Frac crew location date. Date formatting - [“YYYY-MM-DD”]
        frac_class:
          type: string
          description: Classifies wells as either oil or gas wells based on the GOR definition from the EIA.
        lat:
          type: string
          description: The latitude of the location, in decimal degrees; follows the WGS 84/EPSG:4326 coordinate system.
        long:
          type: string
          description: The longitude of the location, in decimal degrees; follows the WGS 84/EPSG:4326 coordinate system.
        operator_name:
          type: string
          description: Operator of the well.
        region:
          type: string
          description: Aggregation of multiple major producing basins.
        service_company:
          type: string
          description: Company contracted by the operator to perform the frac job.
        state_ab:
          type: string
          description: Abbreviation of the state.
        sub_region:
          type: string
          description: Aggregation of several counties, typically representing a major producing basin.
        wellpad_id:
          type: string
          description: Identifier of the wellpad.
    GetV3RegionsResponse:
      type: object
      properties:
        county:
          type: string
          description: County in the state where the well is located.
        region:
          type: string
          description: Aggregation of multiple major producing basins.
        state_ab:
          type: string
          description: Abbreviation of the state.
        sub_region:
          type: string
          description: Aggregation of several counties, typically representing a major producing basin.
    PostV3RigsResponse:
      type: object
      properties:
        county:
          type: string
          description: County in the state where the well is located.
        date:
          type: string
          description: Date on which a rig is operating. Date formatting - [“YYYY-MM-DD”]
        lat:
          type: string
          description: The latitude of the location, in decimal degrees; follows the WGS 84/EPSG:4326 coordinate system.
        long:
          type: string
          description: The longitude of the location, in decimal degrees; follows the WGS 84/EPSG:4326 coordinate system.
        operator_name:
          type: string
          description: Operator of the well.
        region:
          type: string
          description: Aggregation of multiple major producing basins.
        rig_class:
          type: string
          description: Classifies wells as either oil or gas wells based on the GOR definition from the EIA.
        sub_region:
          type: string
          description: Aggregation of several counties, typically representing a major producing basin.
        wellpad_id:
          type: string
          description: Identifier of the wellpad.
    GetV3TilsResponse:
      type: object
      properties:
        bcfd:
          type: number
          description: The total expected production from the DTIL wells on the wellpad
        frac_end:
          type: string
          description: The date the frac job ended for the DTIL wells, if NULL then the wells have not completed fracking - Date formatting -
            [“YYYY-MM-DD”]
        operator_name:
          type: string
          description: Operator of the wellpad.
        sub_region:
          type: string
          description: Aggregation of several counties, typically representing a major producing basin.
        til_date:
          type: string
          description: The date the wells were TILd, if NULL then the wells are currently DTILs - Date formatting - [“YYYY-MM-DD”]
        wellpad_id:
          type: string
          description: Identifier of the wellpad .
        wells:
          type: integer
          description: The number of DTIL wells on the wellpad
    PostV3WellsResponse:
      type: object
      properties:
        api:
          type: integer
          description: An API is a unique, permanent, numeric identifier assigned to each well drilled.
        completion_date:
          type: string
          description: Date on which the well was completed. Date formatting - [“YYYY-MM-DD”].
        county:
          type: string
          description: County in the state where the well is located.
        horizontal_length:
          type: integer
          description: The horizontal length of a well in feet.
        lat:
          type: string
          description: The latitude of the location, in decimal degrees; follows the WGS 84/EPSG:4326 coordinate system.
        lat_bottomhole:
          type: number
          description: Latitude of the well’s bottomhole location.
        lon_bottomhole:
          type: number
          description: Longitude of the well’s bottomhole location.
        long:
          type: string
          description: The longitude of the location, in decimal degrees; follows the WGS 84/EPSG:4326 coordinate system.
        measured_depth:
          type: integer
          description: The measured operating depth of a well in feet.
        operator_name:
          type: string
          description: Operator of the well.
        permit_date:
          type: string
          description: The date on which the well permit was authorized. Date formatting - [“YYYY-MM-DD”].
        production_first_date:
          type: string
          description: ( Unsynced ) date on which the well was first productive after completion. Date formatting - [“YYYY-MM-DD”].
        region:
          type: string
          description: Aggregation of multiple major producing basins.
        spud_date:
          type: string
          description: Spudding is the day the main drill bit enters the ground. Date formatting - [“YYYY-MM-DD”].
        state_ab:
          type: string
          description: Abbreviation of the state.
        sub_region:
          type: string
          description: Aggregation of several counties, typically representing a major producing basin.
        total_vertical_depth:
          type: integer
          description: The total vertical depth of an operating well in feet.
        wellbore_type:
          type: string
          description: The orientation of the well bore used to locate and extract oil and gas from a well. Valid types are ‘vertical’, ‘horizontal’,
            and ‘directional’.
        wellpad_id:
          type: string
          description: Identifier of the wellpad.
    PostV4GlossaryRequest:
      type: object
      properties:
        target_function:
          type: string
        filter_type:
          type: string
tags:
- name: Fraccrews
- name: Glossary
- name: Regions
- name: Rigs
- name: Tils
- name: Wells