Provenance
Freshness & coverage
Methods (9)
getWell
readGet one well by API or TX:/NM: canonical ID; state defaults to TX.
EntitieswellInput schema
{ "type": "object", "properties": { "api": { "type": "string" }, "state": { "type": "string" } }, "additionalProperties": false }searchWells
readSearch wells with at least one operator, county, field, state, bbox, type, or status filter.
EntitieswellInput schema
{ "type": "object", "properties": { "operator": { "type": "string" }, "county": { "type": "string" }, "field": { "type": "string" }, "state": { "type": "string" }, "bbox": { "type": "string" }, "well_type": { "type": "string" }, "well_status": { "type": "string" }, "sb1150": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ] }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "additionalProperties": false }getWellsByRadius
readFind wells within 25 miles; requires lat/lon and supports state, operator, or status filters.
EntitieswellInput schema
{ "type": "object", "properties": { "lat": { "type": "number" }, "lon": { "type": "number" }, "radius_miles": { "type": "number" }, "state": { "type": "string" }, "operator": { "type": "string" }, "well_status": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "additionalProperties": false }batchWells
unknownBulk well lookup (POST). Args: apis[] (req, <=500), state.
EntitieswellInput schema
{ "type": "object", "properties": { "apis": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" } }, "additionalProperties": false }getWellProduction
readMonthly production history for a well. Args: api (req), state, start_month/end_month (YYYYMM).
Entitiesproduction, wellInput schema
{ "type": "object", "properties": { "api": { "type": "string" }, "state": { "type": "string" }, "start_month": { "type": "string" }, "end_month": { "type": "string" } }, "additionalProperties": false }searchPermits
readSearch TX drilling permits by operator, county, date, or bbox; Enterprise only.
EntitiespermitInput schema
{ "type": "object", "properties": { "operator": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" }, "since": { "type": "string" }, "bbox": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "additionalProperties": false }getPermit
readSingle drilling permit by permit_number (Enterprise only).
EntitiespermitInput schema
{ "type": "object", "properties": { "permit_number": { "type": "string" } }, "additionalProperties": false }getUsage
readYour Clearfork plan usage statistics.
EntitiesrecordInput schema
{ "type": "object", "properties": {}, "additionalProperties": false }getServiceInfo
readConnector surface + live /health (no key required).
EntitiesmetadataInput schema
{ "type": "object", "properties": {}, "additionalProperties": false }
