Provenance
Freshness & coverage
Methods (20)
getCostData
readWell-level cost summaries (AFE vs Actual capex by component).
EntitiesrecordInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }Filters: API, operator, state, county, reservoir. Aggregated per well.
getCostBreakdown
readLine-item cost details (casing, cement, stimulation, etc.). Filters: API, operator, state, county.
EntitiesrecordInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }Returns detailed cost breakdowns per well
getWells
readWell metadata with dynamic column selection. Filters: API, operator, state, county, reservoir.
EntitieswellInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }columns: "API,operator,state,county,reservoir,lateral,tvd" for efficiency.
getLocations
readWell-path/location data in WKT format (AFE Leaks). Filter by API.
EntitiesrecordInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }Returns geometry_wkt field
getProduction
readMonthly production data (oil, gas, water volumes) (AFE Leaks). Filter by API, operator, state.
EntitiesproductionInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }Returns oil (bbl), gas (MCF), water (bbl) by date
getProductRevenue
readProduct revenue data with well info. Returns volume, value, marketing, product type.
EntitiesrecordInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }getCasing
readCasing design records (string type, hole size, depth, weight, grade). Filter by API.
EntitiescompletionInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }getFormations
readFormation tops and geology (reservoir name, TVD, MD). Filter by API.
EntitiesformationInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }getSurveys
readDirectional survey records (MD, TVD, inclination, azimuth, DLS, N/E/VS). Filter by API.
EntitiessurveyInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }getWellTests
readFlow/pressure test data (IP rates, choke, pressures, test type) (AFE Leaks). Filter by API.
Entitiescompletion, wellInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }getVendorCosts
readVendor cost data (vendor name, code, type, cost amount, phase, rig). Filter by API, operator, state.
EntitiesrecordInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }getFiles
readRegulatory file links and documents. Filter by API.
EntitiesdocumentInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" } }, "additionalProperties": true }getFinancialSubmissions
readSEC company filing metadata (AFE Leaks). Filter by cik, name, form (10-K, 10-Q), period.
EntitiesrecordInput schema
{ "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "form": { "type": "string" }, "sic": { "type": "string" }, "period": { "type": "string" }, "tag": { "type": "string" }, "adsh": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "additionalProperties": true }getFinancialPresentation
readPresentation/display info for financial statement elements. Filter by adsh, tag, stmt.
EntitiesrecordInput schema
{ "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "form": { "type": "string" }, "sic": { "type": "string" }, "period": { "type": "string" }, "tag": { "type": "string" }, "adsh": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "additionalProperties": true }getFinancialNumbers
readAFE Leaks numeric XBRL values from securities filings (value, uom, enddate).
EntitiesrecordInput schema
{ "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "form": { "type": "string" }, "sic": { "type": "string" }, "period": { "type": "string" }, "tag": { "type": "string" }, "adsh": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "additionalProperties": true }getFinancialText
readAFE Leaks narrative text sections from securities filings. Filter by cik, adsh, tag.
EntitiesrecordInput schema
{ "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "form": { "type": "string" }, "sic": { "type": "string" }, "period": { "type": "string" }, "tag": { "type": "string" }, "adsh": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "additionalProperties": true }getFinancialTextBig
readLarge text content (MD&A, footnotes) in chunks. Filter by cik, adsh, tag.
EntitiesrecordInput schema
{ "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "form": { "type": "string" }, "sic": { "type": "string" }, "period": { "type": "string" }, "tag": { "type": "string" }, "adsh": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "additionalProperties": true }getWellDetail
readFull well detail: metadata + costs + production + cost breakdown for a single well (AFE Leaks).
Required paramsAPIEntitieswellInput schema
{ "type": "object", "properties": { "API": { "type": "string" } }, "additionalProperties": false, "required": [ "API" ] }compareCosts
unknownCost comparison across operators/basins/time periods. Pass filters to scope.
EntitiesrecordInput schema
{ "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "API": { "type": "string" }, "operator": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "reservoir": { "type": "string" }, "lease": { "type": "string" }, "leaseNum": { "type": "string" }, "wellNum": { "type": "string" }, "district": { "type": "string" }, "spudDateMin": { "type": "string" }, "spudDateMax": { "type": "string" }, "updateDateMin": { "type": "string" }, "updateDateMax": { "type": "string" }, "columns": { "type": "string" }, "groupBy": { "type": "string" } }, "additionalProperties": true }searchOperators
readSearch wells by operator name. Returns well metadata with key columns.
Required paramsoperatorEntitiesoperatorInput schema
{ "type": "object", "properties": { "operator": { "type": "string" }, "state": { "type": "string" }, "limit": { "type": "number" } }, "additionalProperties": false, "required": [ "operator" ] }
