{ "openapi": "3.0.1", "info": { "title": "Usgs Water Scraper", "version": "1.0", "x-build-id": "8QFRLqcNuNPBTZcWt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fortuitous_pirate~usgs-water-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fortuitous_pirate-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/fortuitous_pirate~usgs-water-scraper/runs": { "post": { "operationId": "runs-sync-fortuitous_pirate-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/fortuitous_pirate~usgs-water-scraper/run-sync": { "post": { "operationId": "run-sync-fortuitous_pirate-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": { "dataType": { "title": "Data Type", "enum": [ "iv", "dv", "site" ], "type": "string", "description": "Type of water data to retrieve. Real-time (iv) returns the last few hours of instantaneous measurements. Daily values (dv) returns historical daily statistics. Site info returns station metadata only.", "default": "iv" }, "siteNumbers": { "title": "Site Number(s)", "type": "string", "description": "USGS site number(s), comma-separated. Example: '01646500' for Potomac River at Little Falls. Find site numbers at https://waterdata.usgs.gov/nwis", "default": "08158000" }, "stateCd": { "title": "State Code", "type": "string", "description": "Two-letter US state code to get all sites in a state (e.g., 'CA', 'TX'). Warning: state-wide queries can return very large datasets." }, "parameter": { "title": "Parameter", "enum": [ "streamflow", "gage_height", "water_temp", "precipitation", "groundwater" ], "type": "string", "description": "Type of water measurement to retrieve.", "default": "streamflow" }, "customParameterCd": { "title": "Custom Parameter Code", "type": "string", "description": "Custom USGS parameter code (overrides the Parameter select above). See https://help.waterdata.usgs.gov/parameter_cd for full list." }, "siteType": { "title": "Site Type", "enum": [ "", "ST", "GW", "LK", "SP" ], "type": "string", "description": "Filter by type of monitoring station.", "default": "" }, "startDate": { "title": "Start Date", "type": "string", "description": "Start date in YYYY-MM-DD format. For real-time (iv), defaults to most recent data. For daily values (dv), required for historical queries." }, "endDate": { "title": "End Date", "type": "string", "description": "End date in YYYY-MM-DD format." }, "period": { "title": "Period (ISO 8601)", "type": "string", "description": "ISO 8601 duration as an alternative to start/end dates. Examples: 'P7D' (7 days), 'P1M' (1 month), 'P1Y' (1 year). Overrides start/end dates if provided." }, "boundingBox": { "title": "Bounding Box", "type": "string", "description": "Geographic bounding box as west,south,east,north (longitude,latitude). Example: '-90.5,38.5,-89.5,39.5' for a region around St. Louis." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of data records to return. Each time-step measurement counts as one item.", "default": 10 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy configuration. Not typically needed since the USGS API is public." } } }, "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 } } } } } } } } } }