SnapshotEnvelope

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/buckheadenergy-com/json-schema/buckheadenergy-com-snapshot-envelope-schema.json",
  "title": "SnapshotEnvelope",
  "x-generated": "2026-11-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/buckheadenergy-com-openapi.json#/components/schemas/SnapshotEnvelope",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string"
        },
        "counts": {
          "type": "object",
          "additionalProperties": {
            "type": [
              "integer",
              "null"
            ]
          },
          "description": "Aggregate counts. permits12mo / spuds12mo / firstProd12mo are null when unknown, withheld, or held (see drillingHeld)."
        },
        "topOperators": {
          "type": "array",
          "maxItems": 25,
          "items": {
            "type": "object"
          }
        },
        "topCounties": {
          "type": "array",
          "maxItems": 25,
          "items": {
            "type": "object"
          }
        },
        "topFormations": {
          "type": "array",
          "maxItems": 25,
          "items": {
            "type": "object"
          }
        },
        "dataAsOf": {
          "type": [
            "string",
            "null"
          ]
        },
        "drillingHeld": {
          "type": [
            "object",
            "null"
          ],
          "description": "Present when the state's permit, spud and first-production counts are held while the source is reconciled with state records.",
          "properties": {
            "held": {
              "type": "boolean",
              "enum": [
                true
              ]
            },
            "reason": {
              "type": "string",
              "enum": [
                "reconciling-with-state-records"
              ]
            },
            "note": {
              "type": "string"
            },
            "since": {
              "type": "string"
            },
            "regulator": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "meta": {
      "$ref": "#/$defs/Meta"
    }
  },
  "$defs": {
    "Meta": {
      "type": "object",
      "properties": {
        "apiVersion": {
          "type": "string"
        },
        "dataAsOf": {
          "type": [
            "string",
            "null"
          ],
          "format": "date",
          "description": "Date the underlying metrics were last refreshed"
        },
        "source": {
          "type": "string",
          "description": "Attribution"
        }
      }
    }
  }
}