{"openapi":"3.1.0","info":{"title":"Water Well API","version":"1.0.0","description":"Water-well maths as an API, computed locally and deterministically — the casing, yield and pump-setting numbers a well driller, pump installer or rural homeowner works to. The casing-volume endpoint gives the standing water in a well: gallons per foot = π/4 · diameter² × 12 ÷ 231 (about 1.47 gal/ft for a 6-inch casing, 0.65 for a 4-inch) times the water column, so 100 feet of water in a 6-inch casing holds about 147 gallons — the figure you need to purge a few well volumes before sampling or to dose shock-chlorination. The specific-capacity endpoint turns a drawdown test into how freely the well gives up water: specific capacity = pumping rate ÷ drawdown (gpm per foot), and the projected yield ≈ that times the available drawdown — 15 GPM at 20 feet of drawdown is 0.75 gpm/ft and roughly 45 GPM at 60 feet. The pump-setting endpoint gives the depth to hang the pump: static water level + drawdown + submergence (typically 10–20 feet), so it never air-locks as the level draws down, with a check against the well depth. Everything is computed locally and deterministically, so it is instant and private. Ideal for well-drilling and pump-installer apps, rural-water and homeowner tools, hydrogeology calculators, and trade aids. Pure local computation — no key, no third-party service, instant. Live, nothing stored. 3 compute endpoints. Estimates — verify with a real drawdown test. For pump power/head use a pump API; for well chlorination use a pool-chemistry API.","contact":{"name":"PremiumApi","url":"https://www.oanor.com/by/premiumapi"}},"servers":[{"url":"https://api.oanor.com/wellpump-api","description":"oanor gateway"}],"tags":[{"name":"Well"},{"name":"Meta"}],"components":{"securitySchemes":{"oanorKey":{"type":"apiKey","in":"header","name":"x-oanor-key","description":"Get your key at https://www.oanor.com/developer/keys"}}},"security":[{"oanorKey":[]}],"paths":{"/v1/casing-volume":{"get":{"operationId":"get_v1_casing_volume","tags":["Well"],"summary":"Standing water in a casing","description":"","parameters":[{"name":"casing_diameter_in","in":"query","required":true,"description":"Casing diameter in inches","schema":{"type":"string"},"example":"6"},{"name":"water_column_ft","in":"query","required":true,"description":"Standing water column in feet","schema":{"type":"string"},"example":"100"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"note":"Standing water = gallons per foot × the water column, where gallons per foot = π/4 · diameter² × 12 ÷ 231 (≈ 1.47 gal/ft for a 6-inch casing, 0.65 for a 4-inch). It is what you need for shock-chlorination dosing and to purge a few well volumes before sampling.","inputs":{"water_column_ft":100,"casing_diameter_in":6},"gallons_per_foot":1.469,"standing_water_gallons":146.9},"meta":{"timestamp":"2026-06-06T23:53:58.779Z","request_id":"d652c8bc-8e3e-4ec2-9dee-9d904377351e"},"status":"ok","message":"Casing volume","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/pump-setting":{"get":{"operationId":"get_v1_pump_setting","tags":["Well"],"summary":"Pump setting depth","description":"","parameters":[{"name":"static_water_level_ft","in":"query","required":true,"description":"Static water level (depth to water) in feet","schema":{"type":"string"},"example":"50"},{"name":"drawdown_ft","in":"query","required":true,"description":"Drawdown in feet","schema":{"type":"string"},"example":"30"},{"name":"submergence_ft","in":"query","required":false,"description":"Submergence below pumping level (default 20)","schema":{"type":"string"},"example":"20"},{"name":"well_depth_ft","in":"query","required":false,"description":"Total well depth in feet","schema":{"type":"string"},"example":"120"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"note":"Set the pump below the pumping water level (static level + drawdown) with enough submergence — usually 10–20 ft — so it never breaks suction and air-locks as the level draws down. Keep it above the screen and the bottom sediment, and leave room for a dry season dropping the static level further.","inputs":{"drawdown_ft":30,"submergence_ft":20,"static_water_level_ft":50},"pump_setting_depth_ft":100,"pumping_water_level_ft":80,"clearance_above_bottom_ft":20},"meta":{"timestamp":"2026-06-06T23:53:58.847Z","request_id":"9ce26b27-ed08-4acb-94b7-d1b84fa59d6a"},"status":"ok","message":"Pump setting","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/specific-capacity":{"get":{"operationId":"get_v1_specific_capacity","tags":["Well"],"summary":"Specific capacity & yield","description":"","parameters":[{"name":"pumping_rate_gpm","in":"query","required":true,"description":"Pumping rate in GPM","schema":{"type":"string"},"example":"15"},{"name":"drawdown_ft","in":"query","required":true,"description":"Drawdown in feet","schema":{"type":"string"},"example":"20"},{"name":"available_drawdown_ft","in":"query","required":false,"description":"Available drawdown for projected yield","schema":{"type":"string"},"example":"60"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"note":"Specific capacity = pumping rate ÷ drawdown (the drop in water level while pumping) — gallons per minute per foot. It measures how freely the well gives up water. Projected yield ≈ specific capacity × the available drawdown, but the relationship flattens at higher rates, so treat it as an upper guide and test at the real rate.","inputs":{"drawdown_ft":20,"pumping_rate_gpm":15},"projected_yield_gpm":45,"specific_capacity_gpm_ft":0.75},"meta":{"timestamp":"2026-06-06T23:53:58.900Z","request_id":"bda164a5-7bfc-4ab4-b9fe-97e414d56dd4"},"status":"ok","message":"Specific capacity","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/meta":{"get":{"operationId":"get_v1_meta","tags":["Meta"],"summary":"Spec","description":"","parameters":[],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"notes":"US units (feet, inches, gallons, GPM). gal/ft = π/4·D²·12/231; specific capacity = rate/drawdown; pump setting = static + drawdown + submergence. Estimates — verify with a real drawdown test. For pump power/head use a pump API; for well chlorination use a pool-chemistry API.","service":"wellpump-api","endpoints":{"GET /v1/meta":"This document.","GET /v1/pump-setting":"Pump setting depth below the pumping water level.","GET /v1/casing-volume":"Standing water gallons and gallons per foot for a casing.","GET /v1/specific-capacity":"Specific capacity (gpm/ft) and projected yield from a pumping test."},"description":"Water-well maths: standing water in a casing, specific capacity and projected yield from a drawdown test, and the pump setting depth."},"meta":{"timestamp":"2026-06-06T23:53:58.970Z","request_id":"9c7e6292-48fd-4b75-a5bf-ee657133c4b3"},"status":"ok","message":"Meta","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}}},"x-oanor-pricing":[{"slug":"free","name":"Free","price_cents_month":0,"monthly_call_quota":430,"rps_limit":2,"hard_limit":true},{"slug":"starter","name":"Starter","price_cents_month":525,"monthly_call_quota":11400,"rps_limit":6,"hard_limit":true},{"slug":"pro","name":"Pro","price_cents_month":1700,"monthly_call_quota":76500,"rps_limit":15,"hard_limit":true},{"slug":"mega","name":"Mega","price_cents_month":5120,"monthly_call_quota":253000,"rps_limit":36,"hard_limit":true}],"x-oanor-marketplace-url":"https://www.oanor.com/api/wellpump-api"}