{ "openapi": "3.0.1", "info": { "title": "USDA SSURGO Soil Suitability, Hydric & Septic Screener API", "description": "Screen any US coordinate against the USDA SSURGO soil survey: map unit, percent-weighted soil components, prime-farmland class, hydric rating, drainage, slope, and septic, foundation, road and solar-array limitations with the limiting reasons. Minority hydric components are reported, not hidden.", "version": "1.0", "x-build-id": "9GzurE9TZAoYIgRYy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malonestar~ssurgo-soil-suitability-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malonestar-ssurgo-soil-suitability-screener", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/malonestar~ssurgo-soil-suitability-screener/runs": { "post": { "operationId": "runs-sync-malonestar-ssurgo-soil-suitability-screener", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/malonestar~ssurgo-soil-suitability-screener/run-sync": { "post": { "operationId": "run-sync-malonestar-ssurgo-soil-suitability-screener", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "assets" ], "properties": { "assets": { "title": "Sites to screen", "type": "array", "description": "Coordinates to look up in the USDA NRCS SSURGO soil survey. Each item is an object: {\"lat\": , \"lon\": , \"label\": \"\"}. One site produces exactly one billable dataset row. A coordinate USDA has not soil-mapped (open water, or an unsurveyed area) returns lookup_status=\"out_of_coverage\" with every soil, hydric and suitability field NULL - that is an explicit 'not evaluated', never a finding of 'no limitations'." }, "interpretations": { "title": "NRCS interpretations to report", "type": "array", "description": "Which NRCS engineering interpretations to rate each site against. LEAVE EMPTY for all eight, which is the safe superset - this field is deliberately given no schema default, because an input-schema default is injected server-side into every run and would narrow the query of a caller who never asked for it. Each selected interpretation adds eight columns: the dominant-component rating, its limiting reasons, the most-limiting rating across ANY component, which component that is, the percent of the map unit rated Very limited, the percent actually rated, the union of limiting reasons, and a per-interpretation status.", "items": { "type": "string", "enum": [ "septic_tank_absorption_fields", "dwellings_with_basements", "dwellings_without_basements", "small_commercial_buildings", "local_roads_and_streets", "shallow_excavations", "solar_arrays_ballast_anchor", "solar_arrays_soil_anchor" ], "enumTitles": [ "Septic tank absorption fields", "Dwellings with basements", "Dwellings without basements", "Small commercial buildings", "Local roads and streets", "Shallow excavations", "Ground-based solar arrays, ballast anchor systems", "Ground-based solar arrays, soil-based anchor systems" ] } }, "includeComponentDetail": { "title": "Include the full component and interpretation JSON", "type": "boolean", "description": "When true (the default), each row also carries components_json - every soil component of the map unit with all 36 fetched SSURGO attributes - and interpretations_json, which adds the NRCS fuzzy rating value and any sub-rules NRCS could not evaluate. Turn this off for a slimmer CSV; it does not change the number of billable rows or any flat column.", "default": true }, "maxAssets": { "title": "Max site lookups", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Safety cap on how many sites this run will screen. Sites beyond the cap are skipped with a warning and are not billed.", "default": 2000 }, "simulateOutage": { "title": "Simulate a USDA outage (diagnostic)", "enum": [ "none", "sda" ], "type": "string", "description": "Diagnostic only - leave as \"none\" for real screening. \"sda\" makes the actor treat USDA Soil Data Access as unreachable without contacting it, so you can prove for yourself that an outage produces a loud FAILED run with zero rows and zero billable events rather than a quiet page of 'no limitations found'. It never fabricates data.", "default": "none" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }