Pad-scale API

pad-scale-api/1.0.0 — run a whole-pad fracture simulation from your own spreadsheet and compare it against the app's reference audit. Pure compute: nothing you send is stored, and no sign-in is needed.

1. Solve one well

POST https://wellboregenius.com/api/public/pad-scale/solve with a JSON body, or GET the same URL with query parameters when your tool can only fetch a URL.

curl -X POST https://wellboregenius.com/api/public/pad-scale/solve \
  -H 'content-type: application/json' \
  -d '{"name":"Wolfcamp A 12H","stageCount":10,"stageSpacingFt":225,
       "clusterCount":6,"payHeightFt":160,"tvdFt":9200,"closureStressPsi":7600,
       "youngsModulusMpsi":4.6,"slurryVolumeBblPerStage":9500,"rateBpm":85,
       "viscosityCp":3,"proppantLbPerStage":480000,
       "measuredHalfLengthFt":950,"measuredHalfLengthKind":"hydraulic",
       "measuredHeightFt":210,"measuredNetPressurePsi":720}'

Add ?format=flat for one flat row of named numbers (easiest to land in cells), or ?format=csv for the same long-format CSV the app exports.

# Google Sheets, one cell:
=IMPORTDATA("https://wellboregenius.com/api/public/pad-scale/solve?format=csv&name=Test&stageCount=10&payHeightFt=160&tvdFt=9200&closureStressPsi=7600&measuredHalfLengthFt=950")

2. Compare against the reference audit

GET https://wellboregenius.com/api/public/pad-scale/references returns every published field case (HFTS-1 Wolfcamp cores, MSEEL MIP-3H DAS) solved through the same kernel — identical numbers to the in-app reference audit panel. ?format=csv and ?physics=legacy are supported.

Well inputs

Anything you omit uses the default. Values are validated, not silently clamped: an out-of-range value returns HTTP 422 with a plain-language message per field.

Field	Meaning	Unit	Range	Default
`stageCount`	Stages	–	1 – 60	8
`stageSpacingFt`	Stage spacing	ft	20 – 2000	250
`clusterCount`	Clusters per stage	–	1 – 24	6
`payHeightFt`	Pay thickness	ft	5 – 2000	180
`tvdFt`	TVD	ft	500 – 25000	9000
`youngsModulusMpsi`	Young's modulus	Mpsi	0.2 – 15	4.5
`poissonRatio`	Poisson ratio	–	0.05 – 0.45	0.22
`toughnessPsiSqrtIn`	Toughness	psi·√in	100 – 5000	1000
`closureStressPsi`	Closure stress	psi	500 – 20000	7500
`slurryVolumeBblPerStage`	Slurry per stage	bbl	50 – 100000	9000
`rateBpm`	Stage rate	bpm	1 – 200	80
`viscosityCp`	Slurry viscosity	cP	0.3 – 1000	3
`proppantLbPerStage`	Proppant per stage	lb	0 – 5000000	450000

Measurements (all optional)

Field	Meaning
`measuredHalfLengthFt`	Your measured half-length, ft.
`measuredHalfLengthKind`	`hydraulic` (fibre/microseismic/pressure — graded like-for-like) or `propped` (core/tracer — reported as a ratio, never as an error).
`measuredHeightFt`	Measured fracture height, ft.
`measuredNetPressurePsi`	Measured net pressure, psi.
`measuredFluidEfficiency`	Fraction between 0 and 1.
`measuredSource`	Free text stamped into the provenance trailer.

Blank measurements are simply not graded.

Physics

"physics" is "calibrated" (default) or "legacy" for the zero-leak-off closed form. Override individual calibrated constants with a "constants" object; each is clamped to its safe range, so results stay comparable to the app.

Constant	Meaning	Unit	Fitted default
`leakoffCoefficientFtPerSqrtMin`	Carter leak-off coefficient	ft/√min	0.00032
`spurtLossFt`	Spurt loss	ft	0.00002
`nolteG0`	Nolte g₀	-	1.47
`barrierStressContrastPsi`	Barrier stress contrast	psi	150
`barrierStressGradientPsiPerFt`	Barrier stress gradient	psi/ft	1
`maxHeightFt`	Height cap	ft	400
`inZoneStressGradientPsiPerFt`	In-zone stress gradient	psi/ft	0.6
`proppantBankEfficiency`	Proppant bank efficiency	–	0.29
`proppantPackPorosity`	Proppant pack porosity	–	0.35
`proppantDiameterIn`	Proppant grain diameter	in	0.0118
`bridgeWidthMultiple`	Bridging width multiple	–	3
`packProfileExponent`	Pack bank profile exponent	–	0.8
`bankHeightFt`	Settled bank height	ft	95
`minPayCoverageFraction`	Minimum pay coverage	–	0.2
`barrierSofteningPsi`	Barrier threshold softening	psi	40
`barrierEncroachmentFraction`	Barrier encroachment	–	0.4