API Documentation - AFE Leaks

📊 Column Reference

Detailed descriptions of all columns returned by upstream data endpoints

🔍 og_data (Well Metadata)

Note: The /api/wells endpoint supports dynamic column selection using the columns parameter. You can specify which columns to return (e.g., ?columns=API,operator,state,spudDate) from any of the columns listed below.

API – 10- or 12-digit API well number (unique well identifier)

api12 – 12-digit API number (alternate format)

api14 – 14-digit API number (alternate format)

lease – Lease name

leaseNum – Lease number

wellNum – Well number

district – Regulatory district

county – County name

oilGas – Well type (oil/gas/both)

field – Field name

fieldNum – Field number

spudDate – Date well was spudded (drilling started)

lastSpud – Date of last spud (if re-entered)

operator – Operator name (current or at time of record)

operator_clean – Cleaned operator name (standardized)

compDate – Completion date

first_production – Date of first production

last_production – Date of last production

reservoir – Cleaned/standardized reservoir name

lateral – Lateral length (ft)

tvd – True vertical depth (ft)

md – Measured depth (ft)

perf_top – Top of perforated interval (ft)

perf_bottom – Bottom of perforated interval (ft)

perf_interval – Perforated interval length (ft)

depth – Total depth (ft)

fluid – Total fluid used (gallons)

proppant – Total proppant used (lbs)

prop_per_ft – Proppant per foot (lbs/ft)

location – Well location (legal description or lat/lon)

state – State

plug_date – Plugging date

casing_design – Casing design description

update_date – Date of last update

📊 product (Production/Revenue Data)

TaxpayerNumber – Primary taxpayer number

TaxpayerName – Primary taxpayer name

TaxSubType – Tax subtype (if applicable)

date – Production/revenue date

leaseNum – Lease number

district – Regulatory district

SecondaryTaxpayerNumber – Secondary taxpayer number

SecondaryTaxpayerName – Secondary taxpayer name

APIGravity – API gravity (oil quality measure)

volume – Product volume (e.g., barrels, mcf, etc.)

value – Product value (USD)

marketing – Marketing adjustment or revenue

product – Product type (oil, gas, NGL, etc.)

leaseOil – Lease oil production (bbl)

leaseGas – Lease gas production (mcf)

update_date – Date of last update

💰 cost_data_aggregate (Cost Data Summary)

API – API well number

type – AFE/Actual

capex – Total capital expenditure (USD)

component – Cost component (e.g., drilling, completion)

update_date – Date of last update

operator – Operator name (cleaned)

state – State

county – County

reservoir – Reservoir name

lease – Lease name

wellNum – Well number

spudDate – Spud date

fp_year – First production year

perf_interval – Perforated interval (ft)

tvd – True vertical depth (ft)

afedate – AFE date

💸 cost_breakdown_details (Cost Line Items)

API – API well number

cost_type – AFE/Actual

type – Cost type (e.g., material, service)

component – Cost component (e.g., casing, cement)

code – Cost code or identifier

category – Cost category (e.g., drilling, completion)

value – Cost value (USD)

operator – Operator name (cleaned)

state – State

county – County

reservoir – Reservoir name

lease – Lease name

wellNum – Well number

spudDate – Spud date

fp_year – First production year

perf_interval – Perforated interval (ft)

tvd – True vertical depth (ft)

afedate – AFE date

Note: No update_date column

🔧 casing_data (Casing Design)

API – API well number

type – Casing string type (e.g., surface, production)

segment – Casing segment/interval

hole_size – Hole size (inches)

hole_depth – Hole depth (ft)

size – Casing size (inches)

weight – Casing weight (lbs/ft)

grade – Casing grade

update_date – Date of last update

🛢️ prod_data (Production Data)

API – API well number

date – Production date

oil – Oil produced (barrels)

gas – Gas produced (MCF)

water – Water produced (barrels)

update_date – Date of last update

📍 locs (Well Locations)

API – API well number

geometry_wkt – Well geometry/location (WKT format)

update_date – Date of last update

