{ "openapi": "3.0.1", "info": { "title": "USGS Water & Streamflow Scraper — Discharge & Gage Height", "description": "Pull US stream-gauge data from USGS monitoring sites: streamflow (discharge), gage height, water temperature and more, as daily or instantaneous values. Query by site, state or bounding box and export as JSON, CSV or Excel for water management, research and alerts.", "version": "1.0", "x-build-id": "kn7kavWnvmpniZkJH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hipersoft~usgs-water-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hipersoft-usgs-water-scraper", "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/hipersoft~usgs-water-scraper/runs": { "post": { "operationId": "runs-sync-hipersoft-usgs-water-scraper", "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/hipersoft~usgs-water-scraper/run-sync": { "post": { "operationId": "run-sync-hipersoft-usgs-water-scraper", "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", "properties": { "sites": { "title": "Site numbers", "type": "array", "description": "USGS site numbers to fetch, one per line (e.g. 01646500 for the Potomac near Washington, DC). Provide this OR a State / Bounding box below.", "items": { "type": "string" } }, "stateCd": { "title": "State code", "type": "string", "description": "Two-letter US state code to fetch all matching sites (e.g. md, ca, tx). Used only when no site numbers are given.", "default": "" }, "bBox": { "title": "Bounding box", "type": "string", "description": "Bounding box as west,south,east,north decimal degrees (e.g. -83.0,36.5,-81.0,38.5). Used only when no site numbers or state are given. Keep it small — the source limits very large boxes.", "default": "" }, "parameterCd": { "title": "Parameter codes", "type": "string", "description": "USGS parameter codes, comma-separated. Common: 00060 = discharge (streamflow, ft³/s), 00065 = gage height (ft), 00010 = water temperature (°C), 00300 = dissolved oxygen, 00095 = specific conductance.", "default": "00060,00065" }, "service": { "title": "Data service", "enum": [ "dv", "iv" ], "type": "string", "description": "Daily values (one value per day) or Instantaneous values (sub-hourly readings, recent period only).", "default": "dv" }, "startDate": { "title": "Start date (optional)", "type": "string", "description": "First day, as YYYY-MM-DD. Set together with End date for an explicit range; otherwise the Period below is used.", "default": "" }, "endDate": { "title": "End date (optional)", "type": "string", "description": "Last day, as YYYY-MM-DD.", "default": "" }, "period": { "title": "Period", "type": "string", "description": "Relative period ending now when no date range is set, ISO-8601 duration (e.g. P7D = last 7 days, P1M = last month, P1D = last day).", "default": "P7D" }, "maxItems": { "title": "Max observations", "minimum": 0, "type": "integer", "description": "Maximum observation rows to collect (0 = no limit).", "default": 0 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }