{"openapi":"3.1.0","info":{"title":"AcreEyes API","description":"Public-data rural land screening. AcreEyes is a public-data screening tool. Results are not a survey, appraisal, title search, septic or well approval, flood determination, water-right opinion or buildability opinion. Verify with the county and licensed professionals before relying on them.","version":"1"},"servers":[{"url":"https://acreeyes.com/api/v1"}],"paths":{"/health":{"get":{"summary":"Service health","operationId":"health","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"tags":["Account"],"security":[]}},"/me":{"get":{"summary":"Your key, plan and this month's usage","operationId":"getMe","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"tags":["Account"],"security":[{"bearer":[]}]}},"/regions":{"get":{"summary":"States AcreEyes covers","operationId":"listRegions","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"tags":["Account"],"security":[{"bearer":[]}]}},"/profiles":{"get":{"summary":"Scoring profiles and the Eyes","operationId":"listProfiles","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"tags":["Account"],"security":[{"bearer":[]}]}},"/usage":{"get":{"summary":"Charged runs in a month","operationId":"getUsage","parameters":[{"name":"month","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Month"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"],"security":[{"bearer":[]}]}},"/resolve":{"post":{"summary":"Check a parcel resolves (free)","description":"Check a PIN or address resolves to a parcel before spending a run. Free;\nadvisory (the run resolves it again). Always 200 with a `status`.","operationId":"resolveParcel","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parcel"],"properties":{"parcel":{"type":"string","maxLength":200,"description":"A PIN or an address; comma-separate several PINs."},"county":{"type":"string","description":"The county, when a PIN exists in several."},"state":{"type":"string","default":"ID"}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Runs"],"x-acreeyes-scope":"runs:write","security":[{"bearer":[]}]}},"/runs":{"post":{"summary":"Start a report","operationId":"startRun","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Give exactly one of `pin`, `address` or `point`.","properties":{"pin":{"type":"string","description":"Assessor parcel number, e.g. RP58N02E070150A."},"county":{"type":"string","description":"With `pin` only: the county, when the PIN exists in several."},"address":{"type":"string","maxLength":200,"description":"A site address."},"point":{"type":"array","items":{"type":"number"},"minItems":2,"maxItems":2,"description":"[longitude, latitude] inside the state."},"state":{"type":"string","default":"ID","description":"Two-letter state code (GET /regions)."},"well_radius_miles":{"type":"number","default":2,"minimum":0.1,"maximum":10},"good_well_gpm":{"type":"number","default":10,"minimum":0.1,"maximum":500,"description":"The yield a well must reach to count as good."},"stream_radius_miles":{"type":"number","default":1,"minimum":0.1,"maximum":5},"advertised_acres":{"type":"number","minimum":0.01,"maximum":1000000,"description":"Optional: the acreage the listing advertises. Compared with the mapped parcel's acreage, never used in its place; a large gap is reported (and can hold the grade), saying when only part of the parcel may be for sale."},"profile":{"type":"string","description":"A scoring profile name (GET /profiles)."},"weights":{"description":"Per-Eye multipliers: {\"water\": 2} or \"water:2,hazard:1.5\".","oneOf":[{"type":"object","additionalProperties":{"type":"number"}},{"type":"string"}]},"eyes":{"description":"Which Eyes the report shows (every lookup still runs): [\"water\", \"hazard\"] or \"water,hazard\"; absent = all.","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"skip_soils":{"type":"boolean","default":false,"description":"Skip the soils lookups."},"skip_terrain":{"type":"boolean","default":false,"description":"Skip the terrain lookups."},"skip_streams":{"type":"boolean","default":false,"description":"Skip the streams lookups."},"skip_hazards":{"type":"boolean","default":false,"description":"Skip the hazards lookups."},"skip_diligence":{"type":"boolean","default":false,"description":"Skip the diligence lookups."},"skip_imagery":{"type":"boolean","default":false,"description":"Skip the imagery lookups."},"kind":{"type":"string","enum":["analyze","find"],"default":"analyze","description":"`find` (land discovery) needs the owner-only `find` scope."},"source":{"type":"string","enum":["auto","live","mirror"],"default":"auto","description":"Owner keys only: read mirrored data live or from the local copy."},"debug":{"type":"string","enum":["trace","verbose"],"description":"Owner keys only: trace detail."}}}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Runs"],"x-acreeyes-scope":"runs:write","security":[{"bearer":[]}]},"get":{"summary":"List runs","operationId":"listRuns","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Since"}},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Before"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"key_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Runs"],"security":[{"bearer":[]}]}},"/runs/{run_id}":{"get":{"summary":"Get a run","operationId":"getRun","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Runs"],"security":[{"bearer":[]}]}},"/runs/{run_id}/cancel":{"post":{"summary":"Cancel a run","operationId":"cancelRun","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Runs"],"x-acreeyes-scope":"runs:write","security":[{"bearer":[]}]}},"/runs/{run_id}/logs":{"get":{"summary":"A run's output lines","operationId":"getRunLogs","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"name":"after","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"After"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":2000,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Runs"],"security":[{"bearer":[]}]}},"/runs/{run_id}/stream":{"get":{"summary":"Watch a run live (server-sent events)","description":"Server-sent events. Every log line is a plain `data:` message (a JSON\nstring); structured events ride alongside it — `stage`, `flag`, `result`,\n`choices` (see StreamEvents) — and `end` carries the final run.","operationId":"streamRun","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Runs"],"security":[{"bearer":[]}]}},"/runs/{run_id}/debug":{"get":{"summary":"A run's debug summary","description":"The run's debug trace. Customer keys: a redacted summary. Owner keys with\n`debug:full`: the full summary, and with `events=true` raw events from byte\noffset `after` (poll with the returned `next` to tail a live run).","operationId":"getRunDebug","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"name":"events","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Events"}},{"name":"after","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"After"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":2000,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Runs"],"security":[{"bearer":[]}]}},"/runs/{run_id}/debug/download":{"get":{"summary":"Download a run's raw trace","operationId":"downloadRunDebug","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Runs"],"x-acreeyes-scope":"debug:full","security":[{"bearer":[]}]}},"/analyses":{"get":{"summary":"List saved analyses","operationId":"listAnalyses","parameters":[{"name":"profile","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"}},{"name":"weights","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Weights"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Analyses"],"x-acreeyes-scope":"analyses:read","security":[{"bearer":[]}]}},"/analyses/{aid}":{"get":{"summary":"An analysis: summary and raw engine result","operationId":"getAnalysis","parameters":[{"name":"aid","in":"path","required":true,"schema":{"type":"string","title":"Aid"}},{"name":"profile","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"}},{"name":"weights","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Weights"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Analyses"],"x-acreeyes-scope":"analyses:read","security":[{"bearer":[]}]}},"/analyses/{aid}/report.json":{"get":{"summary":"The report as JSON","description":"The full screening report as JSON (schema acreeyes.report/1): everything the\nPDF says, as data. `/v1/analyses/{id}` is the raw engine result.\n\ncompact=true leaves out the per-Eye detail and tables (`omitted` names them):\nabout a quarter of the size, keeping the score, decision brief, flags and key facts.","operationId":"getReport","parameters":[{"name":"aid","in":"path","required":true,"schema":{"type":"string","title":"Aid"}},{"name":"hide_owner","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Hide Owner"}},{"name":"compact","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Compact"}},{"name":"profile","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"}},{"name":"weights","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Weights"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Analyses"],"x-acreeyes-scope":"analyses:read","security":[{"bearer":[]}]}},"/analyses/{aid}/pdf":{"get":{"summary":"The report as a PDF","operationId":"getReportPdf","parameters":[{"name":"aid","in":"path","required":true,"schema":{"type":"string","title":"Aid"}},{"name":"brand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brand"}},{"name":"hide_owner","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Hide Owner"}},{"name":"profile","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"}},{"name":"weights","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Weights"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Analyses"],"x-acreeyes-scope":"analyses:read","security":[{"bearer":[]}]}},"/analyses/{aid}/maps/{name}.png":{"get":{"summary":"One report map (PNG, or JPEG when drawn over the aerial photo)","operationId":"getReportMap","parameters":[{"name":"aid","in":"path","required":true,"schema":{"type":"string","title":"Aid"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Analyses"],"x-acreeyes-scope":"analyses:read","security":[{"bearer":[]}]}},"/analyses/{aid}/share":{"post":{"summary":"Create a share link","operationId":"shareReport","parameters":[{"name":"aid","in":"path","required":true,"schema":{"type":"string","title":"Aid"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"string","description":"Your brand name on the shared page."},"prepared_for":{"type":"string","description":"Who the report was prepared for."},"hide_owner":{"type":"boolean","default":true,"description":"Leave the owner's name off."},"listing_url":{"type":"string","description":"A link back to the listing."}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Analyses"],"x-acreeyes-scope":"shares:write","security":[{"bearer":[]}]}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your API key, `ae_live_…`, in the Authorization header."}}}}