📐 survey_data (Directional Surveys)

API – API well number

MD – Measured depth (ft)

TVD – True vertical depth (ft)

Inclination – Inclination (degrees)

Azimuth – Azimuth (degrees)

DogLegSeverity – Dog leg severity

N – North coordinate

E – East coordinate

VS – Vertical section

update_date – Date of last update

🧪 test_data (Well Tests)

API – API well number

dateTst – Test date

oilD – Oil rate (barrels/day)

gasD – Gas rate (MCF/day)

waterD – Water rate (barrels/day)

chokeSize – Choke size

tubingPressure – Tubing pressure (psi)

casingPressure – Casing pressure (psi)

testType – Test type

testHours – Test duration (hours)

reservoir – Reservoir tested

update_date – Date of last update

🏔️ formation_data (Formation Tops)

API – API well number

reservoir – Formation/reservoir name

tvd – Top TVD (ft)

md – Top MD (ft)

update_date – Date of last update

📄 file_links (Regulatory Files)

API – API well number

Form – File/form type

url – File download URL

update_date – Date of last update

🏭 vendor_costs (Vendor Cost Data)

API – API well number

date – Cost date

vendor – Vendor name

code – Vendor cost code

type – Cost type

description – Cost description

note – Additional notes

cost – Cost amount (USD)

link – Reference link

cost_type – AFE/Actual

rig – Rig information

phase – Project phase

Note: Joined with og_data for well metadata

💼 SEC Financial Data Endpoints

Access SEC XBRL financial data from 10-K and 10-Q filings with comprehensive filtering

📄

Submissions

Filing metadata

GET /api/financials/sub

Company submission metadata (filing information)

🎨

Presentation

Display information

GET /api/financials/pre

Presentation/display info for financial statement elements

🔢

Numeric Data

Financial values

GET /api/financials/num

Numeric financial data values from SEC filings

📝

Text Data

Narrative content

GET /api/financials/text

Text/narrative financial data

GET /api/financials/textbig

Large text content (MD&A, footnotes) in chunks

📊 SEC Financial Data Tables

📋 sub (Company Submissions)

cik – Central Index Key (company identifier)

name – Company name

adsh – Accession number (filing identifier)

sic – Standard Industrial Classification

fye – Fiscal year end (MMDD)

form – SEC form type (10-K, 10-Q, etc.)

period – Reporting period end date

filed – Filing date

accepted – SEC acceptance date

prevrpt – Previous report indicator

detail – Detail level

instance – XBRL instance document

🎨 pre (Presentation Data)

adsh – Accession number

tag – XBRL tag name

version – Taxonomy version

plabel – Presentation label

negating – Negating multiplier

stmt – Statement type (BS, IS, CF, EQ)

inpth – Presentation path

rfile – R file reference

rorder – Report order

tbl – Table identifier

🔢 num (Numeric Financial Data)

adsh – Accession number

tag – XBRL tag name

version – Taxonomy version

enddate – Period end date

qtrs – Number of quarters

uom – Unit of measure

value – Numeric value

footnote – Footnote reference

filed – Filing date

axis – Dimensional axis

segment – Dimensional segment

📝 text (Text Financial Data)

adsh – Accession number

tag – XBRL tag name

version – Taxonomy version

enddate – Period end date

qtrs – Number of quarters

value – Text value

footnote – Footnote reference

filed – Filing date

axis – Dimensional axis

segment – Dimensional segment

📄 textbig (Large Text Content)

adsh – Accession number

tag – XBRL tag name

version – Taxonomy version

enddate – Period end date

qtrs – Number of quarters

chunk_order – Chunk sequence number

value – Large text chunk

footnote – Footnote reference

filed – Filing date

axis – Dimensional axis

segment – Dimensional segment

💡 API Examples

Get Cost Data for Texas Wells

🔑 Using API Key

curl -H "X-API-Key: afe_your_key" \
  "https://api.afeleaks.com/api/cost-data?state=TX&limit=100"

🔥 Using Firebase Token

