tppflow-com Rrc API

openapi: 3.2.0
info:
  title: TEOS Transmuter Tollbooth Rrc API
  description: Metered access to refined corporate-distress intelligence. Each domain is a router under /api/v1/. Access is metered through the RapidAPI marketplace. The corpus is served read-only.
  contact:
    name: TEOS Data
  license:
    name: Commercial -- metered API access
  version: v1
tags:
- name: rrc
paths:
  /api/v1/rrc/describe_layout:
    get:
      tags:
      - rrc
      summary: Field inventory for WBROOT (free, record-free)
      description: The contract, with its gaps stated. No records -- by design.
      operationId: describe_layout_api_v1_rrc_describe_layout_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/rrc/wellbores:
    get:
      tags:
      - rrc
      summary: Wellbore identities (25 free rows, bulk with a key)
      operationId: wellbores_api_v1_rrc_wellbores_get
      parameters:
      - name: district
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: RRC district
          title: District
        description: RRC district
      - name: county
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Texas county code
          title: County
        description: Texas county code
      - name: api_number
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Exact 42-CCC-UUUUU
          title: Api Number
        description: Exact 42-CCC-UUUUU
      - name: plugged
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Plugged
      - name: orphan_well_hold
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Orphan Well Hold
      - name: completed_since
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: ISO date
          title: Completed Since
        description: ISO date
      - name: completed_before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: ISO date
          title: Completed Before
        description: ISO date
      - name: min_depth
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Depth
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 5000
            minimum: 1
          - type: 'null'
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      - name: X-RapidAPI-Proxy-Secret
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Rapidapi-Proxy-Secret
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellboresResponse'
        '402':
          description: No key, and the request asked for more than the 25-row free sample (limit > 25 or offset > 0). Body carries the checkout URL.
        '403':
          description: Key is valid but scoped to a different module
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/rrc/stats:
    get:
      tags:
      - rrc
      summary: Corpus depth by county and plug status (free, uncapped)
      description: 'Aggregate depth proof. Free, uncapped, and structurally incapable of

        yielding a row.


        Counts are not extractable data -- there is no API number, no depth, no

        date in this response, so an agent (or a crawler) can establish that the

        corpus is real and deep without harvesting any of it. That is why it sits

        outside both the row cap and the daily quota: it costs us nothing to give

        away and it is the honest answer to "is this worth $499".'
      operationId: stats_api_v1_rrc_stats_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transmuter__modules__rrc__api__StatsResponse'
components:
  schemas:
    Wellbore:
      properties:
        api_number:
          type: string
          title: Api Number
          description: Texas API well number, 42-CCC-UUUUU
          examples:
          - 42-001-00008
        district:
          anyOf:
          - type: integer
          - type: 'null'
          title: District
          description: RRC district
          examples:
          - 6
        api_county:
          anyOf:
          - type: integer
          - type: 'null'
          title: Api County
          description: Texas county code
          examples:
          - 1
        completion_date:
          anyOf:
          - type: string
          - type: 'null'
          title: Completion Date
          description: ISO date of original completion (W-2/G-1). NULL when the source value is not a valid calendar date.
        completion_date_raw:
          anyOf:
          - type: integer
          - type: 'null'
          title: Completion Date Raw
          description: The source's own CCYYMMDD integer, preserved even when it fails the calendar, so dirt is visible not hidden.
        total_depth:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Depth
          description: Total depth, feet
        total_bonded_depth:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total Bonded Depth
        shut_in_month:
          anyOf:
          - type: string
          - type: 'null'
          title: Shut In Month
          description: YYYY-MM
        plugged:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Plugged
          description: Wellbore has been plugged
        subject_to_14b2:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Subject To 14B2
          description: Inactive well operating under a 14(b)(2) extension
        pending_removal_14b2:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Pending Removal 14B2
        orphan_well_hold:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Orphan Well Hold
          description: Flagged in the orphan-well program
        fresh_water_protected:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Fresh Water Protected
        except_13a_filed:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Except 13A Filed
        completion_data_on_file:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Completion Data On File
        newest_drilling_permit_nbr:
          anyOf:
          - type: integer
          - type: 'null'
          title: Newest Drilling Permit Nbr
        previous_api_nbr:
          anyOf:
          - type: integer
          - type: 'null'
          title: Previous Api Nbr
      type: object
      required:
      - api_number
      title: Wellbore
    PlugStatusDepth:
      properties:
        status:
          type: string
          title: Status
        wellbores:
          type: integer
          title: Wellbores
      type: object
      required:
      - status
      - wellbores
      title: PlugStatusDepth
    transmuter__modules__rrc__api__StatsResponse:
      properties:
        total_wellbores:
          type: integer
          title: Total Wellbores
        last_ingested:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Ingested
        by_county:
          items:
            $ref: '#/components/schemas/CountyDepth'
          type: array
          title: By County
        by_plug_status:
          items:
            $ref: '#/components/schemas/PlugStatusDepth'
          type: array
          title: By Plug Status
        note:
          type: string
          title: Note
      type: object
      required:
      - total_wellbores
      - by_county
      - by_plug_status
      - note
      title: StatsResponse
    ResponseMetadata:
      properties:
        total_matched:
          type: integer
          title: Total Matched
          description: Wellbores matching this query
        corpus_wells:
          type: integer
          title: Corpus Wells
          description: Total wellbores in the corpus
        returned:
          type: integer
          title: Returned
          description: Rows in this response
        withheld:
          type: integer
          title: Withheld
          description: Matching rows not returned
        last_ingested:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Ingested
          description: UTC timestamp of the most recent corpus load
        free_tier:
          type: boolean
          title: Free Tier
        free_rows_per_request:
          anyOf:
          - type: integer
          - type: 'null'
          title: Free Rows Per Request
        free_queries_per_day:
          anyOf:
          - type: integer
          - type: 'null'
          title: Free Queries Per Day
        queries_used_today:
          anyOf:
          - type: integer
          - type: 'null'
          title: Queries Used Today
      type: object
      required:
      - total_matched
      - corpus_wells
      - returned
      - withheld
      - free_tier
      title: ResponseMetadata
    WellboresResponse:
      properties:
        count:
          type: integer
          title: Count
          description: Rows in this response
        total_matching:
          type: integer
          title: Total Matching
          description: Rows matching the query in the corpus
        metadata:
          $ref: '#/components/schemas/ResponseMetadata'
        query:
          additionalProperties: true
          type: object
          title: Query
        free_tier:
          type: boolean
          title: Free Tier
          description: True when served without a key
        upgrade:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Upgrade
          description: 'Present on the free tier: how to get the rest'
        wellbores:
          items:
            $ref: '#/components/schemas/Wellbore'
          type: array
          title: Wellbores
      type: object
      required:
      - count
      - total_matching
      - metadata
      - query
      - free_tier
      - wellbores
      title: WellboresResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    CountyDepth:
      properties:
        county:
          type: integer
          title: County
        wellbores:
          type: integer
          title: Wellbores
      type: object
      required:
      - county
      - wellbores
      title: CountyDepth
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError