{"openapi":"3.1.0","info":{"title":"NOAA CO-OPS API (Bowmark)","version":"e833508f87ff","description":"NOAA's tide, water-level and current predictions, keyless and public.\n\nEvery function Bowmark has for NOAA CO-OPS (tidesandcurrents.noaa.gov) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/coops/listStations":{"post":{"operationId":"listStations","summary":"Find tide/current stations, optionally filtered by product type or state — the finder every id-taking function below needs.","description":"Find tide/current stations, optionally filtered by product type or state — the finder every id-taking function below needs.\n\nCalls `bowmark.providers.coops.listStations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsStation[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListStationsArgs","description":"TypeScript: `ListStationsArgs`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getStationMetadata":{"post":{"operationId":"getStationMetadata","summary":"Get a station's location, timezone and the product pages it publishes.","description":"Get a station's location, timezone and the product pages it publishes.\n\nCalls `bowmark.providers.coops.getStationMetadata`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsStationMetadata>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stationId":{"type":"string","description":"TypeScript: `string`"}},"required":["stationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getTidePredictions":{"post":{"operationId":"getTidePredictions","summary":"Get tide predictions for a station for specified dates.","description":"Get tide predictions for a station for specified dates.\n\nCalls `bowmark.providers.coops.getTidePredictions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsTidePredictions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetTidePredictionsArgs","description":"TypeScript: `GetTidePredictionsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getWaterLevel":{"post":{"operationId":"getWaterLevel","summary":"Get water level observations for a station for specified dates.","description":"Get water level observations for a station for specified dates.\n\nCalls `bowmark.providers.coops.getWaterLevel`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsWaterLevel>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetWaterLevelArgs","description":"TypeScript: `GetWaterLevelArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getHighLowTides":{"post":{"operationId":"getHighLowTides","summary":"Get high/low tide extremes for a station and date range.","description":"Get high/low tide extremes for a station and date range.\n\nCalls `bowmark.providers.coops.getHighLowTides`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsHighLowTides>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetHighLowTidesArgs","description":"TypeScript: `GetHighLowTidesArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getCurrents":{"post":{"operationId":"getCurrents","summary":"Get current speed/direction observations for a current station.","description":"Get current speed/direction observations for a current station.\n\nCalls `bowmark.providers.coops.getCurrents`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsCurrents>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetCurrentsArgs","description":"TypeScript: `GetCurrentsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getCurrentPredictions":{"post":{"operationId":"getCurrentPredictions","summary":"Get current velocity predictions for a current station.","description":"Get current velocity predictions for a current station.\n\nCalls `bowmark.providers.coops.getCurrentPredictions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsCurrentPredictions>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetCurrentPredictionsArgs","description":"TypeScript: `GetCurrentPredictionsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getStationDatums":{"post":{"operationId":"getStationDatums","summary":"Get a station's tidal datums (MHHW, MLLW, etc) and the epoch they're referenced to.","description":"Get a station's tidal datums (MHHW, MLLW, etc) and the epoch they're referenced to.\n\nCalls `bowmark.providers.coops.getStationDatums`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsStationDatums>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stationId":{"type":"string","description":"TypeScript: `string`"}},"required":["stationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getStationHarmonicConstituents":{"post":{"operationId":"getStationHarmonicConstituents","summary":"Get a station's harmonic constituents used to derive its tide predictions.","description":"Get a station's harmonic constituents used to derive its tide predictions.\n\nCalls `bowmark.providers.coops.getStationHarmonicConstituents`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsStationHarmonicConstituents>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stationId":{"type":"string","description":"TypeScript: `string`"}},"required":["stationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getMeteorologicalObservations":{"post":{"operationId":"getMeteorologicalObservations","summary":"Get a station's weather sensor readings (wind, air temperature, air pressure, water temperature, humidity).","description":"Get a station's weather sensor readings (wind, air temperature, air pressure, water temperature, humidity).\n\nCalls `bowmark.providers.coops.getMeteorologicalObservations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsMeteorologicalObservations>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetMeteorologicalObservationsArgs","description":"TypeScript: `GetMeteorologicalObservationsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getSeaLevelTrend":{"post":{"operationId":"getSeaLevelTrend","summary":"Get a station's long-term sea-level trend.","description":"Get a station's long-term sea-level trend.\n\nCalls `bowmark.providers.coops.getSeaLevelTrend`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsSeaLevelTrend>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stationId":{"type":"string","description":"TypeScript: `string`"}},"required":["stationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getHighTideFloodingHistory":{"post":{"operationId":"getHighTideFloodingHistory","summary":"Get a station's annual high-tide flood day counts (major/moderate/minor).","description":"Get a station's annual high-tide flood day counts (major/moderate/minor).\n\nCalls `bowmark.providers.coops.getHighTideFloodingHistory`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsHighTideFloodingHistory>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stationId":{"type":"string","description":"TypeScript: `string`"}},"required":["stationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/coops/getMonthlyMeanWaterLevel":{"post":{"operationId":"getMonthlyMeanWaterLevel","summary":"Get a station's monthly mean water levels across every tidal datum.","description":"Get a station's monthly mean water levels across every tidal datum.\n\nCalls `bowmark.providers.coops.getMonthlyMeanWaterLevel`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CoopsMonthlyMeanWaterLevel>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetMonthlyMeanWaterLevelArgs","description":"TypeScript: `GetMonthlyMeanWaterLevelArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"CoopsMetProduct":{"anyOf":[{"const":"wind"},{"const":"air_temperature"},{"const":"air_pressure"},{"const":"water_temperature"},{"const":"humidity"}]},"CoopsStationProductType":{"anyOf":[{"const":"waterlevels"},{"const":"airgap"},{"const":"wind"},{"const":"airtemperature"},{"const":"watertemperature"},{"const":"airpressure"},{"const":"humidity"},{"const":"currents"},{"const":"currentpredictions"},{"const":"tidepredictions"},{"const":"datums"},{"const":"harmonicconstituents"}]},"CoopsTideDatum":{"anyOf":[{"const":"MLLW"},{"const":"MLW"},{"const":"MSL"},{"const":"MTL"},{"const":"MHW"},{"const":"MHHW"},{"const":"NAVD"},{"const":"STND"}]},"GetCurrentPredictionsArgs":{"type":"object","properties":{"stationId":{"type":"string"},"beginDate":{"type":"string"},"endDate":{"type":"string"},"interval":{"const":"MAX_SLACK"},"units":{"anyOf":[{"const":"english"},{"const":"metric"}]},"bin":{"type":"string"}},"required":["stationId"],"additionalProperties":true},"GetCurrentsArgs":{"type":"object","properties":{"stationId":{"type":"string"},"beginDate":{"type":"string"},"endDate":{"type":"string"},"units":{"anyOf":[{"const":"english"},{"const":"metric"}]},"bin":{"type":"string"}},"required":["stationId"],"additionalProperties":true},"GetHighLowTidesArgs":{"type":"object","properties":{"stationId":{"type":"string"},"beginDate":{"type":"string"},"endDate":{"type":"string"},"datum":{"$ref":"#/components/schemas/CoopsTideDatum"},"units":{"anyOf":[{"const":"english"},{"const":"metric"}]}},"required":["stationId","beginDate"],"additionalProperties":true},"GetMeteorologicalObservationsArgs":{"type":"object","properties":{"stationId":{"type":"string"},"product":{"$ref":"#/components/schemas/CoopsMetProduct"},"beginDate":{"type":"string"},"endDate":{"type":"string"},"units":{"anyOf":[{"const":"english"},{"const":"metric"}]}},"required":["stationId","product"],"additionalProperties":true},"GetMonthlyMeanWaterLevelArgs":{"type":"object","properties":{"stationId":{"type":"string"},"beginDate":{"type":"string"},"endDate":{"type":"string"},"units":{"anyOf":[{"const":"english"},{"const":"metric"}]}},"required":["stationId","beginDate"],"additionalProperties":true},"GetTidePredictionsArgs":{"type":"object","properties":{"stationId":{"type":"string"},"beginDate":{"type":"string"},"endDate":{"type":"string"},"datum":{"$ref":"#/components/schemas/CoopsTideDatum"},"interval":{"anyOf":[{"const":"6"},{"const":"h"},{"const":"hilo"}]},"units":{"anyOf":[{"const":"english"},{"const":"metric"}]}},"required":["stationId"],"additionalProperties":true},"GetWaterLevelArgs":{"type":"object","properties":{"stationId":{"type":"string"},"beginDate":{"type":"string"},"endDate":{"type":"string"},"datum":{"$ref":"#/components/schemas/CoopsTideDatum"},"units":{"anyOf":[{"const":"english"},{"const":"metric"}]}},"required":["stationId"],"additionalProperties":true},"ListStationsArgs":{"type":"object","properties":{"productType":{"$ref":"#/components/schemas/CoopsStationProductType"},"state":{"type":"string"}},"additionalProperties":true}}}}