curl -H "Authorization: Bearer YOUR_TOKEN" \
  "https://api.afeleaks.com/api/cost-data?state=TX&limit=100"

Get Production Data with Pagination

🔑 Using API Key

curl -H "X-API-Key: afe_your_key" \
  "https://api.afeleaks.com/api/production?limit=1000&offset=5000"

🔥 Using Firebase Token

curl -H "Authorization: Bearer YOUR_TOKEN" \
  "https://api.afeleaks.com/api/production?limit=1000&offset=5000"

Get Financial Data for Specific Company

🔑 Using API Key

curl -H "X-API-Key: afe_your_key" \
  "https://api.afeleaks.com/api/financials/num?cik=0000078003&form=10-K"

🔥 Using Firebase Token

curl -H "Authorization: Bearer YOUR_TOKEN" \
  "https://api.afeleaks.com/api/financials/num?cik=0000078003&form=10-K"

📝 Programming Language Examples

📊 R (with API Key)

library(httr)
library(jsonlite)

# Using permanent API key
api_key <- "afe_your_generated_key_here"

resp <- GET(
  url = "https://api.afeleaks.com/api/wells",
  query = list(limit = 10, state = "TX"),
  add_headers(`X-API-Key` = api_key)
)

if (status_code(resp) == 200) {
  data <- content(resp, "parsed")
  wells_df <- data$data
} else {
  print(paste("Error:", status_code(resp)))
}

🐍 Python (with API Key)

import requests
import pandas as pd

# Using permanent API key
api_key = "afe_your_generated_key_here"
headers = {"X-API-Key": api_key}

response = requests.get(
    "https://api.afeleaks.com/api/wells",
    params={"limit": 10, "state": "TX"},
    headers=headers
)

if response.status_code == 200:
    data = response.json()
    wells_df = pd.DataFrame(data["data"])
else:
    print(f"Error: {response.status_code}")

⚡ JavaScript (with API Key)

// Using permanent API key
const apiKey = "afe_your_generated_key_here";

fetch('https://api.afeleaks.com/api/wells?limit=10&state=TX', {
  headers: {
    'X-API-Key': apiKey
  }
})
.then(response => response.json())
.then(data => {
  console.log(`Retrieved ${data.data.length} wells`);
  console.log('Wells:', data.data);
})
.catch(error => console.error('Error:', error));

📈 Excel/Power BI

// Power Query M code
let
    apiKey = "afe_your_generated_key_here",
    url = "https://api.afeleaks.com/api/wells?limit=1000",
    headers = [#"X-API-Key" = apiKey],
    response = Web.Contents(url, [Headers = headers]),
    json = Json.Document(response),
    data = json[data],
    table = Table.FromList(data, Splitter.SplitByNothing(), null, null, ExtraValues.Error)
in
    table

AFE Leaks API Documentation

📋 Table of Contents

Getting Started

API Endpoints

🔐 Authentication

🔑 API Key (Recommended)

🔥 Firebase Token

Need an API Token?

🌐 Base URL

🛢️ Upstream Data Endpoints

Cost Data

Wells & Metadata

Production & Revenue

Technical Details

Vendor & Files

⚙️ Common Parameters

Pagination

Well Filters

Location Filters

Date Range Filters

📊 Column Reference

💼 SEC Financial Data Endpoints

Submissions

Presentation

Numeric Data

Text Data

📊 SEC Financial Data Tables

💡 API Examples

Get Cost Data for Texas Wells

🔑 Using API Key

🔥 Using Firebase Token

Get Production Data with Pagination

🔑 Using API Key

🔥 Using Firebase Token

Get Financial Data for Specific Company

🔑 Using API Key

🔥 Using Firebase Token

📝 Programming Language Examples

📊 R (with API Key)

🐍 Python (with API Key)

⚡ JavaScript (with API Key)

📈 Excel/Power BI

🚀 Quick Start Guide

Get Your API Credentials

Make Your First Request

🔑 With API Key

🔥 With Firebase Token

Integrate Into Your Workflow

Need Help with Integration?